+ All Categories
Home > Documents > Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... ·...

Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... ·...

Date post: 04-Jul-2020
Category:
Upload: others
View: 1 times
Download: 0 times
Share this document with a friend
794
Salesforce Health Cloud Developer Guide Salesforce, Summer 20 @salesforcedocs Last updated: June 10, 2020
Transcript
Page 1: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Salesforce Health CloudDeveloper Guide

Salesforce, Summer ’20

@salesforcedocsLast updated: June 10, 2020

Page 2: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

© Copyright 2000–2020 salesforce.com, inc. All rights reserved. Salesforce is a registered trademark of salesforce.com, inc.,as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.

Page 3: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CONTENTS

Health Cloud Developer Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Health Cloud Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Health Cloud Associated Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616Health Cloud Custom Fields on Standard Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640Patient Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671Working With Electronic Health Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682Health Cloud Business APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696Health Cloud Metadata APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757Health Cloud Custom Metadata Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763Health Cloud Empower Components for Communities . . . . . . . . . . . . . . . . . . . . . . . . . . . 783

Page 4: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to
Page 5: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HEALTH CLOUD DEVELOPER GUIDE

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

This guide provides information on the custom objects used by Health Cloud and their fields. Somefields may not be listed for some objects.

Health Cloud Objects

Salesforce Health Cloud provides a rich set of standard and custom objects to store and accessspecialized health information.

Health Cloud Custom Fields on Standard Objects

Health Cloud adds custom fields to some standard Salesforce objects to represent informationabout individuals.

Patient Creation

When patients are first imported into Health Cloud, the information required to identify and represent those patients is created.Historical medical information associated with patients is not imported into Health Cloud by default; however, you can choose tomap more historical information, as needed. You can implement a custom integration to import historical medical records from theEHR system and append it to the default patient creation job flow.

Working With Electronic Health Records

HL7 (Health Level Seven) is a standard for exchanging electronic health records (EHR). You can parse EHR data transmitted via HL7data messages and store it in the Salesforce Health Cloud data model. You can create parsers or use parsers supplied by HealthCloud.

Health Cloud Business APIs

Use the Health Cloud Business APIs for building integrations with Health Cloud or for creating custom UI components. The APIs wrapcomplex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to thehealthcare industry, such as enrolling patients into a care program or creating requests for prior authorizations. To use these APIs,you are not required to understand the underlying healthcare data model. Most of the APIs are RESTful APIs, but a few are alsoavailable through Apex classes and methods.

Health Cloud Custom Metadata Types

Custom metadata is customizable, deployable, packageable, and upgradeable application metadata.

Health Cloud Empower Components for Communities

Developers can use the Health Cloud Empower Components in other applications to create a patient or member community.

Health Cloud Objects

Salesforce Health Cloud provides a rich set of standard and custom objects to store and access specialized health information.

To verify the complete list of fields for an object, you can use a describe call from the API, or inspect with an appropriate tool, for example,inspecting the WSDL or using a schema viewer.

Note: The custom objects, components, classes, and triggers delivered in the Health Cloud managed package are one API versionbehind the core Salesforce API. Health Cloud standard objects have the same API version as core Salesforce. For example, if yourorg’s API version is 43, the custom objects in the Health Cloud managed package are API version 42, and the standard Health Cloudobjects are API version 43.

1

Page 6: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Management

Clinical data from electronic health records (EHR) or other clinical systems is critical to planning, executing, and managing coordinatedcare plans for patients. You can integrate clinical data with Salesforce using several standard APIs to map messages from EHR systemsinto Health Cloud objects and fields.

Life Sciences Program Management

Drive increased adherence and improve patient outcomes using the care program management data model. Now you can enrolland manage patients to achieve the maximum impact of your programs.

Claims

A claim is information submitted to an individual's health insurance company by an entity providing a service, medication or device.

Code Sets

The code sets data model represents industry-standard procedure and diagnosis codes available to use in prior-authorization requestand approval processes. You import these code sets using Data Loader.

Health Insurance

The health insurance data model provides objects for managing the ways care is paid for. It represents information about participantssuch as employment, insurance coverage, and dependents. You can manage details of the benefits provided by plans to membersand treatment preauthorization requests made by members or providers.

Intelligent Sales

Help you sales team plan and execute sales visits and manage field inventory with Intelligent Sales for Health Cloud.

Social Determinants

The social determinants data model represents the barriers, health determinants, and interventions for a patient or member. Availablein API version 45.0 and later.

Provider Relationship Management

Manage your network of provider partners and help your members or patients find care that fits their needs.

Utilization Management

Utilization Management (UM) is a health insurance plan's process of interfacing with plan members and contracted medical providersto interpret, administer, and explain the medical policies of the health plan. Health Cloud provides objects you can use to reviewand evaluate medical care services, communicate about clinical policies, and help health plan members ensure they receive theright care in the right setting at the right time.

Electronic Health Records

Salesforce Health Cloud provides custom objects to store the data contained in the standard electronic health record (EHR) fields.

SEE ALSO:

Salesforce Object Reference

Salesforce Developer Limits and Allocations Quick Reference

2

Health Cloud ObjectsHealth Cloud Developer Guide

Page 7: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Management

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

Clinical data from electronic health records (EHR) or other clinical systems is critical to planning,executing, and managing coordinated care plans for patients. You can integrate clinical data withSalesforce using several standard APIs to map messages from EHR systems into Health Cloud objectsand fields.

The Health Cloud clinical data model is similar to the FHIR® standard. This supports easier and morestraightforward clinical data integration from other source systems. When devising animplementation strategy, you or your integration partner map messages from the EHR system tothe correct Health Cloud object. Data is replicated into the clinical data model with read-only access.Data that originates in the EHR or other clinical systems is view-only, so the source system remainsthe system of record.

3

Care ManagementHealth Cloud Developer Guide

Page 8: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

4

Care ManagementHealth Cloud Developer Guide

Page 9: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CarePlanTemplate__cRepresents the template used to create a care plan including the problems, goals, and tasks that care coordinators use to manage andmitigate a medical condition.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create Filter, Group, Sort, Update

DescriptionIndicates whether the record is active or not.

Typepicklist

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe category of treatment a care plan template belongs to. Possible values:

• Disease Management

• Endocrinology and Metabolism

• Home Health

• Wellness

Typereference

ClonedFrom__c

PropertiesCreate, Filter, Nillable, Group, Sort, Update

DescriptionIndicates where this template was cloned or copied from.

Typetextarea

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

5

Care ManagementHealth Cloud Developer Guide

Page 10: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA description of the template.

UsageUse this object to manage patient care templates.

CarePlanTemplateGoal__cRepresents a goal included in the care plan template.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create Filter, Group, Sort, Update

DescriptionIndicates whether the record is active or not.

Typereference

CarePlanTemplate__c

PropertiesCreate, Filter,Group, Nillable, Sort, Update

DescriptionThe care plan template that the goal is related to.

Typereference

CarePlanTemplateProblem___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care plan template problem that the goal is related to.

Typepicklist

Category__c

6

Care ManagementHealth Cloud Developer Guide

Page 11: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe category of wellness targets a care plan template goal belongs to. Possible values:

• Cognition Improvement

• Muscle Strength Improvement

• Weight Management

Typetextarea

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the goal associated with the problem.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the care plan goal. Limit: 255 characters.

Typereference

OwnerId

PropertiesDefaulted on create, Filter, Group, Sort, Update

DescriptionID of the owner of the goal.

Typepicklist

Priority___c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe priority of the care plan goal such as low, normal, or high.

Typepicklistdouble

SortOrder___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

7

Care ManagementHealth Cloud Developer Guide

Page 12: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates the sort order of goals in the list.

UsageUse this object to query and manage goals that are related to problems within a care plan template.

CarePlanTemplateProblem__cRepresents a problem included in the care plan template.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create Filter, Group, Sort, Update

DescriptionIndicates whether the record is active or not.

Typereference

CarePlanTemplate__c

PropertiesCreate, Filter,Group, Nillable, Sort, Update

DescriptionThe care plan template that the problem is related to.

Typepicklist

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe category of ailments a care plan template problem belongs to. Possible values:

• Cognition

• Pain Monitoring or Management

8

Care ManagementHealth Cloud Developer Guide

Page 13: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Respiratory Impairment

Typetextarea

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the problem associated with the template.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the care plan problem. Limit: 255 characters.

Typereference

OwnerId

PropertiesDefaulted on create, Filter, Group, Sort, Update

DescriptionID of the owner of the problem.

Typepicklist

Priority___c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe priority of the care plan problem such as low, normal, or high.

Typedouble

SortOrder___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates the sort order of problems in the list.

UsageUse this object to query and manage problems associated with a care plan template.

9

Care ManagementHealth Cloud Developer Guide

Page 14: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CarePlanTemplateTask__cRepresents a task that’s included in the care plan template.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), undelete(),update(), upsert()

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create Filter, Group, Sort, Update

DescriptionIndicates whether the record is active or not.

Typepicklist

AssignedTo__c

PropertiesCreate, Filter, Group, Nillable,Restricted picklist, Sort, Update

DescriptionName of the person who’s assigned to the task.

Typereference

CarePlanTemplate__c

PropertiesCreate, Filter,Group, Nillable, Sort, Update

DescriptionThe care plan template that the task is related to.

Typereference

CarePlanTemplateGoal__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care plan template goal that the task is related to.

Typereference

CarePlanTemplateProblem___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

10

Care ManagementHealth Cloud Developer Guide

Page 15: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe care plan template problem that the task is related to.

Typetextarea

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the task.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the care plan problem. Limit: 255 characters.

Typedouble

Offset___c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAdds an offsetDate to the date selected for a task in the care plan. Tasks that have an offsetdate add the assigned offset to the task start date. For example, if the care plan start date isDecember 9 and a task offset is +7 days, the task’s due date is December 16.

Typepicklist

Priority___c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe priority of the care plan task such as low, normal, or high.

Typedouble

SortOrder___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates the sort order of tasks in the list.

Typepicklist

Status___c

11

Care ManagementHealth Cloud Developer Guide

Page 16: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe status of the care plan task such as in progress, complete, or new.

Typestring

Subject___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe subject or name of the task.

Typepicklist

Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of task.

UsageUse this object to query and manage tasks associated with a care plan template.

AccountAccountRelation__cRepresents a one-to-one relationship between two accounts, each with a distinct role in relation to the other.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount that RelatedAccount__c is related from.

12

Care ManagementHealth Cloud Developer Guide

Page 17: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the relationship between accounts is active (true) or not (false). Thedefault checkbox value is selected.

Typedate

EndDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe last date when the two accounts are related.

Typestring

ExternalId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external ID that inhibits any duplicate definitions from FromAccount- Role -ToAccount.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the relationship between the accounts. Limit: 255 characters.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the user who created the relationship record.

Typereference

RelatedAccount__c

PropertiesFilter, Group, Nillable, Sort

13

Care ManagementHealth Cloud Developer Guide

Page 18: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionAccount that Account__c is related to.

Typereference

Role__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe role of the relationship.

Typedate

StartDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first date when the relationship between accounts is valid (not when the object iscreated).

UsageThis resource tracks each account’s relationship to the other.

CandidatePatient__cRepresents the demographics and other administrative information about a patient who’s receiving health-related services.

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

Fields

DetailsField

Typestring

Address1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

14

Care ManagementHealth Cloud Developer Guide

Page 19: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

15

Care ManagementHealth Cloud Developer Guide

Page 20: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address1Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient. Use is optional based on source data.

Typestring

Address1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

16

Care ManagementHealth Cloud Developer Guide

Page 21: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address2Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient. Use is optional based on source data.

17

Care ManagementHealth Cloud Developer Guide

Page 22: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

18

Care ManagementHealth Cloud Developer Guide

Page 23: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address3Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient. Use is optional based on source data.

Typestring

Address3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

19

Care ManagementHealth Cloud Developer Guide

Page 24: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid

20

Care ManagementHealth Cloud Developer Guide

Page 25: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address4Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient. Use is optional based on source data.

Typestring

Address4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

21

Care ManagementHealth Cloud Developer Guide

Page 26: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address5Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient. Use is optional based on source data.

22

Care ManagementHealth Cloud Developer Guide

Page 27: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

TypedateTime

BirthDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe patient’s birth date.

Typestring

Communication1Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication1Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication2Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

23

Care ManagementHealth Cloud Developer Guide

Page 28: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication2Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication3Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication3Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

24

Care ManagementHealth Cloud Developer Guide

Page 29: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication4Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication4Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication5Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication5Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

25

Care ManagementHealth Cloud Developer Guide

Page 30: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typeboolean

Deceased__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.

Typestring

FamilyName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).

Typestring

FamilyName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).

26

Care ManagementHealth Cloud Developer Guide

Page 31: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

GenderCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.

Typestring

GivenName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c

27

Care ManagementHealth Cloud Developer Guide

Page 32: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

28

Care ManagementHealth Cloud Developer Guide

Page 33: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

MaritalStatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the patient’s most recent civil marital status.

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typeboolean

MultipleBirth__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.

Typestring

Name

29

Care ManagementHealth Cloud Developer Guide

Page 34: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR ADT patient ID. Limit: 255 characters.

Typetextarea

Name__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of a name associated with the patient.

Typestring

Organization255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization on behalf of which a patient contact is acting, for which the patient contactis working, or that’s acting as the custodian of the patient record. Limit: 255 characters.

Typetextarea

Organization__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization on behalf of which a patient contact is acting,for which the patient contact is working, or that’s acting as the custodian of the patientrecord.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the record owner.

Typetextarea

PhotoUrl__c

PropertiesCreate, Nillable, Update

DescriptionThe URL for a photograph of the patient.

30

Care ManagementHealth Cloud Developer Guide

Page 35: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

PrefixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first prefix in a patient’s name.

Typestring

PrefixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in a patient’s name.

Typestring

PrefixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in a patient’s name.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

31

Care ManagementHealth Cloud Developer Guide

Page 36: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SuffixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first suffix in a patient’s name.

Typestring

SuffixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in a patient’s name.

Typestring

SuffixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in a patient’s name.

TypedateTime

Telecom1PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom1PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

32

Care ManagementHealth Cloud Developer Guide

Page 37: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

Typestring

Telecom1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

Typestring

Telecom1Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom2PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom2PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

33

Care ManagementHealth Cloud Developer Guide

Page 38: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Telecom2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

Typestring

Telecom2Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom3PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom3PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

Typestring

Telecom3Use__c

34

Care ManagementHealth Cloud Developer Guide

Page 39: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

Typestring

Telecom3Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom4PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom4PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

Typestring

Telecom4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

35

Care ManagementHealth Cloud Developer Guide

Page 40: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

Typestring

Telecom4Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom5PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom5PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such asphone or fax.

Typestring

Telecom5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the patient.

36

Care ManagementHealth Cloud Developer Guide

Page 41: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Telecom5Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

CardViewDropdown__cDefines a tab navigation menu option on the patient card to open standard and custom pages or URLs as either primary or secondarytabs. Clicking an item in the menu opens a new tab or subtab for that patient.

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

Fields

DetailsField

Typestring

Category__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the parent category that contains child navigation items. The category name actsas a heading and isn’t a clickable navigation link.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionDescibes the menu navigation item.

Typestring

ParamString__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAdd any extra URL parameters to the existing Visualforce page or URL to open the new tab.

37

Care ManagementHealth Cloud Developer Guide

Page 42: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Rec_Open_Type__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionSpecifies the type of tab to use for this page: Primary or Subtab. A primary tab is the mainitem to work on. A subtab is related to an item on a primary tab.

Typestring

SubCategory__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the child category in the menu list. This text is the clickable link that opens the pageor tab.

Typestring

Type__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionContent type of the new page. Specify VFpage or URL.

Typestring

URL__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe URL to access the page.

CarePlanGoal__cRepresents the intended objectives of carrying out a care plan.

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

38

Care ManagementHealth Cloud Developer Guide

Page 43: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a time period.Can be limited to care for a specific condition or set of conditions.

Typereference

CarePlanProblem__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe health problem that this goal addresses.

Typetextarea

Description__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of the care plan.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

39

Care ManagementHealth Cloud Developer Guide

Page 44: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the care plan goal. Limit: 255 characters.

Typestring

PercentBar___c

PropertiesFilter, Nillable, Sort

DescriptionPercent completed.

Typepicklist

Priority___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe priority of the care plan goal. Picklist values: Low, Medium, and High.

Typepercent

Progress___c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionProgress toward achieving the care plan goal.

Typedouble

SortOrder___c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe order in which the goal appears among other goals associated with a problem.

40

Care ManagementHealth Cloud Developer Guide

Page 45: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe category of wellness targets a care plan goal belongs to. Possible values:

• Cognition Improvement

• Muscle Strength Improvement

• Weight Management

UsageDevelopers can use an integration to build CarePlanGoal__c from data in EhrCarePlanGoal__c. Not required.

SEE ALSO:

CarePlanProblem__c

CarePlanProblem__cRepresents the conditions, problems, concerns, diagnoses, and so on, that this plan manages and mitigates.

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

Fields

DetailsField

Typereference

CarePlanTemplate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care plan template associated with the problem.

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort

41

Care ManagementHealth Cloud Developer Guide

Page 46: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.

Typetextarea

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the care plan problem.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record

• Due date of the most recently closed task associated with the record

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the care plan problem. Limit: 255 characters.

42

Care ManagementHealth Cloud Developer Guide

Page 47: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Priority___c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe priority of the care plan problem. Picklist values: Low, Medium, and High.

Typedouble

SortOrder___c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe order in which the problem appears among other problems associated with the careplan.

Typepicklist

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Restricted picklist, Update

DescriptionThe category of ailments a care plan problem belongs to. Possible values:

• Cognition

• Pain Monitoring or Management

• Respiratory Impairment

UsageDevelopers can use an integration to build CarePlanProblem__c from data in EhrCarePlanConcern__c. Not required.

SEE ALSO:

CarePlanGoal__c

ConditionToHCCCodeMapping__cRepresents a mapping of patient conditions to Hierarchical Condition Category (HCC) codes.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search ( ),undelete(), update(), upsert()

43

Care ManagementHealth Cloud Developer Guide

Page 48: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this condition to HCC mapping is active and available for use.

Typestring

ConditionCode__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionA comma-separated list of conditions that apply to the patient.

Typestring

HCCCode__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionHCC codes that apply to the patient’s condition.

Typedouble

ValidFrom__c

PropertiesCreate, Filter, Sort, Update

DescriptionThe year in which the HCC codes become valid.

Typedouble

ValidThrough__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last year in which the HCC codes are valid.

Typestring

YearConditionCodeHCCCode__c

PropertiesCreate, Filter, Group, idLookup, Sort, Unique, Update

44

Care ManagementHealth Cloud Developer Guide

Page 49: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionUnique key for the record.

UsageUse this object to map the EHR condition (diagnosis) codes to the HCC codes.

ContactContactRelation__cRepresents a relationship between two contacts, each with a distinct role in relation to the other.

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

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the relationship is active (true) or not (false). The default checkboxvalue is selected.

Typereference

Contact__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionContact that RelatedContact__c is related from.

Typedate

EndDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe last date when the relationship between contacts is valid.

45

Care ManagementHealth Cloud Developer Guide

Page 50: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ExternalId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external ID that inhibits any duplicate definitions from FromContact - Role -ToContact.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the relationship between the contacts. Limit: 255 characters.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

RelatedContact__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionContact that RelatedContact__c is related to.

Typereference

Role__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionRole that describes how RelatedContact__c is related to Contact__c

Typedate

StartDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

46

Care ManagementHealth Cloud Developer Guide

Page 51: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe first date when the relationship between the contacts is valid (not when the object wascreated).

UsageThis resource tracks each contact’s relation to the other.

CrossObjectRelationship__cRepresents a relationship between two objects (for example, patient Account and EhrPatient__c) used in patient list view pages.

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

Fields

DetailsField

Typestring

FromObject__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe related from object.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

47

Care ManagementHealth Cloud Developer Guide

Page 52: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the relationship between the objects. Limit: 255 characters.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe owner of the record.

Typestring

Relationship__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe relationship between the objects.

Typestring

ReverseRelationship__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe reverse relationship between the objects.

Typestring

ToObject__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe related to object.

CustomFieldSets__cRepresents a custom grouping of fields.

48

Care ManagementHealth Cloud Developer Guide

Page 53: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

Fields

DetailsField

Typetextarea

ExcludedFields__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFields that aren’t included in the field set.

Typestring

FieldSetLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLabel for the field set.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the custom field set. Limit: 255 characters.

Typestring

SObjectName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the sObject. Limit: 255 characters.

Typeboolean

TwoColumnLayout

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the layout is two-column (true) or not (false).

49

Care ManagementHealth Cloud Developer Guide

Page 54: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CustomLabelConfig__cRepresents a custom label in Health Cloud.

Supported Callscreate(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

Fields

DetailsField

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the custom label configuration. Limit: 255 characters.

Typestring

NewLabel__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the new label.

Typestring

ObjectFieldName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the object field.

Typestring

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the object.

Typestring

ObjectRecordType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

50

Care ManagementHealth Cloud Developer Guide

Page 55: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe object record type.

Typestring

RelationshipName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the relationship.

Typestring

ViewName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the view.

FilterColumn__cRepresents the column used by filter criteria for the patient segmentation functionality.

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

Fields

DetailsField

Typestring

FieldApi__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe selected field.

Typestring

FieldLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

51

Care ManagementHealth Cloud Developer Guide

Page 56: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionLabel of the selected field.

Typereference

FilterCriterion__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe field criterion.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe filter column name. Limit: 255 characters.

Typetextarea

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionA long text description of the name of the object.

Typedouble

Order__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionOrder in which the field appears.

FilterCondition__cRepresents the condition used by filter criteria for the patient segmentation functionality.

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

52

Care ManagementHealth Cloud Developer Guide

Page 57: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typestring

FieldName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the field.

Typereference

FieldCriterion__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe field criterion.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the filter condition. Limit: 255 characters.

Typetextarea

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the object.

Typestring

Operator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe filter criteria operator.

Typedouble

RowNumber__c

PropertiesCreate, Filter, Nillable, Sort, Update

53

Care ManagementHealth Cloud Developer Guide

Page 58: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionNumber of rows.

Typestring

SRowNumber__c

PropertiesFilter, Nillable, Sort

DescriptionThe number of rows to display.

Typestring

Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of filter condition.

Typestring

Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA value entered in the filter condition.

FilterCriterion__cRepresents the filter criteria for the patient segmentation functionality. Consists of a list of filter conditions and a list of columns thatdisplay as part of the filter view on the patient list view page.

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

Fields

DetailsField

Typetextarea

Grouping__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

54

Care ManagementHealth Cloud Developer Guide

Page 59: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionGrouping of the filter items.

Typeboolean

IsWaveList__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIndicates whether a patient list originated from the Wave for Health Cloud app.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the filter criterion. Limit: 255 characters.

Typetextarea

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the object.

Typereference

OwnerId

55

Care ManagementHealth Cloud Developer Guide

Page 60: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the record’s owner.

PatientCardViewConfiguration__cRepresents configuration options for the patient card.

Supported Callscreate(), delete(), query(), retrieve(), search(), undelete(), update()

Fields

DetailsField

Typestring

FieldName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the field that contains the information to display on the patient card.

Typestring

FriendlyName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName that appears as a title on the patient card.

Typeboolean

IsActive__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIndicates whether this field is appears on the patient card.

Typeboolean

IsAscending__c

PropertiesCreate, Filter, Group, Sort, Update

56

Care ManagementHealth Cloud Developer Guide

Page 61: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether results appear in ascending order.

Typestring

LanguageCode__c

PropertiesFilter, Nillable, Sort

DescriptionCode for the language of the item on the patient card.

Typepicklist

Language__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist Sort, Update

DescriptionLanguage used for the item on the patient card.

Typedouble

Limit__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionIndicates the maximum number of results to display in the field.

Typestring

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the object that contains the field to show on the patient card. Use the exact spellingof the object name to ensure correct results.

Typestring

OverrideFilterField__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the custom filter field to replace the delivered one.

Typestring

PatientAccountLookup__c

57

Care ManagementHealth Cloud Developer Guide

Page 62: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the lookup to display on the patient card when multiple lookups to Account exist.The default for this field is Account__c.

Note: To use delivered Account lookups for standard objects like Contact or Task, youmust append Id to the lookup field name. For example, to configure a lookup fromContact to Account, use AccountId in this field. Similarly, for a lookup from Task toWhat, use WhatId.

Typestring

SortBy__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the field used to define the order in which the results appear.

Typedouble

SortOrder__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIndicates the vertical order in which this field appears on the patient card.

UsageThis resource lets you customize the patient card and add the fields of your choice.

ReciprocalRole__cRepresents an inverse role. For example, if one role is parent, the reciprocal role is child.

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

Fields

DetailsField

Typeboolean

CreateInverseRole__c

58

Care ManagementHealth Cloud Developer Guide

Page 63: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the corresponding reciprocal role record is created automatically for theinverse role (true) or not (false).

Typereference

InverseRelationship__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUniquely identifies the relationship between Role and InverseRole__c so that itcan be referenced by a trigger that creates the inverse relationship record.

Typestring

InverseRole__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe other role that is related.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the role. Limit: 255 characters.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the record owner.

Typepicklist

RelationshipType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPicklist values: Account Account Relation, All, and Contact Contact Relation.

59

Care ManagementHealth Cloud Developer Guide

Page 64: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Role

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe role that an entity occupies in the relationship, such as a grandchild or a businessproprietor.

ProgramPatientAffiliation__cRepresents the program that the patient is affiliated with.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the Account object.

Typedate

EndDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the patient’s enrollment in the program ends.

Typeboolean

IsActive__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the enrollment of the person in the associated program is active.

60

Care ManagementHealth Cloud Developer Guide

Page 65: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

Program__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe program in which the patient is enrolled.

Typeboolean

Recalculate__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether new and relevant information about the patient has been received thattriggers a recalculation of the appropriate program metrics.

Typereference

Provider

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the physician or other healthcare provider.

Typedate

StartDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the patient’s enrollment in the program ends.

Typepicklist

Status__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the patient’s Medicare Chronic Care Management (CCM) program. Picklistvalues: Declined, In Progress, In Program, and Potential. The default is In Progress.

UsageUse this object to manage a patient’s enrollment information for a particular program.

61

Care ManagementHealth Cloud Developer Guide

Page 66: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

ProgramPatientSummary__cRepresents a record that contains calculated values for the relevant program that the patient is enrolled in.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

Typedouble

Age__c

PropertiesCreate, Filter, Sort, Update

DescriptionThe patient’s age in years as of December 31 for the year being calculated.

Typestring

AgeBand__c

PropertiesFilter, Nillable, Sort

DescriptionThe age group in which the patient belongs. For example, 35–44, 55–59, and so on.

Typetextarea

Conditions__c

PropertiesCreate, Nillable, Update

DescriptionA list of Hierarchical Condition Category (HCC) codes associated with the patient.

Typeboolean

DisabilityStatus__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

62

Care ManagementHealth Cloud Developer Guide

Page 67: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether the patient is considered disabled according to the Centers for Medicareand Medicaid Services (CMS) guidelines.

Typedate

EffectiveDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the risk score was calculated.

Typepicklist

EnrollmentType__c

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionIndicates the Medicare enrollment type for the patient.

Typepicklist

Gender__c

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.

Typestring

HCCCodes__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHCC codes that apply to the patient for the year.

Typeboolean

Institution__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the patient is in an institution.

Typeboolean

LowIncome__c

63

Care ManagementHealth Cloud Developer Guide

Page 68: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the patient falls within low-income guidelines.

Typestring

Month__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe month that the time spent applies.

Typeboolean

MostRecent__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this record contains the most recent calculation for the measurementperiod.

Typeboolean

NewPatient__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the person is a new Medicare patient or a continued enrollee.

Typestring

NumberOfConditions__c

PropertiesCreate, Filter, Group, NillableSort, Update

DescriptionThe number of HCC codes associated with the patient.

Typereference

ProgramPatientAffiliation__c

PropertiesCreate, Filter, Group, NillableSort, Update

DescriptionLookup to the ProgramPatientAffiliation object.

64

Care ManagementHealth Cloud Developer Guide

Page 69: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedouble

RiskScore__c

PropertiesCreate, Filter, NillableSort, Update

DescriptionThe patient’s calculated HCC risk score.

Typepicklist

Stage__c

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

The stage of the Medicare Chronic Care Management (CCM) program that the patient is in.Picklist values: Declined, In Process, In Program, and Potential.

Typedouble

TimeSpent__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe total time spent with the patient on qualifying activities during the measurement period.

Typestring

Unique__c

PropertiesFilter, Nillable, Sort

DescriptionA key used for time calculations.

Typestring

Year__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe year that the risk score applies to.

UsageUse this object to store calculated information for a patient’s program.

65

Care ManagementHealth Cloud Developer Guide

Page 70: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Provider__cRepresents a person providing healthcare.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this provider is actively practicing.

Typereference

EHRPractitioner__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the EhrPractictioner object.

Typereference

RelatedContact__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the Contact object if the record originates from a contact relationship.

Typereference

RelatedUser__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the User object if the record originates from a user.

TimelineViewConfiguration__cRepresents an event type on the timeline view in the patient care console.

66

Care ManagementHealth Cloud Developer Guide

Page 71: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typeboolean

Active__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIndicates whether this field appears on the timeline.

Typemultipicklist

Configuration_Target__c

PropertiesCreate, Filter, Nillable, Restricted Picklist, Sort, Update

DescriptionPicklist used to select which timelines the record targets. You can create one configurationrecord for patient communities and one for the Health Cloud console. To show the samefields in both the Health Cloud console and the community, select both options.

Typestring

DetailField__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionInformation from this field appears in the hover view on the timeline.

Typereference

FilterCriterion__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the collection of filters that apply to this configuration.

Typestring

FriendlyName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe human-readable name of the timeline view configuration.

67

Care ManagementHealth Cloud Developer Guide

Page 72: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

GraphicalIcon__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe icon used to depict the event on the timeline.

Typestring

HoverFieldName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEnter up to seven comma-separated field names from the object you want to display. Thevalues from this field appear as hover Hover Field Name text for an event on the timeline.For example, you can display fields like the due date, performer name, status, and the relatedproblem for tasks. Make sure to use the API field name and not the field label. Valid fieldtypes are Date, Combobox, Number, Picklist, and Text.

TypedateTime

LastReferencedDate__c

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

Typestring

LanguageCode__c

PropertiesFilter, Nillable, Sort

DescriptionCode for the language of the item on the timeline.

Typepicklist

Language__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist Sort, Update

DescriptionLanguage used for the item on the timeline.

TypedateTime

LastViewedDate

68

Care ManagementHealth Cloud Developer Guide

Page 73: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe name of the timeline view configuration. Limit: 255 characters.

Typestring

ObjectCategory__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the category of objects that this event is related to. By default, all pre-configuredobjects are either Engagement Data or Medical Record Data.

Typestring

ObjectName__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the object.

Typestring

PatientAccountLookup__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe API name of the field that looks up to Account (Patient). The default for this field isAccount__c.

Note: To use delivered Account lookups for standard objects like Contact or Task, youmust append Id to the lookup field name. For example, to configure a lookup fromContact to Account, use AccountId in this field. Similarly, for a lookup from Task toWhat, use WhatId.

Typestring

PositionField__c

69

Care ManagementHealth Cloud Developer Guide

Page 74: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe date or datetime field that the system uses to position the event horizontally on thecorrect date on the timeline.

Typeboolean

ShowOnLoad__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionControls the option to only show a subset of events when the timeline first appears in theconsole.

Typedouble

SortOrder__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionIndicates the vertical order that the events appear when there are other events with thesame date on the timeline.

Life Sciences Program Management

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

Drive increased adherence and improve patient outcomes using the care program managementdata model. Now you can enroll and manage patients to achieve the maximum impact of yourprograms.

The program management data model represents the entire picture of a program—from productsand providers to enrollment eligibility of the enrollee. The life sciences program managementstandard objects are visible to users with the Health Cloud and the Health Cloud Platform permissionset licenses and the Health Cloud Permission Set License permission set. You must have the HealthCloud managed package installed in your org to access the program management data model.Available in API version 46.0 and later.

70

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 75: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareMetricTarget

Represents the expected care metrics at org level and patient level.. This object is available in API version 49.0 and later.

CareObservation

Represents the observed values for care metrics originating from external systems that contain biometric data. This object is availablein API version 49.0 and later.

CarePgmProvHealthcareProvider

Represents a junction object identifying the primary healthcare professional associated with a care program provider and to lookup all healthcare professionals for care program providers. This object is available in API version 49.0 and later.

CareProgram

Represents a set of activities, such as a patient therapy, financial assistance, education, wellness, or fitness plan, offered to participantsby an employer or insurer.

CareProgramCampaign

Represents a relationship between the Care Program object and the Campaign object. This junction object enables admins toassociate one or more campaigns to a program.

CareProgramEligibilityRule

Represents a rule defining the criteria for patient care program enrollment eligibility. This entity creates an association between CareProgram and an Enrollment Eligibility Criteria.

CareProgramEnrollee

Represents a participant enrolled in a care program.

71

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 76: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareProgramEnrolleeProduct

Represents the affiliation between a care program enrollee and a care program product, a care program provider, or both.

CareProgramEnrollmentCard

Represents a care program membership card that includes a membership number or enrollment code.

CareProgramGoal

Represents a business or clinical goal related to a care program.

CareProgramProduct

Represents the affiliation between a care program and a care program product, care program provider, or both.

CareProgramProvider

Represents a business account that is the service provider for a care program product.

CareProgramTeamMember

Represents a person who delivers services under a program, such as a program manager or care coordinator.

CareRegisteredDevice

Represents device registration information for a patient or a care program enrollee. This object is available in API version 49.0 andlater.

CareSystemFieldMapping

Represents a mapping from source system fields to Salesforce target entities and attributes.

EnrollmentEligibilityCriteria

Represents criteria that defines patient enrollment eligibility for one or more care programs.

UnitOfMeasure

Represents the unit of measures for care metrics and care observations. This object is available in API version 49.0 and later.

CareMetricTargetRepresents the expected care metrics at org level and patient level.. This object is available in API version 49.0 and later.

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

Fields

DetailsField

Typereference

CodeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe CodeSet ID related to the care metric target.

72

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 77: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

EndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the care metric target value ceases to take effect.

Typeboolean

IsOutcomePositive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates the expected boolean value. The default value is false.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typedouble

LowerLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe lower limit for the care metric target range. Used when Type is set to RANGE.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

73

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 78: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe name of this care metric target.

Typedouble

NumericValue

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe numeric value of the care metric target (6 decimal places). Used when Type is set toMIN, MAX, or EXACT.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PatientId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe account ID of the patient for whom the care metric target is applicable.

Typedate

StartDate

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe date when the care metric target value takes effect.

Typepicklist

Type

PropertiesCreate, Filter, Group, Restricted picklist, Sort, Update

DescriptionThe care metric value type.

Possible values are:

• BOOLEAN

• EXACT

74

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 79: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• MAX

• MIN

• RANGE

Typereference

UnitOfMeasureId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe ID of the unit of measure for the care metric target.

Typedouble

UpperLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe upper limit for the care metric target range. Used when Type is set to RANGE.

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

CareMetricTargetFeedFeed tracking is available for the object.

CareMetricTargetHistoryHistory is available for tracked fields of the object.

CareMetricTargetOwnerSharingRuleSharing rules are available for the object.

CareMetricTargetShareSharing is available for the object.

CareObservationRepresents the observed values for care metrics originating from external systems that contain biometric data. This object is availablein API version 49.0 and later.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

75

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 80: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

CodeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe CodeSet ID related to the observation.

Note: When creating a Care Observation record in Apex, use Salesforce IDs instead ofexternal IDs.

Typereference

DeviceId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the device generating the observed value.

Note: When creating a Care Observation record in Apex, use Salesforce IDs instead ofexternal IDs.

TypedateTime

EffectiveDateTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date and time when the observation was recorded.

Typereference

ExpectedValueId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe CodeSet ID related to the care metric target.

Note: When creating a Care Observation record in Apex, use Salesforce IDs instead ofexternal IDs.

Typeboolean

HasMetExpectedValue

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

76

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 81: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether the observed value aligns with the expected value or range.

Typeboolean

IsMonitoredRemotely

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the observed value is obtained via remote monitoring. This record canonly be used in processing and charting if this field is set to True. The default value Is false.

Typeboolean

IsOutcomePositive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates the observed boolean value. The default value is false.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of this care observation.

Typedouble

NumericValue

77

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 82: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe numeric value of the care observation (6 decimal places).

Typereference

ObservedSubjectId

PropertiesCreate, Filter, Group, Sort

DescriptionThe account ID of the subject being observed. For example, the ID of the patient beingobserved.

Note: When creating a Care Observation record in Apex, use Salesforce IDs instead ofexternal IDs.

Typepicklist

ProcessingResult

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe processing result of this observation record. Applicable only ifIsMonitoredRemotely is set to True

Possible values are:

• DATA_TYPE_MISMATCH—Invalid record. Provide a numeric value that matches thedata type in the Expected Value field.

• DOES_NOT_MEET_TARGET—Record processed. Expected value updated. ObservationNumeric Value or Outcome Positive does not meet Care Metric Target conditions.

• MEETS_TARGET—Record processed. Expected value updated. Observation NumericValue or Outcome Positive meets Care Metric Target conditions.

• MISSING_UNIT—Invalid record. Provide a valid unit of measure for the code.

• NO_EXPECTED_VALUE_IN_DATE—Record processed. There is no Expected Valuewith Care Metric Target StartDate and EndDate that meets Observation Effective DateTime

• NO_VALUE_WITH_UNIT—Record processed. There is no Expected Value withmatching Observation Unit of Measure

• NULL_PATIENT_DEVICE—Invalid record. Add information about the patient orthe device.

• PATIENT_NOT_FOUND—Invalid record. Patient not found in the system.

Typereference

UnitOfMeasureId

78

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 83: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measure for the observed value.

Note: When creating a Care Observation record in Apex, use Salesforce IDs instead ofexternal IDs.

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

CareObservationFeedFeed tracking is available for the object.

CareObservationHistoryHistory is available for tracked fields of the object.

CarePgmProvHealthcareProviderRepresents a junction object identifying the primary healthcare professional associated with a care program provider and to look up allhealthcare professionals for care program providers. This object is available in API version 49.0 and later.

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

Fields

DetailsField

Typereference

CareProgramProviderId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the care program provider that is associated with the healthcare provider (healthcareprofessional).

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

79

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 84: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe date from when this association record is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when this association record is no longer effective.

Typereference

HealthcareProviderId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the healthcare provider (healthcare professional) that is associated with the careprogram provider.

Typeboolean

IsPrimaryProvider

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates that the healthcare provider (healthcare professional) is the primary provider forthe care program provider.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

80

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 85: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name for this association between a care program provider and a healthcare provider(healthcare professional).

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the system from which the record was sourced.

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

CarePgmProvHealthcareProviderFeedFeed tracking is available for the object.

CarePgmProvHealthcareProviderHistoryHistory is available for tracked fields of the object.

CareProgramRepresents a set of activities, such as a patient therapy, financial assistance, education, wellness, or fitness plan, offered to participantsby an employer or insurer.

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

81

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 86: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

TypeCurrency

BudgetAmount

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionApproved budget for the care program.

TypeText

CareProgramName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCare program name.

TypeLong Text Area

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionShort description explaining the program.

TypeDate

EndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionProgram termination date.

TypeLookup(Care Program)

ParentProgram

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of another program that this program is a part of, if any.

TypeLookup(Account)

ProgramSponsor

PropertiesCreate, Filter, Group, Nillable, Sort, Update

82

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 87: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionName of the third-party program sponsor, if any.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

TypeDate

StartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEffective start date of the program.

TypePick list

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionStatus of the program.

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

CareProgramFeedFeed tracking is available for the object.

CareProgramHistoryHistory is available for tracked fields of the object.

CareProgramOwnerSharingRuleSharing rules are available for the object.

CareProgramShareSharing is available for the object.

CareProgramCampaignRepresents a relationship between the Care Program object and the Campaign object. This junction object enables admins to associateone or more campaigns to a program.

83

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 88: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField Name

TypeLookup(Campaign)

CareProgramId

PropertiesCreate, Filter, Group, Sort

DescriptionIdentifier for the care program.

TypeMaster-Detail(Care Program)

CareProgram

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the care program.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, Sort

84

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 89: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionA short name for the care program campaign.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the care program campaign was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the care program campaign record.

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

CareProgramCampaignFeedFeed tracking is available for the object.

CareProgramCampaignHistoryHistory is available for tracked fields of the object.

CareProgramEligibilityRuleRepresents a rule defining the criteria for patient care program enrollment eligibility. This entity creates an association between CareProgram and an Enrollment Eligibility Criteria.

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

85

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 90: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

CareProgramId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIdentifier of a care program. Represents a set of activities, such as therapy, wellness, or afitness plan, offered to participants by a healthcare provider, life sciences organization,employer, or insurer.

Typereference

EligibilityCriteriaId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCriteria that define patient enrollment eligibility for a care program.

Typeboolean

IsRequired

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the care program eligibility rule is required.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

86

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 91: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionName for the care program eligibility rule.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionDefines whether the eligibility rule is in force or not.

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

CareProgramEligibilityRuleFeedFeed tracking is available for the object.

CareProgramEligibilityRuleHistoryHistory is available for tracked fields of the object.

87

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 92: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareProgramEligibilityRuleOwnerSharingRuleSharing rules are available for the object.

CareProgramEligibilityRuleShareSharing is available for the object.

CareProgramEnrolleeRepresents a participant enrolled in a care program.

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

Fields

DetailsField Name

TypeLookup(Account)

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPerson Account representing the enrollee

TypeMaster-Detail(Care Program)

CareProgramId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLook up for Care Program.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

88

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 93: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

TypeLookup(Lead)

LeadId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLead representing the enrollee.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the enrollee.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the enrollee record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the enrollee record was sourced.

TypePick list

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionStatus of the enrollee.

TypeLookup(User)

UserId

89

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 94: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUser representing the enrollee.

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

CareProgramEnrolleeFeedFeed tracking is available for the object.

CareProgramEnrolleeHistoryHistory is available for tracked fields of the object.

CareProgramEnrolleeProductRepresents the affiliation between a care program enrollee and a care program product, a care program provider, or both.

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

Fields

DetailsField

Typereference

CareProgramEnrolleeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe care program enrollee associated with this care program product or care programprovider.

Typereference

CareProgramProductId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care program product associated with this care program enrollee and care programprovider.

90

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 95: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

CareProgramProviderId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care program provider associated with this care program enrollee and care programproduct.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the product the enrollee participates in.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

91

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 96: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the care program product or service related to the care program provider andthe recipient of the product or service.

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

CareProgramEnrolleeProductFeedFeed tracking is available for the object.

CareProgramEnrolleeProductHistoryHistory is available for tracked fields of the object.

CareProgramEnrolleeProductOwnerSharingRuleSharing rules are available for the object.

CareProgramEnrolleeProductShareSharing is available for the object.

CareProgramEnrollmentCardRepresents a care program membership card that includes a membership number or enrollment code.

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

92

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 97: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typestring

CardNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unique card number for a care program. Often a membership number or enrollmentcode on a physical card assigned to the care program enrollee.

Typereference

CareProgramEnrolleeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe care program enrollee with whom this care program card is associated.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionName for the care program enrollment card.

Typereference

OwnerId

93

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 98: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of a card in relation to a care program enrollee.

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

CareProgramEnrollmentCardFeedFeed tracking is available for the object.

CareProgramEnrollmentCardHistoryHistory is available for tracked fields of the object.

CareProgramEnrollmentCardOwnerSharingRuleSharing rules are available for the object.

CareProgramEnrollmentCardShareSharing is available for the object.

CareProgramGoalRepresents a business or clinical goal related to a care program.

94

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 99: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

CareProgramId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe care program associated with a corresponding goal.

Typedate

CompletionDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe completion date of a care program goal.

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionA detailed description of the care program goal.

Typedate

DueDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe due date for a care program goal.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

95

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 100: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionName of the care program goal.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typepicklist

Priority

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe priority of the care program goal.

Typepercent

ProgressPercentage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe percentage completion of the care program goal.

Typedouble

SequenceNumber

PropertiesCreate, Filter, Nillable, Sort, Update

96

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 101: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe order or sequence of the care program goal relative to other care program goals.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typedate

StartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe start date for a care program goal.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of a care program goal.

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

CareProgramGoalFeedFeed tracking is available for the object.

CareProgramGoalHistoryHistory is available for tracked fields of the object.

CareProgramGoalOwnerSharingRuleSharing rules are available for the object.

97

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 102: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareProgramGoalShareSharing is available for the object.

CareProgramProductRepresents the affiliation between a care program and a care program product, care program provider, or both.

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

Fields

DetailsField

Typepicklist

Availability

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe default availability of the product to an enrollee in the context of a care program. Forexample, some products or services are available to all enrollees, others are limited to specialcircumstances, and others are no longer available.

Typereference

CareProgramId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier for the care program associated with a care program product.

Typecurrency

CareProgramPrice

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA standard list price for a given product in the context of a care program.

TypedateTime

LastReferencedDate

PropertiesFilter, Group, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

98

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 103: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTIme

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestromg

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the care program product.

Typereference

OwnerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

ProductId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier of the product associated with a care program

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the care program product was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

99

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 104: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the system from which the care program product was sourced.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the product in the context of a care program.

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

CareProgramProductFeedFeed tracking is available for the object.

CareProgramProductHistoryHistory is available for tracked fields of the object.

CareProgramProductOwnerSharingRuleSharing rules are available for the object.

CareProgramProductShareSharing is available for the object.

CareProgramProviderRepresents a business account that is the service provider for a care program product.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe account/business entity that is providing the care program product/service to a careprogram enrollee.

100

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 105: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

CareProgramContactId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe primary person a patient can contact about the care program.

Typereference

CareProgramProductId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe care program product to which this care program provider is associated.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the provider associated with the care program.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

101

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 106: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe ID of the user who owns this record.

Typepicklist

Role

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe type of organization delivering the services included in the program.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of a care program provider in relation to a care program product.

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

CareProgramProviderFeedFeed tracking is available for the object.

CareProgramProviderHistoryHistory is available for tracked fields of the object.

CareProgramProviderOwnerSharingRuleSharing rules are available for the object.

102

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 107: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareProgramProviderShareSharing is available for the object.

CareProgramTeamMemberRepresents a person who delivers services under a program, such as a program manager or care coordinator.

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

Fields

DetailsField Name

TypeLookup(Account)

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPerson account representing the team member.

TypeMaster-Detail(CareProgram)

CareProgramId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup for the care program.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

103

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 108: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the care program team member.

TypePicklist

Role

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionRole of the team member.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

TypeLookup(User)

UserId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUser representing the team member.

104

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 109: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

CareProgramTeamMemberFeedFeed tracking is available for the object.

CareProgramTeamMemberHistoryHistory is available for tracked fields of the object.

CareRegisteredDeviceRepresents device registration information for a patient or a care program enrollee. This object is available in API version 49.0 and later.

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

Fields

DetailsField

Typereference

CareProgramEnrolleeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the care program enrollee to whom this device is registered.

Typereference

DeviceId

PropertiesCreate, Filter, Group, Sort

DescriptionThe asset ID for the device.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

105

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 110: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of this device registration record.

Typereference

PatientId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe account ID of the patient to whom this device is registered.

TypedateTime

RegistrationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date and time when this device was registered.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the system from which the record was sourced.

106

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 111: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

DescriptionIndicates whether the device registration is active.

Possible values are:

• Active

• Inactive

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

CareRegisteredDeviceFeedFeed tracking is available for the object.

CareRegisteredDeviceHistoryHistory is available for tracked fields of the object.

CareSystemFieldMappingRepresents a mapping from source system fields to Salesforce target entities and attributes.

Supported Callscreate(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

DetailsField Name

Typestring

DeveloperName

PropertiesCreate, Filter, Group, Sort, Update

Description

The unique name of the record in the API. This name can contain only underscoresand alphanumeric characters, and must be unique in your org. It must begin witha letter, not include spaces, not end with an underscore, and not contain twoconsecutive underscores. This field is automatically generated but you can supplyyour own value if you create the record using the API.

107

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 112: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

ExternalIdField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

The ID of the field in the external system.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

Typestring

NamespacePrefix

PropertiesFilter, Nillable

DescriptionThe namespace prefix that is associated with this object. Each Developer Editionorg that creates a managed package has a unique namespace prefix. Limit: 15characters. You can refer to a component in a managed package by using thenamespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

• In Developer Edition orgs, NamespacePrefix is set to the namespaceprefix of the org for all objects that support it, unless an object is in an installedmanaged package. In that case, the object has the namespace prefix of theinstalled managed package. This field’s value is the namespace prefix of theDeveloper Edition org of the package developer.

• In orgs that are not Developer Edition orgs, NamespacePrefix is setonly for objects that are part of an installed managed package. All otherobjects have no namespace prefix.

Typestring

MasterLabel

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

The label for this care system field mapping.

108

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 113: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typepicklist

Role

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

DescriptionThe role that the entity represents. Picklist valuesRemoteMonitoringDevice and RemoteMonitoringPatient areavailable from API version 49.0 and later.

Possible values are:

• Patient—When the role field is set to Patient, the Enrollment APIuses the value of externalIdField as the patient ID. This role can beused when targetObject is set to Account.

• RemoteMonitoringDevice—Indicates which externalIdFieldon the Asset object maps to the Device field in the CareObservation object.This role can be used when targetObject is set to Asset.

• RemoteMonitoringPatient—Indicates whichexternalIdField on the Account object maps to theObservedSubject field in the Care Observation object. This role is usedwhen targetObject is set to Account.

• ServiceProvider—The Enrollment API uses the value ofexternalIdField as the provider ID. This role is used whentargetObject is set to Account.

• NotApplicable—This role is used when targetObject is set toCareProgram or Product, which means that there is no applicablerole.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

TargetObject

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Name of the parent entity for the external ID.

109

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 114: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EnrollmentEligibilityCriteriaRepresents criteria that defines patient enrollment eligibility for one or more care programs.

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

Fields

DetailsField

Typereference

Description

PropertiesCreate, Filter, Group, Sort, Update

DescriptionA comprehensive description of the enrollment eligibility criteria.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionA short name for the enrollment eligibility criteria.

Typereference

OwnerId

110

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 115: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

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

EnrollmentEligibilityCriteriaFeedFeed tracking is available for the object.

EnrollmentEligibilityCriteriaHistoryHistory is available for tracked fields of the object.

EnrollmentEligibilityCriteriaOwnerSharingRuleSharing rules are available for the object.

EnrollmentEligibilityCriteriaShareSharing is available for the object.

UnitOfMeasureRepresents the unit of measures for care metrics and care observations. This object is available in API version 49.0 and later.

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

111

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 116: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typestring

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of this unit of measure.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of this unit of measure.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typepicklist

Type

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

112

Life Sciences Program ManagementHealth Cloud Developer Guide

Page 117: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe type of the unit of measure. For example, weight, distance, period.

Typestring

UnitCode

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe code for this unit of measure. For example, mm[Hg], mcg/mL., kgs, lbs.

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

UnitOfMeasureOwnerSharingRuleSharing rules are available for the object.

UnitOfMeasureShareSharing is available for the object.

Claims

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

A claim is information submitted to an individual's health insurance company by an entity providinga service, medication or device.

113

ClaimsHealth Cloud Developer Guide

Page 118: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

ClaimHeader__x

Contains summary information about the claim, such as the payment amount, specified medications, and billing data.

ClaimDiagnosisProcedure__x

Represents a clinical procedure for which a provider is submitting a claim.

ClaimProvider__x

Represents information about a provider of a service, equipment or medication.

ClaimLine__x

Represents a line item in a claim record.

ClaimDiagnosis__x

Represents the clinical diagnosis for which the service, equipment, or medication was provided.

ClaimHeader__xContains summary information about the claim, such as the payment amount, specified medications, and billing data.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(),upsert()

114

ClaimsHealth Cloud Developer Guide

Page 119: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typedate

AcceptedOn__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate on which the claim was accepted.

Typecurrency

AdjudicatedAmount__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAmount paid for the service by primary payer.

Typedate

AdjudicatedOn__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate on which adjudication amount was paid by the primary payer.

Typestring

BilledDRGCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDiagnosis-related group (DRG) code used for billing.

TypeCurrency

ClaimAmount__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAmount submitted with the original claim.

TypeText(64)

ClaimNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

115

ClaimsHealth Cloud Developer Guide

Page 120: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionNumber assigned to the claim.

TypeReference

ClaimStatusId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCurrent status of the claim.

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Typestring

ExternalId

PropertiesCreate, Defaulted on create, Filter, Nillable, Sort, Update

Description

Typestring

DrugName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the drug.

Typestring

DrugQuantity__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAuthorized quantity per refill.

Typedouble

DrugSupplyDays__c

PropertiesCreate, Filter, Nillable, Sort, Update

116

ClaimsHealth Cloud Developer Guide

Page 121: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionNumber of days the supply is authorized for.

Typetextarea

EDIMessage__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionUnparsed, unfiltered, raw EDI message.

Typedate

FillDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate on which the drug was filled by the pharmacy.

Typestring

FormularyTier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe formulary tier level for the drug.

Typestring

HIC3ClassCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHierarchical Specific Therapeutic (HIC3) class code assigned to the service.

Typestring

IsFormularyStatus__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the drug is approved for coverage.

Typestring

IsGeneric__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

117

ClaimsHealth Cloud Developer Guide

Page 122: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether the drug is generic.

Typestring

IsRefillAuthorized__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether refills for the drug are authorized.

Typereference

MemberPlanId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of member plan that this claim is related to.

Typestring

Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the claim record.

Typestring

NDC__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNational Drug Code (NDC) identification number.

Typestring

PartBorPartD__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the drug has Medicare Part B or Part D coverage.

Typereference

PayerId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

118

ClaimsHealth Cloud Developer Guide

Page 123: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the payer that this claim is related to.

Typedate

PaymentDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate on which claim was paid out.

Typestring

PreauthNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPreauthorization number for the service.

Typestring

ReferralNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the referral for the service.

Typestring

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the system where this claim originated.

Typestring

SourceSystemIdentifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system where this claim was sourced from.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

119

ClaimsHealth Cloud Developer Guide

Page 124: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionTimestamp of the most recent update from the source system.

Typestring

StandardGenericTherapeuticClass__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTherapeutic drug category according to the American Hospital Formulary Service (AHFS)classification system.

Typestring

StandardTherapeuticClassDescription__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the therapeutic category of drug according to the American Hospital FormularyService (AHFS) classification system.

Typedate

SubmittedOn__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionClaim submission date.

Typestring

Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of claim.

ClaimDiagnosisProcedure__xRepresents a clinical procedure for which a provider is submitting a claim.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(),upsert()

120

ClaimsHealth Cloud Developer Guide

Page 125: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

ClaimDiagnosisId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the diagnosis from the claim that this record is related to.

Typereference

ClaimProcedureId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the procedure from this claim that this record is related to.

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Typestring

ExternalId

PropertiesCreate, Defaulted on create, Filter, Nillable, Sort, Update

Description

Typestring

Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the claim diagnosis procedure record.

Typedouble

SequenceNumber__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDiagnosis sequence for the claim line item indicating whether diagnosis is primary, secondary,tertiary, and so on.

121

ClaimsHealth Cloud Developer Guide

Page 126: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier of the system where this record was sourced from.

Typestring

SourceSystemIdentifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the system where this record was sourced from.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system

ClaimProvider__xRepresents information about a provider of a service, equipment or medication.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(),upsert()

Fields

DetailsField

TypeReference

ClaimId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the claim that this record is related to.

122

ClaimsHealth Cloud Developer Guide

Page 127: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Typestring

ExternalId

PropertiesCreate, Defaulted on create, Filter, Nillable, Sort, Update

Description

TypeText(64)

Name__c

PropertiesCreate, Filter, Group, NameField, Nillable, Sort, Update

DescriptionName of the claim provider record.

TypeReference

Provider__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the provider that this record is related to.

TypeText(64)

ProviderNPI__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNational Provider Identifier (NPI) identification number.

TypeText(64)

Role__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the provider is the rendering provider, service provider, or billing provider.

123

ClaimsHealth Cloud Developer Guide

Page 128: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypeText(64)

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the system that this record was sourced from.

TypeText(255)

SourceSystemIdentifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system that this record was sourced from.

TypeDateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the the most recent update from the source system.

ClaimLine__xRepresents a line item in a claim record.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(),upsert()

Fields

DetailsField

Typecurrency

AdjustedAmount__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAdjusted amount for the service

124

ClaimsHealth Cloud Developer Guide

Page 129: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

ClaimId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the claim that this record is related to.

Typestring

ClaimStatusId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the claim status that this record is related to.

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Typestring

ExternalId

PropertiesCreate, Defaulted on create, Filter, Nillable, Sort, Update

Description

Typedate

From__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionService start date for claim line.

Typedouble

LineNumber__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionClaim line ID number.

125

ClaimsHealth Cloud Developer Guide

Page 130: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLocation details of the place where service was performed.

Typestring

LocationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLocation code of the place where service was performed.

Typestring

Modifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModifier associated with claim line.

Typestring

Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the claim line record.

Typestring

NDCCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDrug code as defined in the National Drug Code (NDC).

Typecurrency

PaidAmount__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAmount paid for the service.

126

ClaimsHealth Cloud Developer Guide

Page 131: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typecurrency

Price__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionPrice for the service.

Typestring

ProcedureCPTHCPCSId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionService procedure code based on Current Procedural Terminology (CPT) or HealthcareCommon Procedure Coding System (HCPCS).

Typereference

RenderingProvider__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe National Provider Identifier (NPI) of the rendering provider associated with this service.

Typedouble

RevenueCode__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionRevenue grouping code associated with the claim line.

Typestring

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the system that this record was sourced from.

Typestring

SourceSystemIdentifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

127

ClaimsHealth Cloud Developer Guide

Page 132: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the system that this record was sourced from.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system

Typestring

Title__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTitle of the claim line.

Typedate

To__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionService end date for claim line.

Typedouble

Unit__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionNumber of units of service or drug provided to the patient.

ClaimDiagnosis__xRepresents the clinical diagnosis for which the service, equipment, or medication was provided.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(),upsert()

128

ClaimsHealth Cloud Developer Guide

Page 133: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

ClaimId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the claim that this record is related to.

Typestring

Diagnosis__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDiagnosis code or description.

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Typestring

ExternalId

PropertiesCreate, Defaulted on create, Filter, Nillable, Sort, Update

Description

Typedouble

LineNumber__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionClaim diagnosis ID number.

Typestring

Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the claim diagnosis record.

129

ClaimsHealth Cloud Developer Guide

Page 134: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the system that this record was sourced from.

Typestring

SourceSystemIdentifier__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier of the system where this record was sourced from.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system.

Code Sets

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

The code sets data model represents industry-standard procedure and diagnosis codes availableto use in prior-authorization request and approval processes. You import these code sets usingData Loader.

You must have the Health Cloud managed package installed in your org to add the code sets datamodel.

The code sets data model includes standard objects and record types, and custom fields on standardobjects. The standard objects and fields included in code sets are visible to users with the HealthCloud and the Health Cloud Platform permission set licenses and the Health Cloud Permission SetLicense, Health Cloud Member Services, and Health Cloud Social Determinants permission sets.

130

Code SetsHealth Cloud Developer Guide

Page 135: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthCareDiagnosis

Represents information related to industry-standard healthcare diagnosis codes.

HealthCareProcedure

Represents information related to industry-standard healthcare procedure codes.

HealthCareDiagnosisRepresents information related to industry-standard healthcare diagnosis codes.

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

Fields

DetailsField Name

Typepicklist

Category

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Indicates the category for this diagnosis such as newborn, pediatric, maternity,or adult.

Typestring

Code

131

Code SetsHealth Cloud Developer Guide

Page 136: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Industry-standard diagnosis code.

Typestring

CodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the diagnosis code.

Typepicklist

CodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Type of diagnosis code represented in the record such as ICD-9 or ICD-10.

Typedate

EffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Start date for the code.

Typedate

EndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

End date for the code.

Typepicklist

Gender

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Indicates whether this diagnosis is for males, females, or all genders.

132

Code SetsHealth Cloud Developer Guide

Page 137: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether the diagnosis code is available for use.

Typeboolean

IsComplicationOrComorbidity

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether this diagnosis is used to represent a complication orcomorbidity.

Typeboolean

IsHospitalAcquiredCondition

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether this diagnosis represents a condition acquired while in thehospital.

Typeboolean

IsMajorComplicationOrComorbidity

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether this diagnosis is used to represent a major complication orcomorbidity.

Typeboolean

IsPresentOnAdmissionExempt

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether diagnosis code is exempt from the diagnosis present onadmission requirement.

133

Code SetsHealth Cloud Developer Guide

Page 138: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typeboolean

IsPrimaryDiagnosis

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether diagnosis code can be used as primary diagnosis only, or canbe used in any diagnosis sequence.

Typeboolean

IsUnacceptablePrincipalDxIpAdmit

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether diagnosis code is an unacceptable principal diagnosis forinpatient admission per Medicare Code Edits.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

Description

The name of the code that displays in search and lookup fields. Salesforcerecommends using the code along with the description to populate this field.

134

Code SetsHealth Cloud Developer Guide

Page 139: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

For example, use <Code>: <Description> or <Code>-<Description> such as(E08.37X9 - Diabetes mellitus due to underlying condition).

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

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

HealthCareDiagnosisHistoryHistory is available for tracked fields of the object.

HealthCareDiagnosisOwnerSharingRuleSharing rules are available for the object.

HealthCareDiagnosisShareSharing is available for the object.

HealthCareProcedureRepresents information related to industry-standard healthcare procedure codes.

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

Fields

DetailsField Name

Typepicklist

Category

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Category of the procedure code such as anesthesia, surgery, radiology, and soon.

Typestring

Code

135

Code SetsHealth Cloud Developer Guide

Page 140: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Industry standard procedure code such as CPT or HCPCS.

Typestring

CodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the procedure code.

Typestring

CodeShortDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Short description of the procedure code.

Typepicklist

CodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Type of procedure code represented in the record such as CPT or HCPCS.

Typedate

EffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Start date for the code.

Typedate

EndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

End date for the code.

136

Code SetsHealth Cloud Developer Guide

Page 141: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether the diagnosis code is available for use.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

Description

The timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

Description

The timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

Description

The name of the code that displays in search and lookup fields. Salesforcerecommends using the code along with the description to populate this field.For example, use <Code>: <Description> or <Code>-<Description> such as95115: Allergy injection.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

The ID of the user who owns this record.

137

Code SetsHealth Cloud Developer Guide

Page 142: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

HealthCareProcedureHistoryHistory is available for tracked fields of the object.

HealthCareProcedureOwnerSharingRuleSharing rules are available for the object.

HealthCareProcedureShareSharing is available for the object.

Health InsuranceThe health insurance data model provides objects for managing the ways care is paid for. It represents information about participantssuch as employment, insurance coverage, and dependents. You can manage details of the benefits provided by plans to members andtreatment preauthorization requests made by members or providers.

You must have the Health Cloud managed package installed in your org to add the health insurance data model.

The health insurance data model includes standard objects and record types. The health insurance standard objects are visible to userswith the Health Cloud and the Health Cloud Platform permission set licenses and the Health Cloud Permission Set License and HealthCloud Member Services permission sets.

CarePreauth

Represents the details of preauthorizations for care under a member’s plan.

CarePreauthItem

Represents the details of items included in a preauthorization for care under a member’s plan.

138

Health InsuranceHealth Cloud Developer Guide

Page 143: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CoverageBenefit

Represents the benefits provided to a covered member by a purchaser’s plan.

CoverageBenefitItem

Represents the benefits items provided to a covered member by a purchaser’s plan.

Member

A member is a person who is the primary subscriber, a dependent, or anyone else who is covered under the insurance plan.

MemberPlan

Represents details about the insurance coverage for a member or subscriber.

Payer

A payer is a health insurance company that helps cover the cost of member care.

PlanBenefit

Represents the standard benefits available under a plan that the purchaser offers to their members.

PlanBenefitItem

Represents the details of a benefit available under a purchaser’s plan that is offered to their members.

Purchaser

A purchaser is the organization (an employer) that is providing medical insurance plans for their members (employees).

Purchaser Group

A purchaser group is a subset of the purchaser. For example, your company may have individual employee groups in different regionsof the country. Each purchaser group can have separate options for insurance plans.

Purchaser Group Member Association

An association that records the members who belong to a purchaser group.

PurchaserPlan

Represents the payer plan that a purchaser makes available to its members and members’ dependents.

PurchaserPlanAssn

Represents a junction object that associates the purchaser to the plans they offer to members.

Purchaser Payer Association

An association that records the purchasers who purchase plans from payers.

CarePreauthRepresents the details of preauthorizations for care under a member’s plan.

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

Fields

DetailsField Name

Typedate

EffectiveFrom

139

Health InsuranceHealth Cloud Developer Guide

Page 144: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this preauthorization is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date after which this preauthorization is no longer effective.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typereference

MemberPlanId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the member plan for which this preauthorization is being provided.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of this preauthorization.

140

Health InsuranceHealth Cloud Developer Guide

Page 145: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionNotes about this preauthorization.

Typereference

PayerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the payer covering the cost of this treatment.

Typestring

PreauthIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier provided by the insurance company for preauthorization of a service.

Typestring

ReferringPhysician

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the doctor who referred the member for this treatment.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this preauthorization record was obtained from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this preauthorization record on its source system.

141

Health InsuranceHealth Cloud Developer Guide

Page 146: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this preauthorization was last changed on its source system.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe status of this preauthorization record. The default the picklist values are:

• Active

• Inactive

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

CarePreauthFeedFeed tracking is available for the object.

CarePreauthHistoryHistory is available for tracked fields of the object.

CarePreauthOwnerSharingRuleSharing rules are available for the object.

CarePreauthShareSharing is available for the object.

CarePreauthItemRepresents the details of items included in a preauthorization for care under a member’s plan.

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

142

Health InsuranceHealth Cloud Developer Guide

Page 147: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

Typereference

CarePreauthId

PropertiesCreate, Filter, Group, Sort

Description

The ID of the care preauthorization this item details.

Typestring

EndingServiceCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ending service code for the category of care being provided.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’s possiblethat this record was referenced (LastReferencedDate) and not viewed.

Typepicklist

Laterality

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe side of the body receiving care.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

143

Health InsuranceHealth Cloud Developer Guide

Page 148: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionName of this preauthorized care item.

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionNotes about this preauthorized care item.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typeint

PreauthitemSequence

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSequence of this item among the preauthorized care items.

Typeint

Quantity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionQuantity being preauthorized.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this preauthorization record was obtained from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

144

Health InsuranceHealth Cloud Developer Guide

Page 149: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe ID of this preauthorization record on its source system.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this preauthorization was last changed on its source system.

Typestring

StartingServiceCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe starting service code for the category of care being provided.

Typestring

Unit

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUnits by which the preauthorized quantity is measured.

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

CarePreauthItemFeedFeed tracking is available for the object.

CarePreauthItemHistoryHistory is available for tracked fields of the object.

CarePreauthItemOwnerSharingRuleSharing rules are available for the object.

CarePreauthItemShareSharing is available for the object.

CoverageBenefitRepresents the benefits provided to a covered member by a purchaser’s plan.

145

Health InsuranceHealth Cloud Developer Guide

Page 150: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField Name

Typetextarea

BenefitNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the benefits available to the member under thisplan’s coverage.

Typetextarea

CoinsuranceNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the contribution the member makes towardstreatment.

Typetextarea

CopayNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information on the copayment amounts members contributes.

Typetextarea

DeductibleNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the member’s deductibles under this plan.

Typecurrency

EmergencyDepartmentCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member contributes towards emergency treatment.

146

Health InsuranceHealth Cloud Developer Guide

Page 151: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typecurrency

FamilyInNetworkDeductibleApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has paid for health care provided by the health plan’spreferred providers for all family members.

Typecurrency

FamilyInNetworkDeductibleLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has to pay for health care provided by the health plan’spreferred providers for all family members. When this amount is reached, theplan starts to contribute towards treatment.

Typecurrency

FamilyInNetworkDeductibleRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member still has to pay for health care provided by the healthplan’s preferred providers for all family members. When this amount is reached,the plan starts to contribute towards treatment.

Typecurrency

FamilyInNetworkOutofPocketApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount of the member has paid in this coverage year for health care providedby the health plan’s preferred providers for all family members. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

FamilyInNetworkOutofPocketLimit

PropertiesCreate, Filter, Nillable, Sort, Update

147

Health InsuranceHealth Cloud Developer Guide

Page 152: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe most the member pays during the coverage year for health care providedby the health plan’s preferred providers for all family members. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

FamilyInNetworkOutofPocketRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe remaining amount for the member to pay during this coverage year for careprovided by the plan’s preferred providers for all family members. When thisamount is reached, the plan starts to contribute towards treatment. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

FamilyOutofNetworkDeductibleApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has paid for health care provided by non-preferredproviders for all family members.

Typecurrency

FamilyOutofNetworkDeductibleLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe total amount the member has to pay for health care provided bynon-preferred providers for all family members. When this amount is reached,the plan starts to contribute towards treatment.

Typecurrency

FamilyOutofNetworkDeductibleRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member still has to pay for health care provided by non-preferredproviders for all family members. When this amount is reached, the plan startsto contribute towards treatment.

Typecurrency

FamilyOutofNetworkOutofPocketApplied

148

Health InsuranceHealth Cloud Developer Guide

Page 153: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount of the member has paid in this coverage year for health care providedby non-preferred providers for all family members. It includes deductibles,copayments, and coinsurance, but excludes premiums.

Typecurrency

FamilyOutofNetworkOutofPocketLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most the member pays during the coverage year for health care providedby non-preferred providers for all family members. It includes deductibles,copayments, and coinsurance, but excludes premiums.

Typecurrency

FamilyOutofNetworkOutofPocketRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe remaining amount for the member to pay during this coverage period forhealth care provided by non-preferred providers for all family members. Whenthis amount is reached, the plan starts to contribute towards treatment. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualInNetworkDeductibleApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has paid for health care provided by the health plan’spreferred providers to the most costly family member.

Typecurrency

IndividualInNetworkDeductibleLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has to pay for health care provided by the plan’spreferred providers for any family member. When this amount is reached, theplan starts to contribute towards treatment.

149

Health InsuranceHealth Cloud Developer Guide

Page 154: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typecurrency

IndividualInNetworkDeductibleRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe remaining amount the member has to pay for care during the coverage yearprovided by the plan’s preferred providers for any family member. When thisamount is reached, the plan starts to contribute towards treatment.

Typecurrency

IndividualInNetworkOutofPocketApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount of the member has paid in this coverage year for health care providedby the plan’s preferred providers to any one family member. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualInNetworkOutofPocketLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most the member pays during the coverage year for health care providedby the health plan’s preferred providers for any family member. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualInNetworkOutofPocketRemaining

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount remaining for the member to pay during the coverage year for careprovided by the plan’s preferred providers for any family member. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualOutofNetworkDeductibleApplied

PropertiesCreate, Filter, Nillable, Sort, Update

150

Health InsuranceHealth Cloud Developer Guide

Page 155: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe amount the member has paid for health care provided by non-preferredproviders to the most costly family member.

Typecurrency

IndividualOutofNetworkDeductibleLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has to pay for health care provided by non-preferredproviders to any one family member. When this amount is reached, the planstarts to contribute towards treatment.

Typecurrency

IndividualOutofNetworkDeductibleRemain

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe remaining amount the member has to pay for health care during the coverageyear provided by non-preferred providers to any family member. When thisamount is reached, the plan starts to contribute towards treatment.

Typecurrency

IndividualOutofNetworkOutofPocketApplied

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount of the member has paid in this coverage period for health careprovided by non-preferred providers to any family members. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualOutofNetworkOutofPocketLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most the member pays during the coverage year for health care providedby non-preferred providers to any family member. It includes deductibles,copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualOutofNetworkOutofPocketRemain

151

Health InsuranceHealth Cloud Developer Guide

Page 156: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount remaining for the member to pay during the coverage year for healthcare provided by non-preferred providers to any family member. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

InNetworkCoinsuranceAmount

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member contributes towards treatment undertaken by thehealth plan’s preferred providers.

Typepercent

InNetworkCoinsurancePercentage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe percentage of treatment cost the member pays for treatment undertakenby the health plan’s preferred providers.

Typecurrency

InNetworkLifetimeMaximum

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has to pay during lifetime coverage under this planafter which the provider covers all costs for treatment provided by its preferredproviders. It includes deductibles, copayments, and coinsurance, but excludespremiums.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedatetime

LastViewedDate

152

Health InsuranceHealth Cloud Developer Guide

Page 157: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typetextarea

LifetimeMaximumNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information on the lifetime maximum payments the member Will beexpected to make.

Typereference

MemberId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the member receiving these benefits.

Typereference

MemberPlanId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the member plan receiving these benefits.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of these coverage benefits.

Typecurrency

OutofNetworkCoinsuranceAmount

PropertiesCreate, Filter, Nillable, Sort, Update

153

Health InsuranceHealth Cloud Developer Guide

Page 158: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe amount the member contributes towards treatment undertaken bynon-preferred providers.

Typepercent

OutofNetworkCoinsurancPercentage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe percentage of treatment cost the member pays for treatment undertakenby non-preferred providers.

Typecurrency

OutofNetworkLifetimeMaximum

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member has to pay during lifetime coverage under this planafter which the plan provider covers all costs for treatment provided by itsnon-preferred providers. It includes deductibles, copayments, and coinsurance,but excludes premiums.

Typetextarea

OutofPocketNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the out-of-pocket payment the member makes.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typecurrency

PrimaryCareCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member contributes towards primary care treatment.

154

Health InsuranceHealth Cloud Developer Guide

Page 159: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this benefits record was obtained from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this benefits record on its source system.

Typedate

SourceSystemModified

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which these benefits were last changed on their source system.

Typecurrency

SpecialistCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member contributes towards specialist consultations.

Typecurrency

UrgentCareCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount the member contributes towards urgent care.

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

CoverageBenefitFeedFeed tracking is available for the object.

155

Health InsuranceHealth Cloud Developer Guide

Page 160: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CoverageBenefitHistoryHistory is available for tracked fields of the object.

CoverageBenefitOwnerSharingRuleSharing rules are available for the object.

CoverageBenefitShareSharing is available for the object.

CoverageBenefitItemRepresents the benefits items provided to a covered member by a purchaser’s plan.

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

Fields

DetailsField Name

Typestring

BenefitCategory

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the category this benefit is in.

Typereference

CoverageBenefitId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the covered benefit this item belongs to.

Typestring

CoverageLevel

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the level of coverage provided by this item.

Typetextarea

InNetworkCoverage

156

Health InsuranceHealth Cloud Developer Guide

Page 161: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Nillable, Update

DescriptionDescription of the in network coverage provided by this item.

Typeboolean

IsInPlanNetwork

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates if the benefit is only available in the plan network.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’s possiblethat this record was referenced (LastReferencedDate) and not viewed.

Typereference

MemberId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the member receiving this benefit item.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of this coverage benefit item.

157

Health InsuranceHealth Cloud Developer Guide

Page 162: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about this coverage benefit item.

Typetextarea

OutofNetworkCoverage

PropertiesCreate, Nillable, Update

DescriptionDescription of the coverage for non-preferred providers.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

ServiceType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of service this plan benefit item provides.

Typestring

ServiceTypeCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe code for the type of service this plan benefit item provides.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this coverage benefits item record came from.

158

Health InsuranceHealth Cloud Developer Guide

Page 163: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this coverage benefits item record on its source system.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this coverage benefits item was last changed on the source system.

Typestring

TimePeriod

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the period this plan benefit item covers.

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

CoverageBenefitItemFeedFeed tracking is available for the object.

CoverageBenefitItemHistoryHistory is available for tracked fields of the object.

CoverageBenefitItemOwnerSharingRuleSharing rules are available for the object.

CoverageBenefitItemShareSharing is available for the object.

MemberA member is a person who is the primary subscriber, a dependent, or anyone else who is covered under the insurance plan.

You can represent a member in one of two ways, depending on the configuration of your org.

• A combination of the Account object record and the Contact object record, both of record type Individual.

• An Account object record of record type Person Account.

For more information on using person accounts, see Person Accounts in Health Cloud (Optional).

159

Health InsuranceHealth Cloud Developer Guide

Page 164: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

See Also:

• Account

• Contact

• Person Accounts

MemberPlanRepresents details about the insurance coverage for a member or subscriber.

Note: The primary member on the plan is called the subscriber. The other members are dependents.

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

Fields

DetailsField Name

Typestring

Affiliation

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn affiliation to a government service, such as the army or navy.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this member plan is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this member plan ceases to be effective.

Typestring

GroupNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

160

Health InsuranceHealth Cloud Developer Guide

Page 165: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe group number or policy number of the primary member.

Typestring

IssuerNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReference number for the issuer of the plan.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedate

LastVerification

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this plan was last verified.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typereference

MemberId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the member’s record.

161

Health InsuranceHealth Cloud Developer Guide

Page 166: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

MemberNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe member’s reference number for this plan.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name by which the member knows this plan.

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionNotes about this member plan.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PayerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the payer’s Account object record.

Typereference

PlanId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup of the Purchaser Plan ID.

162

Health InsuranceHealth Cloud Developer Guide

Page 167: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

PrimaryCarePhysician

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the physician providing primary care under this plan.

Typepicklist

PrimarySecondaryTertiary

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhether this plan is the primary, secondary, or tertiary plan.

Typepicklist

RelationshipToSubscriber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe relationship of this member to the plan’s subscriber. Valid options are:

• Self

• Spouse

• Child

• Unknown

• Other Relationship

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this plan record came from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this plan record on its source system.

163

Health InsuranceHealth Cloud Developer Guide

Page 168: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this plan record was last changed on the source system.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the plan is active.

Typereference

SubscriberId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the subscriber’s record.

Typepicklist

VerificationStatus

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the plan’s verification. Valid options are:

• Active - Verified

• Rejected

• Not Checked

• Unknown

• Inactive

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

MemberPlanFeedFeed tracking is available for the object.

MemberPlanHistoryHistory is available for tracked fields of the object.

164

Health InsuranceHealth Cloud Developer Guide

Page 169: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

MemberPlanOwnerSharingRuleSharing rules are available for the object.

MemberPlanShareSharing is available for the object.

PayerA payer is a health insurance company that helps cover the cost of member care.

A payer is represented by records on the Account object of record type Payer, with new custom fields. In addition, a payer is describedwith the following core and Health Cloud fields:

• Name—Payer’s name (core field)

• SourceSystemId__c—ID of the Payer record on the system from which it was sourced (Health Cloud custom field)

Account Custom Fields

DetailsField Name

Typestring

PayerType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the type of payer.

Typestring

TaxId__c

PropertiesFilter, Nillable, Sort

DescriptionThe payer’s tax ID.

Typestring

SourceSystem__c

PropertiesFilter, Nillable, Sort

DescriptionThe name of the system from which the payer’s details are sourced.

See Also:

• Account

• Account Custom Fields

165

Health InsuranceHealth Cloud Developer Guide

Page 170: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

PlanBenefitRepresents the standard benefits available under a plan that the purchaser offers to their members.

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

Fields

DetailsField Name

Typetextarea

BenefitNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the benefits available to members under this plan’scoverage.

Typetextarea

CoinsuranceNotes

PropertiesCreate, Nillable, Update

DescriptionInformation about the contribution a member makes towards treatment.

Typetextarea

CopayNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information on the copayment amounts that members contribute.

Typetextarea

DeductibleNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about a member’s deductibles.

Typeurl

DocumentLocation

166

Health InsuranceHealth Cloud Developer Guide

Page 171: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Nillable, Update

DescriptionHyperlink to internal or external resources.

Typedate

EffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which these benefits are communicated to plan members.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which these benefits become effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which these benefits ceased to be effective.

Typecurrency

EmergencyDepartmentCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionPatient's portion of payment for using emergency department services.

Typecurrency

FamilyInNetworkDeductible

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member pays for health care provided by the health plan’s preferredproviders for all family members. When this amount is reached, the plan startsto contribute towards treatment.

167

Health InsuranceHealth Cloud Developer Guide

Page 172: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typecurrency

FamilyInNetworkOutofPocket

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most a member pays during a coverage year for health care provided by thehealth plan’s preferred providers for all family members. It includes deductibles,copayments, and coinsurance, but is in addition to premiums.

Typecurrency

FamilyOutofNetworkDeductible

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member pay for health care provided by non-preferred providersfor all family members before this plan starts to contribute towards treatment.

Typecurrency

FamilyOutofNetworkOutofPocket

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most a member pays during a coverage year for health care provided bynon-preferred providers for all family members. It includes deductibles,copayments, and coinsurance, but is in addition to premiums.

Typecurrency

IndividualInNetworkDeductible

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member pays for health care provided by the health plan’s preferredproviders to any one family member. When this amount is reached, the planstarts to contribute towards treatment.

Typecurrency

IndividualInNetworkOutofPocket

PropertiesCreate, Filter, Nillable, Sort, Update

168

Health InsuranceHealth Cloud Developer Guide

Page 173: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe most a member pays during a coverage year for health care provided by thehealth plan’s preferred providers for any one family member. It includesdeductibles, copayments, and coinsurance, but excludes premiums.

Typecurrency

IndividualOutofNetworkDeductible

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member pays for health care provided by non-preferred providersto any one family member before this plan starts to contribute towards treatment.

Typecurrency

IndividualOutofNetworkOutofPocket

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most a member pays during a coverage year for health care provided bynon-preferred providers for any one family member. It includes deductibles,copayments, and coinsurance, but excludes premiums.

Typedouble

InNetworkCoinsuranceAmount

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member contributes towards each treatment undertaken by thehealth plan’s preferred providers.

Typedouble

InNetworkCoinsurancePercentage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe percentage of treatment cost the member pays for each treatmentundertaken by the health plan’s preferred providers.

Typecurrency

InNetworkLifetimeMaximum

PropertiesCreate, Filter, Nillable, Sort, Update

169

Health InsuranceHealth Cloud Developer Guide

Page 174: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe most a member pays during the lifetime membership on this plan for healthcare provided by the health plan’s preferred providers. It includes deductibles,copayments, and coinsurance, but excludes premiums.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typetextarea

LifetimeMaximumNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about a member’s maximum lifetime payments.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of these plan coverage benefits.

Typedouble

OutofNetworkCoinsuranceAmount

PropertiesCreate, Filter, Nillable, Sort, Update

170

Health InsuranceHealth Cloud Developer Guide

Page 175: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe amount a member contributes towards treatment undertaken bynon-preferred providers.

Typedouble

OutofNetworkCoinsurancePercentage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe percentage of treatment cost the member pays for treatment undertakenby non-preferred providers.

Typecurrency

OutofNetworkLifetimeMaximum

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most a member pays during the lifetime membership on this plan for healthcare provided by non-preferred providers. It includes deductibles, copayments,and coinsurance, but excludes premiums.

Typetextarea

OutofPocketNotes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the out-of-pocket payment a member makes.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typecurrency

PrimaryCareCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member contributes towards primary care treatment.

171

Health InsuranceHealth Cloud Developer Guide

Page 176: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typereference

PurchaserPlanId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the purchaser plan offering these benefits.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this benefits record came from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this benefits record on its source system.

Typedate

SourceSystemModified

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which these benefits were last changed on their source system.

Typecurrency

SpecialistCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member contributes towards specialist consultations.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe status of these benefits. The default the picklist values are:

172

Health InsuranceHealth Cloud Developer Guide

Page 177: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

• Active

• Inactive

Typecurrency

UrgentCareCopay

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount a member contributes towards urgent care.

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

PlanBenefitFeedFeed tracking is available for the object.

PlanBenefitHistoryHistory is available for tracked fields of the object.

PlanBenefitOwnerSharingRuleSharing rules are available for the object.

PlanBenefitShareSharing is available for the object.

PlanBenefitItemRepresents the details of a benefit available under a purchaser’s plan that is offered to their members.

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

Fields

DetailsField Name

Typestring

BenefitCategory

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the benefit category this item belongs to.

173

Health InsuranceHealth Cloud Developer Guide

Page 178: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

CoverageLevel

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the level of coverage provided.

Typecurrency

InNetworkCoverage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount available to contribute towards treatment costs for each treatmentundertaken by the health plan’s preferred providers.

Typeboolean

IsInPlanNetwork

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates if the benefit is only available in the plan network.

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

174

Health InsuranceHealth Cloud Developer Guide

Page 179: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of this benefit item.

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionAdditional information about this benefit item.

Typecurrency

OutofNetworkCoverage

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe amount available to contribute towards treatment costs for each treatmentundertaken by non-preferred providers.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PlanBenefitId

PropertiesCreate, Filter, Group, Sort

DescriptionThe ID of the benefit this item belongs to.

Typestring

ServiceType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of service this plan benefit item provides for.

175

Health InsuranceHealth Cloud Developer Guide

Page 180: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

ServiceTypeCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe code for the type of service this plan benefit item provides for.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this benefits item record came from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this benefits item record on its source system.

Typedate

SourceSystemModified

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this benefits item was last updated from the source system.

Typestring

TimePeriod

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the period during which services under this plan benefit itemare to be rendered or continued.

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

PlanBenefitItemFeedFeed tracking is available for the object.

176

Health InsuranceHealth Cloud Developer Guide

Page 181: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

PlanBenefitItemHistoryHistory is available for tracked fields of the object.

PlanBenefitItemOwnerSharingRuleSharing rules are available for the object.

PlanBenefitItemShareSharing is available for the object.

PurchaserA purchaser is the organization (an employer) that is providing medical insurance plans for their members (employees).

A purchaser is represented by records on the Account object of record type Business.

See Also:

• Account

SEE ALSO:

Account

Account

Purchaser GroupA purchaser group is a subset of the purchaser. For example, your company may have individual employee groups in different regionsof the country. Each purchaser group can have separate options for insurance plans.

A purchaser group is represented by records on the Account object of record type Business.

See Also:

• Account

Purchaser Group Member AssociationAn association that records the members who belong to a purchaser group.

This association is represented by records on the AccountContactRelation object. Activate this object as part of the Health Cloud packageinstallation process. For more information, see Install the Health Cloud Package.

See Also:

• AccountContactRelation

PurchaserPlanRepresents the payer plan that a purchaser makes available to its members and members’ dependents.

PurchaserPlan is a new core object for Health Cloud.

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

177

Health InsuranceHealth Cloud Developer Guide

Page 182: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

Typepicklist

Affiliation

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn affiliation to a government service, such as the army or navy.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this purchaser plan is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this purchaser plan ceases to be effective.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of this plan.

Typetextarea

Notes

PropertiesCreate, Nillable, Update

DescriptionNotes about this payer.

Typereference

Payer

PropertiesCreate, Filter, Group, Nillable, Sort, Update

178

Health InsuranceHealth Cloud Developer Guide

Page 183: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe ID of the payer’s Account object record.

Typestring

PlanNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe plan’s reference number.

Typepicklist

PlanStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the plan is active.

Typepicklist

PlanType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of plan, with the following default options:

• PPO

• HMO

• Medicare

• Medicaid

• Workers Comp

Typestring

ServiceType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the service type offered by this plan.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

179

Health InsuranceHealth Cloud Developer Guide

Page 184: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe name of the system this plan record came from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this plan record on its source system.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this plan record was last changed on the source system.

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

PurchaserPlanFeedFeed tracking is available for the object.

PurchaserPlanHistoryHistory is available for tracked fields of the object.

PurchaserPlanOwnerSharingRuleSharing rules are available for the object.

PurchaserPlanShareSharing is available for the object.

PurchaserPlanAssnRepresents a junction object that associates the purchaser to the plans they offer to members.

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

180

Health InsuranceHealth Cloud Developer Guide

Page 185: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

Typedatetime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

Typedatetime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionThe name of this purchaser to purchaser plan association.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PurchaserId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the plan purchaser’s Account object record.

Typereference

PurchaserPlanId

181

Health InsuranceHealth Cloud Developer Guide

Page 186: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of the associated plan on the Purchaser Plan object.

Typepicklist

Role

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the purchaser plays a primary or secondary role in the plan.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the system this record came from.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe ID of this record on its source system.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date on which this item was last changed on the source system.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether this purchaser plan relationship is active.

182

Health InsuranceHealth Cloud Developer Guide

Page 187: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

PurchaserPlanAssnFeedFeed tracking is available for the object.

PurchaserPlanAssnHistoryHistory is available for tracked fields of the object.

PurchaserPlanAssnOwnerSharingRuleSharing rules are available for the object.

PurchaserPlanAssnShareSharing is available for the object.

Purchaser Payer AssociationAn association that records the purchasers who purchase plans from payers.

This association is represented by records on the AccountAccountRelation__c custom object. This object is included as part of thestandard Health Cloud installation.

See Also:

• AccountAccountRelation__c

SEE ALSO:

Account

Account

Intelligent Sales

EDITIONS

Available in: Enterprise andUnlimited Editions

Help you sales team plan and execute sales visits and manage field inventory with Intelligent Salesfor Health Cloud.

The Intelligent Sales standard objects are available to users with the Health Cloud and the HealthCloud AddOn permission set licenses. Available in API version 49.0 and later.

actionplantemplate

Defines a template for different assessment tasks in a visit. This object is available in API version 49.0 and later in Health Cloud.

AssessmentTask

Perform activities such as patient registration or order authorization to capture information. This object is available in API version47.0 and later, but is available in Health Cloud from API version 49.0.

Pricebook2

Represents a price book that contains the list of products that your org sells.

Product2

Represents a product that your org sells.

Pricebookentry

Represents a product entry (an association between a price book and product) in a price book.

183

Intelligent SalesHealth Cloud Developer Guide

Page 188: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

ProductFulfillmentLocation

Associates a business account and a product inventory with the responsible field rep. This object is available in API version 49.0 andlater.

ProductItem

Represents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse.

productrequired

Represents a product that is needed to complete a visit.

producttransfer

Represents the transfer of inventory between locations in field service.

RecordAction

Represents a relationship between a record and an action, such as a flow. Create a RecordAction for every action that you want toassociate with a particular record. Available in API version 42.0 and later.

Visit

Track information related to a field rep’s visit to a hospital account where they perform surgical visits. This object is available in APIversion 47.0 and later, but is available in Health Cloud from API version 49.0.

VisitedParty

Represents the contact person at the account that’s being visited. This object is available in API version 49.0 and later.

Visitor

Represents the sales reps performing visits. This object is available in API version 49.0 and later.

SEE ALSO:

Set Up Intelligent Sales

actionplantemplateDefines a template for different assessment tasks in a visit. This object is available in API version 49.0 and later in Health Cloud.

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

Fields

DetailsField

Typepicklist

ActionPlanType

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort

DescriptionSpecifies the type of action plan you’re creating.

Possible values are:

184

Intelligent SalesHealth Cloud Developer Guide

Page 189: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Industries

• Visit Execution

For Intelligent Sales, select only Visit Execution.

Typetextarea

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description for your action plan template.

Typeboolean

IsAdHocItemCreationEnabled

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether ad-hoc creation of tasks is possible.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp for the last time this record was referenced.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp for the last time this record was viewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name for your action plan template

Typereference

OwnerId

185

Intelligent SalesHealth Cloud Developer Guide

Page 190: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionReference to the owner of the record.

Typepicklist

TargetEntityType

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort

DescriptionIndicates which entity this template is being created for.

Possible values are:

• Account

• BusinessMilestone—Business Milestone

• Case

• Contact

• Contract

• Lead

• Opportunity

• PersonLifeEvent

• Person Life Event

• Visit

For Intelligent Sales, use only Visit.

Typestring

UniqueName

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe unique name for your action plan template.

AssessmentTaskPerform activities such as patient registration or order authorization to capture information. This object is available in API version 47.0and later, but is available in Health Cloud from API version 49.0.

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

186

Intelligent SalesHealth Cloud Developer Guide

Page 191: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

AssessmentTaskDefinitionId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe assessment task definition that is referenced for the task.

Typetextarea

Description

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDescription of task that has to be performed at the store.

TypedateTime

EndTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTime when the task was completed by a field rep.

Typeboolean

IsRequired

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicate whether a task must be completed to complete a visit. The default value is False.This field is available in API version 48.0 and later.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

187

Intelligent SalesHealth Cloud Developer Guide

Page 192: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe most recent date on which a user viewed this record.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionUnique identification of the task.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the assessment task record owner.

Typereference

ParentId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe visit associated with an assessment task.This field is available in API version 48.0 andlater.

Typeint

SequenceNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe sequence in which the tasks must be performed. This field is available in API version 48.0and later.

TypedateTime

StartTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTime when the task was started by a field rep.

Typepicklist

Status

188

Intelligent SalesHealth Cloud Developer Guide

Page 193: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

DescriptionView the status of a task. This field is available in API version 48.0 and later.

Possible values are:

• Completed

• InProgress—In Progress

• NotStarted—Not Started

Typepicklist

TaskType

PropertiesCreate, Filter, Group, Restricted picklist, Sort

DescriptionType of a task that the sales rep can perform during the visit.

Possible values are:

• ConductInStoreSurveys

• InventoryCheck

• Other

• PlaceOrder

• PlanogramCheck

• PromotionCheck

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

• AssessmentTaskShare on page 629

• AssessmentTaskFeed on page 616

Pricebook2Represents a price book that contains the list of products that your org sells.

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

189

Intelligent SalesHealth Cloud Developer Guide

Page 194: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typestring

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionText description of the price book.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the price book is active (true) or not (false). Inactive price books arehidden in many areas in the user interface. You can change this field’s value as often asnecessary. Label is Active.

Typeboolean

IsArchived

PropertiesDefaulted on create, Filter, Group, Sort

Description

Indicates whether the price book has been archived (true) or not (false). This field is readonly.

Typeboolean

IsDeleted

PropertiesDefaulted on create, Filter

DescriptionIndicates whether the price book has been moved to the Recycle Bin (true) or not (false).Label is Deleted.

Typeboolean

IsStandard

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the price book is the standard price book for the org (true) or not(false). Every org has one standard price book—all other price books are custom pricebooks.

190

Intelligent SalesHealth Cloud Developer Guide

Page 195: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionRequired. Name of this object. This field is read-only for the standard price book. Label isPrice Book Name.

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

Pricebook2HistoryHistory is available for tracked fields of the object.

Product2Represents a product that your org sells.

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

Fields

DetailsField

Typetextarea

Description

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionA text description of this record. Label is Product Description.

Typeurl

DisplayUrl

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionURL leading to a specific version of a record in the linked external data source.

191

Intelligent SalesHealth Cloud Developer Guide

Page 196: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

ExternalDataSourceId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the related external data source.

Typestring

ExternalId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unique identifier of a record in the linked external data source. For example, ID #123.

Typepicklist

Family

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the product family associated with this record. Product families are configured aspicklists in the user interface. Label is Product Family.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this record is active.

Typeboolean

IsArchived

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicated whether the product is archived.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

192

Intelligent SalesHealth Cloud Developer Guide

Page 197: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Description

Time stamp for the last time this record was referenced.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

Description

Time stamp for the last time this record was viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionRequired. Default name of this record. Label is Product Name.

Typestring

ProductCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDefault product code for this record. Your org defines the product code naming pattern.

Typepicklist

QuantityUnitOfMeasure

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUnit of the product; for example, kilograms, liters, or cases. This field comes with only onevalue, Each, so you may want to create your own. The QuantityUnitOfMeasure fieldon ProductItem inherits this field’s values.

Typestring

StockKeepingUnit

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe SKU for the product. Use in tandem with or instead of the ProductCode field. Forexample, you can track the manufacturer’s identifying code in the Product Code field andassign the product a SKU when you resell it.

193

Intelligent SalesHealth Cloud Developer Guide

Page 198: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Product2FeedFeed tracking is available for the object.

Product2HistoryHistory is available for tracked fields of the object.

PricebookentryRepresents a product entry (an association between a price book and product) in a price book.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), update(), upsert()

Fields

DetailsField

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this price book entry is active.

Typeboolean

IsArchived

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the price book entry has been archived (true) or not (false). This is set totrue when the product record it’s associated with is archived, or when the price bookrecord is archived. This field is read only. Available in API version 45.0 and later. Label isArchived.

Typestring

Name

PropertiesFilter, Group, Nillable, Sort

DescriptionName of this price book entry record. This read-only field references the value in the Namefield of the product record. Label is Product Name.

194

Intelligent SalesHealth Cloud Developer Guide

Page 199: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

Pricebook2Id

PropertiesCreate, Filter, Group, Sort

DescriptionRequired. ID of the price book record with which this record is associated. This field must bespecified when creating price book records. It can’t be changed in an update.

Typereference

Product2Id

PropertiesCreate, Filter, Group, Sort

DescriptionRequired. ID of the product record with which this record is associated. This field must bespecified when creating product records. It can’t be changed in an update.

Typestring

ProductCode

PropertiesFilter, Group, Nillable, Sort

DescriptionProduct code for this record. This read-only field references the value in the ProductCodefield of the associated product record.

Typecurrency

UnitPrice

PropertiesCreate, Filter, Sort, Update

DescriptionRequired. Unit price for this price book entry. You can specify a value only ifUseStandardPrice is set to false. Label is List Price.

Typeboolean

UseStandardPrice

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this price book entry uses the standard price defined in the standard pricebook record.

195

Intelligent SalesHealth Cloud Developer Guide

Page 200: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

UsageUse this object to define the association between your organization’s products (product) and your organization’s standard price bookor to other, custom-defined price books ( price book). Create one PricebookEntry record for each standard or custom price and currencycombination for a product in a price book.

When creating these records, you must specify the IDs of the associated price book record and product record. Once created, your clientapplication can’t update these IDs.

This object is defined only for those organizations that have products enabled as a feature.

If you delete a PriceBookEntry while a line item references it, the line item is unaffected, but the PriceBookEntry will be archived andunavailable from the API. Deleted PriceBookEntry records can’t be recovered.

You must load the standard price for a product before you are permitted to load its custom price(s).

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

PricebookEntryHistoryHistory is available for tracked fields of the object.

ProductFulfillmentLocationAssociates a business account and a product inventory with the responsible field rep. This object is available in API version 49.0 and later.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe business account a field rep is responsible for visiting.

Typereference

FulfillmentLocationId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe inventory location from which an order will be fulfilled.

196

Intelligent SalesHealth Cloud Developer Guide

Page 201: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typereference

LocationId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location of the account the field rep visits.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the Product Fulfillment Location record.

Typereference

ProductId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe name of the product the field rep fulfills at the account.

Typereference

UserId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe field rep responsible for the account and inventory.

197

Intelligent SalesHealth Cloud Developer Guide

Page 202: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

ProductItemRepresents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse.

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

Special Access RulesField Service Lightning must be enabled.

Fields

DetailsField Name

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe date when the product item was last modified. Its label in the user interfaceis Last Modified Date.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe date when the product item was last viewed.

Typereference

LocationId

PropertiesCreate, Filter, Group, Sort

DescriptionLocation associated with the product item. This usually indicates where theproduct item is stored.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

198

Intelligent SalesHealth Cloud Developer Guide

Page 203: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe product item’s owner.

Typereference

Product2Id

PropertiesCreate, Filter, Group, Sort

DescriptionProduct associated with the product item, which represents the type of productin your inventory.

Typestring

ProductItemNumber

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

Description(Read Only) Auto-generated number identifying the product item.

Typestring

ProductName

PropertiesFilter, Group, Nillable, Sort

DescriptionA name for the product item. Try to select a name that indicates what is beingstored where; for example, Batteries in Warehouse A.

Typedouble

QuantityOnHand

PropertiesCreate, Filter, Sort, Update

DescriptionThe quantity at the location. If you want to add a serial number, this value mustbe 1.

Typepicklist

QuantityUnitOfMeasure

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUnits of the product item; for example, kilograms or liters. Quantity Unit of Measurepicklist values are inherited from the Quantity Unit of Measure field on products.

199

Intelligent SalesHealth Cloud Developer Guide

Page 204: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

SerialNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA unique number for identification purposes. If you want to enter a serial number,the Quantity on Hand must be 1.

UsageEach product item is associated with a product and a location in Salesforce. If a product is stored at multiple locations, the product willbe tracked in a different product item for each location.

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

ProductItemFeedFeed tracking is available for the object.

ProductItemHistoryHistory is available for tracked fields of the object.

ProductItemOwnerSharingRuleSharing rules are available for the object.

ProductItemShareSharing is available for the object.

productrequiredRepresents a product that is needed to complete a visit.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

Fields

DetailsField

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

200

Intelligent SalesHealth Cloud Developer Guide

Page 205: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe date when the product required was last modified. Its label in the user interface is LastModified Date.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe date when the product required was last viewed.

Typereference

ParentRecordId

PropertiesCreate, Filter, Group, Sort

DescriptionThe work order or work order line item that the product is required for.

Typestring

ParentRecordType

PropertiesFilter, Group, Nillable, Sort

DescriptionIndicates whether the parent record is a work order or a work order line item.

Typereference

Product2Id

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe required product.

Typestring

ProductName

PropertiesFilter, Group, Nillable, Sort

DescriptionThe name of the product required.

Typestring

ProductRequiredNumber

201

Intelligent SalesHealth Cloud Developer Guide

Page 206: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

Description(Read only) Auto-generated number identifying the product required.

Typedouble

QuantityRequired

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionQuantity required of the product.

Typepicklist

QuantityUnitOfMeasure

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUnits of the required product

UsageRequired products can be added to work types, work orders, and work order line items to ensure that the assigned service resourcearrives with the right equipment.

Adding required products to work types saves you time and keeps your business processes consistent. Work orders and work order lineitems inherit their work type’s required products. For example, if all light bulb replacement jobs require a ladder and a light bulb, addthe ladder and light bulb as required products to your Light Bulb Replacement work type. When it’s time to create a work order for acustomer’s light bulb replacement, applying that work type to the work order adds the required products.

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

ProductRequiredFeedFeed tracking is available for the object.

ProductRequiredHistoryHistory is available for tracked fields of the object.

producttransferRepresents the transfer of inventory between locations in field service.

202

Intelligent SalesHealth Cloud Developer Guide

Page 207: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionDetails not recorded in the provided fields.

Typereference

DestinationLocationId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe place the product is to be delivered.

TypedateTime

ExpectedPickupDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date that the transfer is being requested for.

Typeboolean

IsReceived

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionCheckbox identifying that the product was received.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe date when the product request was last modified. Its label in the user interface is LastModified Date.

203

Intelligent SalesHealth Cloud Developer Guide

Page 208: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe date when the product request was last viewed.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionOwner of the product transfer.

Typereference

Product2Id

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup field for the product associated with the product transfer.

Typestring

ProductTransferNumber

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionAn auto-assigned number that identifies the product transfer.

Typedouble

QuantityReceived

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAmount of product received at the destination location.

Typedouble

QuantitySent

PropertiesCreate, Filter, Sort, Update

DescriptionAmount of product that’s being requested.

204

Intelligent SalesHealth Cloud Developer Guide

Page 209: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

QuantityUnitOfMeasure

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe units of the product, for example grams, liters, or units.

Typereference

ReceivedById

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup field for the person who received the product at the destination location.

TypedateTime

ShipmentExpectedDeliveryDate

PropertiesFilter, Nillable, Sort

DescriptionThe date for which the transfer is being accepted..

Typereference

SourceLocationId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReference to the location of the inventory making the transfer.

Typereference

SourceProductItemId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReference to the inventory making the transfer.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the transfer request.

205

Intelligent SalesHealth Cloud Developer Guide

Page 210: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Possible values are:

• Accepted

• Rejected

• Requested

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

ProductTransferFeedFeed tracking is available for the object.

ProductTransferHistoryHistory is available for tracked fields of the object.

ProductTransferOwnerSharingRuleSharing rules are available for the object.

ProductTransferShareSharing is available for the object.

RecordActionRepresents a relationship between a record and an action, such as a flow. Create a RecordAction for every action that you want toassociate with a particular record. Available in API version 42.0 and later.

Note: Access to the RecordAction object is determined by a user’s access to the associated parent record.

Supported Callscreate(), delete(), , describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),undelete(), update(), upsert()

Fields

DetailsField

Typepicklist

ActionDefinition

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionRequired in Lightning Flow for Service implementations that use version 44.0 or later of theAPI. The API name of the action to associate with the record; for example, the API name ofa flow. Use this field rather than FlowDefinition. To distinguish a quick action from a flowwith the same API name, we prepend "QuickAction" to the API name of every quick action.

206

Intelligent SalesHealth Cloud Developer Guide

Page 211: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

ActionType

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionRequired in Lightning Flow for Service implementations that use version 46.0 or later of theAPI. The type of action. Possible values are:

• Flow (default)

• QuickAction

For versions of the API prior to version 46.0, this field is set to Flow.

Typepicklist

FlowDefinition

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionOptional in Lightning Flow for Service implementations using version 42.0 or 43.0 of the API.An upgrade to Winter '19 or later, which uses API version 44.0 or later, copies FlowDefinitionto ActionDefinition. For versions 42.0 and 43.0, this field is the API name of the flow that’sassociated with the record.

Typereference

FlowInterviewId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionOptional. The flow interview ID of the paused or completed flow. This field can’t be set inProcess Builder.

Typeboolean

IsMandatory

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionOptional. Specifies whether the action is mandatory. The default value is false.

Note: At runtime, we show a reminder when the user closes a mandatory flowwithout completing it. We don't show the reminder for quick actions.

Typeboolean

IsUiRemoveHidden

207

Intelligent SalesHealth Cloud Developer Guide

Page 212: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionOptional. Specifies whether the ability to remove the action is hidden in the UI. The defaultvalue is false. If true, the UI hides the ability to remove the action. However, actions can stillbe deleted using the API.

Typeint

Order

PropertiesCreate, Filter, Group, Sort, Update

DescriptionRequired. The order of the action among all actions associated with this record.

Typepicklist

Pinned

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionRequired. Specifies whether the action is pinned to the top or bottom of the component. Ifan action is pinned, users see the Remove option in the UI unless IsUiRemoveHiddenis set to true. Possible values are:

• None (default)

• Top

• Bottom

Typereference

RecordId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionRequired. Record associated with the action. In version 46.0 and above, we support mostobject types. To learn about supported objects, see the Lightning Flow for Service Developer’sGuide.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionRequired. The current state of the action. Possible values are:

• New (default)

208

Intelligent SalesHealth Cloud Developer Guide

Page 213: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Paused

• Complete

• Started

• Unlinked—The action was unlinked because the flow was paused and the currentrecord for the flow interview changed.

Paused and unlinked statuses do not apply to quick actions. This field can’t be set in ProcessBuilder.

UsageThe RecordAction object works with the Actions & Recommendations component in Lightning Experience. Although this junction objectcan be used to create relationships between records and actions in Salesforce Classic, those relationships can’t be displayed in SalesforceClassic.

Note: API version 44.0 added a field, ActionDefinition, so that a RecordAction in future releases can support other types of actionsin addition to flows. API version 44.0 and later maintain the FlowDefinition field to support processes that reference this field inearlier API versions. Upgrading an org to Winter '19 or later, which uses API version 44.0 or later, copies the FlowDefinition field tothe ActionDefinition field. FlowDefinition will be deprecated in a future release, so use ActionDefinition instead.

When an action is deleted that’s referenced in an ActionDefinition or FlowDefinition, the RecordAction object is deleted. RecordActionobjects are also deleted when the associated parent record is deleted, or when a flow is paused and the current record context haschanged. When an action is completed, the associated RecordAction object is also deleted.

Deleted RecordActions are removed from the list when the page is refreshed.

For more information about the Actions & Recommendations component and how it works with RecordActions, see the Lightning Flowfor Service Developer Guide.

Java ExampleHere’s an example of how to associate flows to a record using the RecordAction object.

public void associateNewCustomerFlowWithAccount(Account a) {try {

RecordAction newRecordAction = new RecordAction();newRecordAction.setRecordId(a.getId());newRecordAction.setActionDefinition(“New_Customer_Flow”);newRecordAction.setOrder(1);

SaveResult[] results = connection.create(new SObject[] { newRecordAction });

} catch (ConnectionException ce) {ce.printStackTrace();

}}

Data Model

209

Intelligent SalesHealth Cloud Developer Guide

Page 214: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

RecordActionHistoryHistory is available for tracked fields of the object.

VisitTrack information related to a field rep’s visit to a hospital account where they perform surgical visits. This object is available in API version47.0 and later, but is available in Health Cloud from API version 49.0.

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

Fields

DetailsField

Typereference

AccountId

210

Intelligent SalesHealth Cloud Developer Guide

Page 215: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe account that is associated with a visit.

TypedateTime

ActualVisitEndTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date and time when the visit ended.

TypedateTime

ActualVisitStartTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date and time when the visit started.

Typetextarea

InstructionDescription

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionSpecial instructions provided by a sales manager or an admin that a sales rep refers to duringa visit.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

211

Intelligent SalesHealth Cloud Developer Guide

Page 216: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionUnique identifier for the visit record.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the visit record owner.

Typereference

PlaceId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionID of the place that sales reps visit.

TypedateTime

PlannedVisitEndTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date and time when the visit is expected to end.

TypedateTime

PlannedVisitStartTime

PropertiesCreate, Filter, Sort, Update

DescriptionThe date and time when the visit is expected to start.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

DescriptionThe status of a visit.

212

Intelligent SalesHealth Cloud Developer Guide

Page 217: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Possible values are:

• Abandoned

• Completed

• InProgress

• Planned

Typetextarea

StatusRemarks

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe reasons for abandoning or completing the visit as provided by the sales rep.

Typepicklist

VisitPriority

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe priority of the visit.

Possible values are:

• High

• Low

• Medium

Typereference

VisitorId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the sales representative visiting the store.

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

• VisitShare on page 629

• VisitFeed on page 616

VisitedPartyRepresents the contact person at the account that’s being visited. This object is available in API version 49.0 and later.

213

Intelligent SalesHealth Cloud Developer Guide

Page 218: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

ContactId

PropertiesCreate, Filter, Group, Sort

DescriptionLookup to the person assigned as the contact at an account. This field references theContact object.

Typeboolean

IsPrimaryContact

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the person is the primary visited party.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the visited party.

214

Intelligent SalesHealth Cloud Developer Guide

Page 219: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

VisitId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the Visit record this person is associated with.

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

VisitedPartyHistoryHistory is available for the object.

VisitedPartyFeedFeed tracking is available for the object.

VisitorRepresents the sales reps performing visits. This object is available in API version 49.0 and later.

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

Fields

DetailsField

Typereference

AssigneeId

PropertiesCreate, Filter, Group, Sort

DescriptionLookup to the person assigned as the visitor. This fields references the User,ServiceResource, and Contact objects.

Typeboolean

IsPrimaryResource

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the visitor is the primary visitor for a visit.

215

Intelligent SalesHealth Cloud Developer Guide

Page 220: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsRequired

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the user is a required visitor for the visit.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the visitor.

Typereference

VisitId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to the Visit record this visitor is associated with.

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

VisitorHistoryHistory is available for the object.

216

Intelligent SalesHealth Cloud Developer Guide

Page 221: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

VisitorFeedFeed tracking is available for the object.

Social Determinants

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

The social determinants data model represents the barriers, health determinants, and interventionsfor a patient or member. Available in API version 45.0 and later.

You must have the Health Cloud managed package installed in your org to add the socialdeterminants data model.

The social determinants standard objects are visible to users with the Health Cloud and the HealthCloud Platform permission set licenses and the Health Cloud Permission Set License and HealthCloud Social Determinants permission sets.

CareBarrier

Represents the circumstances or obstacles affecting a patient or member. Available in API version 45.0 and later.

CareBarrierDeterminant

Represents the relationship of a barrier to a determinant for a patient or member. Available in API version 45.0 and later.

CareBarrierType

Represents the standard, defined list of barriers maintained by an organization. Available in API version 45.0 and later.

217

Social DeterminantsHealth Cloud Developer Guide

Page 222: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDeterminant

Represents the determinants of health for a patient such as availability of safe housing, adequate employment, or local food markets.Available in API version 45.0 and later.

CareDeterminantType

Represents the standard, defined list of determinants of health maintained by an organization, including the domain and type.Available in API version 45.0 and later.

CareInterventionType

Represents the standard, defined list of interventions maintained by an organization. Available in API version 45.0 and later.

CareBarrierRepresents the circumstances or obstacles affecting a patient or member. Available in API version 45.0 and later.

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

Fields

DetailsField Name

Typereference

CareBarrierTypeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionIdentifier for the care barrier type for the patient or member.

Typereference

CaseId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the associated case.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which the barrier becomes effective.

Typedate

EffectiveTo

218

Social DeterminantsHealth Cloud Developer Guide

Page 223: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for the barrier.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this barrier is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the barrier.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

219

Social DeterminantsHealth Cloud Developer Guide

Page 224: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe ID of the user who owns this record.

Typereference

PatientId

PropertiesCreate, Filter, Group, Sort

DescriptionIdentifier for the patient or member.

Typepicklist

Priority

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionPriority of the barrier such as Low or High.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionStatus of the barrier such as Open or Addressed.

Typereference

SurveyResponseId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier for the survey response related to the barrier.

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

CareBarrierFeedFeed tracking is available for the object.

CareBarrierHistoryHistory is available for tracked fields of the object.

CareBarrierOwnerSharingRuleSharing rules are available for the object.

220

Social DeterminantsHealth Cloud Developer Guide

Page 225: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareBarrierShareSharing is available for the object.

CareBarrierDeterminantRepresents the relationship of a barrier to a determinant for a patient or member. Available in API version 45.0 and later.

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

Fields

DetailsField Name

Typereference

CareBarrierId

PropertiesCreate, Filter, Group, Sort

Description

ID of the care barrier associated with this record.

Typereference

CareDeterminantId

PropertiesCreate, Filter, Group, Sort, Update

Description

ID of the care determinant associated with this record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

Description

The timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

221

Social DeterminantsHealth Cloud Developer Guide

Page 226: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Description

The timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup. Sort, Update

Description

The name of the relationship between the barrier and the determinant. Forexample, Mold growth in home - Housing.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

Description

The ID of the user who owns this record.

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

CareBarrierDeterminantFeedFeed tracking is available for the object.

CareBarrierDeterminantHistoryHistory is available for tracked fields of the object.

CareBarrierDeterminantOwnerSharingRuleSharing rules are available for the object.

CareBarrierDeterminantShareSharing is available for the object.

CareBarrierTypeRepresents the standard, defined list of barriers maintained by an organization. Available in API version 45.0 and later.

Supported CallsdescribeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

222

Social DeterminantsHealth Cloud Developer Guide

Page 227: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

Typestring

Code

PropertiesCreate, Filter, Group, Nillable, Sort

DescriptionMedical vocabulary code for the barrier.

Typepicklist

CodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMedical vocabulary code type for the barrier.

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionDescription of the barrier.

Typereference

HealthCareDiagnosisId

PropertiesCreate,Filter, Group Nillable, Sort, Update

DescriptionDiagnosis code for the barrier.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this care barrier type is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

223

Social DeterminantsHealth Cloud Developer Guide

Page 228: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the care barrier type.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

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

CareBarrierTypeFeedFeed tracking is available for the object.

CareBarrierTypeHistoryHistory is available for tracked fields of the object.

CareBarrierTypeOwnerSharingRuleSharing rules are available for the object.

CareBarrierTypeShareSharing is available for the object.

224

Social DeterminantsHealth Cloud Developer Guide

Page 229: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDeterminantRepresents the determinants of health for a patient such as availability of safe housing, adequate employment, or local food markets.Available in API version 45.0 and later.

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

Fields

DetailsField Name

Typereference

CareDeterminantTypeId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionCare determinant for the patient or member.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this care determinant is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

225

Social DeterminantsHealth Cloud Developer Guide

Page 230: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the care determinant.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PatientId

PropertiesCreate, Filter, Group, Sort

DescriptionIdentifier for the patient or member.

Typepicklist

Priority

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionPriority of the determinant such as Low or High.

Typereference

SurveyResponseId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSurvey response related to the determinant.

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

CareDeterminantFeedFeed tracking is available for the object.

226

Social DeterminantsHealth Cloud Developer Guide

Page 231: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDeterminantHistoryHistory is available for tracked fields of the object.

CareDeterminantOwnerSharingRuleSharing rules are available for the object.

CareDeterminantShareSharing is available for the object.

CareDeterminantTypeRepresents the standard, defined list of determinants of health maintained by an organization, including the domain and type. Availablein API version 45.0 and later.

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

Fields

DetailsField Name

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionDescription of the determinant.

Typepicklist

Domain

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe domain for the determinant. such as Housing or Transportation.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this care determinant type is active.

TypedateTime

LastReferencedDate

227

Social DeterminantsHealth Cloud Developer Guide

Page 232: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the care determinant type.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typepicklist

Type

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe type of determinant.

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

CareDeterminantTypeFeedFeed tracking is available for the object.

228

Social DeterminantsHealth Cloud Developer Guide

Page 233: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDeterminantTypeHistoryHistory is available for tracked fields of the object.

CareDeterminantTypeOwnerSharingRuleSharing rules are available for the object.

CareDeterminantTypeShareSharing is available for the object.

CareInterventionTypeRepresents the standard, defined list of interventions maintained by an organization. Available in API version 45.0 and later.

Supported CallsdescribeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

Fields

DetailsField Name

Typetextarea

Code

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMedical vocabulary code for the intervention.

Typepicklist

CodeType

PropertiesCreate, Defaulted on Create, Filter, Group, Nillable, Sort, Update

DescriptionMedical vocabulary code type for the intervention.

Typereference

Description

PropertiesCreate, Nillable, Update

DescriptionDescription of the intervention.

Typereference

HealthCareProcedureId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

229

Social DeterminantsHealth Cloud Developer Guide

Page 234: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionProcedure code for the intervention.

Typepicklist

InterventionType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of intervention.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this intervention type is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the intervention type.

230

Social DeterminantsHealth Cloud Developer Guide

Page 235: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

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

CareInterventionTypeFeedFeed tracking is available for the object.

CareInterventionTypeHistoryHistory is available for tracked fields of the object.

CareInterventionTypeOwnerSharingRuleSharing rules are available for the object.

CareInterventionTypeShareSharing is available for the object.

Provider Relationship Management

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

Manage your network of provider partners and help your members or patients find care that fitstheir needs.

The provider management standard objects are available to users with the Health Cloud and theHealth Cloud Platform permission set licenses and the Health Foundation permission set. You musthave the Health Cloud managed package installed in your org to access the provider managementdata model. Available in API version 47.0 and later.

231

Provider Relationship ManagementHealth Cloud Developer Guide

Page 236: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Provider Relationship Management Overview

Use the Health Cloud provider relationship management data model along with standard Salesforce objects to manager your networkof providers.

Accreditation

Represents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute carehospital.

Award

Represents a person's or organization's professional awards.

BoardCertification

Represents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease.

BusinessLicense

Represents the licenses of a party role like healthcare provider or producer.

CareProviderFacilitySpecialty

Represents all the locations where a practitioner provides services.

CareSpecialty

Represents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery.

CareTaxonomy

Represents a static list of taxonomy codes.

232

Provider Relationship ManagementHealth Cloud Developer Guide

Page 237: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthcareFacilityNetwork

Represents a junction object identifying the insurance network that a location or business entity is a part of.

HealthcarePayerNetwork

Represents an insurance network group. For example, an insurance company’s exclusive provider organization (EPO) plans.

HealthcarePractitionerFacility

Represents the different locations in which a practitioner provides services.

HealthcareProvider

Represents business-level details about the healthcare organization or the practitioner.

HealthcareProviderNpi

Represents identifiers from the National Provider Identifier that are assigned to every facility and licensed practitioner in the UnitedStates. Also includes NPI assigned date, primary mailing address on file, and so on.

HealthcareProviderSpecialty

Represents specialties for a practitioner or a provider service organization. A provider can have multiple specialties such asanesthesiology and cardiovascular.

HealthcareProviderTaxonomy

Represents taxonomy or subspecialty codes for a practitioner or facility. A provider or facility can have multiple taxonomies.

PersonEducation

Represents information about professional education for a person in a party role.

CareProviderAdverseAction

This object captures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is availablein API version 47.0 and later.

CareProviderSearchableField

This object holds denormalized data from certain fields in the Provider data model. Provider search APIs query this object instead ofmultiple objects, which improves search performance. This object is available in API version 47.0 and later.

CareProviderSearchConfig

Represents fields that can appear in provider search results. Use this object to specify fields in arbitrary objects (source) that are madeavailable in the search object (target). This object is available in API version 48.0 and later.

Provider Relationship Management OverviewUse the Health Cloud provider relationship management data model along with standard Salesforce objects to manager your networkof providers.

The provider management data model represents the practitioners, facilities, physician relationships, specialties, and organizationalhierarchy for your network of providers.

• Physician and organization affiliations, such as hospitals where the physician has attending or admitting privileges

• Practicing locations and specialties offered by a practitioner at a location

• Practice administrators for healthcare facilities

• Operating hours for facilities or practitioner's hours at a particular facility

• Specialty and taxonomy attributes of a practitioner or facility

• National Provider Identifier (NPI) and other provider identifiers

• Insurance payer and plan networks

• Practitioner license, education, board certifications, awards, and accreditation information

233

Provider Relationship ManagementHealth Cloud Developer Guide

Page 238: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Provider information is also represented using existing standard Salesforce objects in addition to objects only available through HealthCloud.

• Account: Represents a healthcare facility or location. The account hierarchy represents the way the healthcare system is organized.Other companies, like billing companies for physicians or healthcare facilities are represented as accounts and connected to healthcarefacilities or physicians using account-account or account-contact relationships.

• Contact: Represents physicians and other licensed practitioners. Other professionals, such as nurses are represented using a contactrecord and connected to the physician using the contact-contact relationships.

• Account Contact Relationship: Represents physician and health system business affiliations, such as attending and admitting privileges.

• Person Education: Represents the educational details of a physician or licensed practitioner.

• Identity Document: Represents all identifiers for a practitioner or facility, other than the NPI.

• Location: Represents more details of a healthcare location, such as a clinic.

• Associated Location: Represents the junction between an account and a location.

• Operating Hours: Represents the hours that a facility is open.

• Time Slot: Represents a range of time on a specified day of the week during which healthcare work can be performed. Operatinghours consist of one or more time slots.

AccreditationRepresents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute care hospital.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHealthcare facility (Account) that this accreditation is associated with.

Typepicklist

AccreditationRating

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRating system used by the accrediting body.

234

Provider Relationship ManagementHealth Cloud Developer Guide

Page 239: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

AccreditingBody

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization that provided the accreditation.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this accreditation is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this accreditation is no longer effective.

Typedate

LastFullSurveyDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate of the last full survey completed by accrediting body.

Typedate

LastOnsiteSurveyDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate that accrediting body was last onsite.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

235

Provider Relationship ManagementHealth Cloud Developer Guide

Page 240: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the accreditation.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner that this accreditation is associated with.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

236

Provider Relationship ManagementHealth Cloud Developer Guide

Page 241: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccreditation status.

Typepicklist

SubType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSubtype of the accreditation.

Typepicklist

Type

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of accreditation.

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

AccreditationFeedFeed tracking is available for the object.

AccreditationHistoryHistory is available for tracked fields of the object.

AccreditationOwnerSharingRuleSharing rules are available for the object.

AccreditationShareSharing is available for the object.

AwardRepresents a person's or organization's professional awards.

237

Provider Relationship ManagementHealth Cloud Developer Guide

Page 242: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the organization receiving the award.

TypedateTime

AwardDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate award was received.

Typestring

AwardedBy

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the issuing organization.

Typereference

ContactId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPerson who received the award and is listed as a contact.

Typestring

Identifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIssuing organization's identifier for the award recipient.

238

Provider Relationship ManagementHealth Cloud Developer Guide

Page 243: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionAward name.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the user who owns this record.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAward status. Example values:

239

Provider Relationship ManagementHealth Cloud Developer Guide

Page 244: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Inactive

• Revoked

• Draft

• Verified

Typereference

UserId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the person who received the award and is listed as a user.

Typepicklist

VerificationStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCurrent award status. Example values:

• Authorized

• Pending

• Unverified

TypedateTime

VerifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAward was validated on this date.

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

AwardFeedFeed tracking is available for the object.

AwardHistoryHistory is available for tracked fields of the object.

AwardOwnerSharingRuleSharing rules are available for the object.

AwardShareSharing is available for the object.

240

Provider Relationship ManagementHealth Cloud Developer Guide

Page 245: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

BoardCertificationRepresents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount that this healthcare provider is associated with.

Typestring

BoardName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the organization providing the board certification.

Typepicklist

CertificationType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of certification.

Typedate

CurrentCertificationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate of most recent board certification.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

241

Provider Relationship ManagementHealth Cloud Developer Guide

Page 246: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe date from which this certification is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this certification is no longer effective.

Typedate

ExpirationDate

PropertiesCreate, Filter, Group, Nillable, Update

DescriptionExpiration date of the board certification.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the provider.

Typereference

OwnerId

242

Provider Relationship ManagementHealth Cloud Developer Guide

Page 247: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner that this certification is associated with.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionStatus of the certification.

Typedate

TerminationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for this provider.

Typestring

TerminationReason

243

Provider Relationship ManagementHealth Cloud Developer Guide

Page 248: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason for termination.

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

BoardCertificationFeedFeed tracking is available for the object.

BoardCertificationHistoryHistory is available for tracked fields of the object.

BoardCertificationOwnerSharingRuleSharing rules are available for the object.

BoardCertificationShareSharing is available for the object.

BusinessLicenseRepresents the licenses of a party role like healthcare provider or producer.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the organization holding the license.

Typereference

ContactId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

244

Provider Relationship ManagementHealth Cloud Developer Guide

Page 249: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the person who holds the license and is listed as a contact.

Typestring

Identifier

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionIssuer's ID for the licensee.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the license is active.

Typestring

Issuer

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLicense issuer's name.

Typestring

JurisdictionCountry

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCountry where license is valid.

Typestring

JurisdictionOther

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of other jurisdiction.

Typestring

JurisdictionState

PropertiesCreate, Filter, Group, Nillable, Sort, Update

245

Provider Relationship ManagementHealth Cloud Developer Guide

Page 250: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionState where license is valid.

Typepicklist

JurisdictionType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionJurisdiction for the license. Example values:

• State

• County

• Province

• Country

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typepicklist

LicenseClass

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe class that the distributor’s license belongs to. This field is available from API version 48.0and later.

Possible values are:

• Insurance Producer

• Managing General Agent

• Public Adjuster

246

Provider Relationship ManagementHealth Cloud Developer Guide

Page 251: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

LineOfAuthority

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe line of authority that the distributor is licensed for. This field is available from API version48.0 and later.

Possible values are:

• Accident & Health or Sickness

• Casualty

• Property

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionName of the business or professional license.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

TypedateTime

PeriodEnd

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionLicense's expiration date.

TypedateTime

PeriodStart

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionLicense's effective start date.

247

Provider Relationship ManagementHealth Cloud Developer Guide

Page 252: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

ResidenceStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionResidence status of the producer. This field is available from API version 48.0 and later.

Possible values are:

• Non-resident

• Resident

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCurrent status of the license. Example values:

• Inactive

• Revoked

• Draft

• Verified

Typereference

UserId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPerson who holds the license and is listed as a user.

Typepicklist

VerificationStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCurrent status for the license. Example values:

• Authorized

• Pending

• Unverified

Typedate

VerifiedDate

248

Provider Relationship ManagementHealth Cloud Developer Guide

Page 253: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLicense was validated on this date.

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

BusinessLicenseFeedFeed tracking is available for the object.

BusinessLicenseHistoryHistory is available for tracked fields of the object.

BusinessLicenseOwnerSharingRuleSharing rules are available for the object.

BusinessLicenseShareSharing is available for the object.

CareProviderFacilitySpecialtyRepresents all the locations where a practitioner provides services.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFacility associated with this provider facility specialty record.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

249

Provider Relationship ManagementHealth Cloud Developer Guide

Page 254: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe date from which this record is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this record is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

Typeboolean

IsPrimarySpecialty

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this specialty is the practitioner's primary specialty at this facility, or thefacility's primary specialty.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

250

Provider Relationship ManagementHealth Cloud Developer Guide

Page 255: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the specialty provided at this provider facility.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerFacilityId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner facility associated with this provider facility specialty record.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typereference

SpecialtyId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifies the specialty associated with this provider facility specialty record

Typepicklist

SpecialtyRole

251

Provider Relationship ManagementHealth Cloud Developer Guide

Page 256: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRole of the specialty for the provider or practitioner.

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

CareProviderFacilitySpecialtyFeedFeed tracking is available for the object.

CareProviderFacilitySpecialtyHistoryHistory is available for tracked fields of the object.

CareProviderFacilitySpecialtyOwnerSharingRuleSharing rules are available for the object.

CareProviderFacilitySpecialtyShareSharing is available for the object.

CareSpecialtyRepresents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery.

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

Fields

DetailsField

Typestring

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

DescriptionDescription of the specialty.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this specialty is effective.

252

Provider Relationship ManagementHealth Cloud Developer Guide

Page 257: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this specialty is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the specialty master record.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

253

Provider Relationship ManagementHealth Cloud Developer Guide

Page 258: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe ID of the user who owns this record.

Typestring

SpecialtyCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode for the specialty.

Typepicklist

SpecialtyType

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionType of care specialty.

Typepicklist

SpecialtyUsage

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether this speciality is related to the practitioner, the organization, or both.

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

CareSpecialtyFeedFeed tracking is available for the object.

CareSpecialtyHistoryHistory is available for tracked fields of the object.

CareSpecialtyOwnerSharingRuleSharing rules are available for the object.

CareSpecialtyShareSharing is available for the object.

CareTaxonomyRepresents a static list of taxonomy codes.

254

Provider Relationship ManagementHealth Cloud Developer Guide

Page 259: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typestring

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the taxonomy.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this taxonomy is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this taxonomy is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

255

Provider Relationship ManagementHealth Cloud Developer Guide

Page 260: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the taxonomy master record.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

TaxonomyCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode for the taxonomy.

Typepicklist

TaxonomyType

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionType of taxonomy.

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

CareTaxonomyFeedFeed tracking is available for the object.

256

Provider Relationship ManagementHealth Cloud Developer Guide

Page 261: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareTaxonomyHistoryHistory is available for tracked fields of the object.

CareTaxonomyOwnerSharingRuleSharing rules are available for the object.

CareTaxonomyShareSharing is available for the object.

HealthcareFacilityNetworkRepresents a junction object identifying the insurance network that a location or business entity is a part of.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount associated with this facility network.

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionDescription of the facility network.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this facility network is effective.

Typedate

EffectiveTo

257

Provider Relationship ManagementHealth Cloud Developer Guide

Page 262: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this facility network is no longer effective.

Typepicklist

GenderRestriction

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether this facility network only applies to male or female patients or membersinstead of all patients or members.

Typeint

HighestValidAge

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates the highest age of patient that this facility network is applicable for.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

258

Provider Relationship ManagementHealth Cloud Developer Guide

Page 263: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeint

LowestValidAge

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates the lowest age of patient that this facility network is applicable for.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the facility network record.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typedouble

PanelLimit

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionIndicates the maximum number of patients in the practitioner's panel for this payer networkand practitioner location.

Typepicklist

PanelStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the practitioner is accepting new patients based on the status of theirpatient panel.

Typereference

PayerNetworkId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

259

Provider Relationship ManagementHealth Cloud Developer Guide

Page 264: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionPayer network associated with this facility network.

Typereference

PractitionerFacilityId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner facility associated with this facility network.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier for the associated practitioner.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

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

HealthcareFacilityNetworkFeedFeed tracking is available for the object.

HealthcareFacilityNetworkHistoryHistory is available for tracked fields of the object.

HealthcareFacilityNetworkOwnerSharingRuleSharing rules are available for the object.

260

Provider Relationship ManagementHealth Cloud Developer Guide

Page 265: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthcareFacilityNetworkShareSharing is available for the object.

HealthcarePayerNetworkRepresents an insurance network group. For example, an insurance company’s exclusive provider organization (EPO) plans.

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

Fields

DetailsField

Typestring

Code

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode representing the payer network.

Typetextarea

Description

PropertiesCreate, Nillable, Update

DescriptionDescription of the payer network.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this payer network is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this payer network is no longer effective.

261

Provider Relationship ManagementHealth Cloud Developer Guide

Page 266: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the payer network.

Typepicklist

NetworkType

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionType of network, such as HMO, PPO, or EPO.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

262

Provider Relationship ManagementHealth Cloud Developer Guide

Page 267: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe ID of the user who owns this record.

Typereference

PayerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe account associated with the payer network.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of an external record on its source system.

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

HealthcarePayerNetworkFeedFeed tracking is available for the object.

HealthcarePayerNetworkHistoryHistory is available for tracked fields of the object.

HealthcarePayerNetworkOwnerSharingRuleSharing rules are available for the object.

HealthcarePayerNetworkShareSharing is available for the object.

HealthcarePractitionerFacilityRepresents the different locations in which a practitioner provides services.

263

Provider Relationship ManagementHealth Cloud Developer Guide

Page 268: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount associated with this practitioner facility.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this practitioner facility is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this practitioner facility is no longer effective.

Typepicklist

GenderRestriction

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether physician sees patients of a specific gender.

Typedouble

HighestValidAge

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe highest age of patients that the practitioner sees at this facility

264

Provider Relationship ManagementHealth Cloud Developer Guide

Page 269: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

InitialStartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate the practitioner started at this facility.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

Typeboolean

IsDirectoryPrint

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this facility is displayed in an online or printed directory.

Typeboolean

IsPrimaryCarePhysician

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the practitioner provides primary care services at this facility.

Typeboolean

IsPrimaryFacility

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the facility is the primary facility for the practitioner.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

265

Provider Relationship ManagementHealth Cloud Developer Guide

Page 270: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typedouble

LowestValidAge

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe lowest age of patients that the practitioner sees at this facility.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the practitioner facility record.

Typereference

OperatingHoursId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifies the operating hours for this practitioner at this facility.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

266

Provider Relationship ManagementHealth Cloud Developer Guide

Page 271: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the practitioner associated with this facility.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of an external record on its source system.

Typedate

TerminationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate the practitioner stopped working at this facility.

Typepicklist

TerminationReasonCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason the practitioner facility is no longer current.

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

HealthcarePractitionerFacilityFeedFeed tracking is available for the object.

HealthcarePractitionerFacilityHistoryHistory is available for tracked fields of the object.

HealthcarePractitionerFacilityOwnerSharingRuleSharing rules are available for the object.

267

Provider Relationship ManagementHealth Cloud Developer Guide

Page 272: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthcarePractitionerFacilityShareSharing is available for the object.

HealthcareProviderRepresents business-level details about the healthcare organization or the practitioner.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount that this healthcare provider is associated with.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this provider is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this provider is no longer effective.

Typetextarea

EhrSystem

PropertiesCreate, Nillable, Update

DescriptionName of the EHR system used at this facility or organization.

268

Provider Relationship ManagementHealth Cloud Developer Guide

Page 273: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

InitialStartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate that the facility first became operational or the practitioner first started practicing.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the provider.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

269

Provider Relationship ManagementHealth Cloud Developer Guide

Page 274: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionPractitioner that this healthcare provider record is associated with.

Typepicklist

ProviderClass

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionClass of facility, such as an IPA, medical group, or solo practitioner.

Typepicklist

ProviderType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of provider or facility. For example, pharmacist or ambulatory care facility.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the record was sourced.

Typedate

TerminationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for this provider.

Typestring

TerminationReason

PropertiesCreate, Filter, Group, Nillable, Sort, Update

270

Provider Relationship ManagementHealth Cloud Developer Guide

Page 275: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionReason for termination.

Typeint

TotalLicensedBeds

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTotal number of licensed beds at this facility, if applicable.

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

HealthcareProviderFeedFeed tracking is available for the object.

HealthcareProviderHistoryHistory is available for tracked fields of the object.

HealthcareProviderOwnerSharingRuleSharing rules are available for the object.

HealthcareProviderShareSharing is available for the object.

HealthcareProviderNpiRepresents identifiers from the National Provider Identifier that are assigned to every facility and licensed practitioner in the United States.Also includes NPI assigned date, primary mailing address on file, and so on.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the facility that this NPI belongs to.

271

Provider Relationship ManagementHealth Cloud Developer Guide

Page 276: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this NPI is effective.

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this NPI is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

272

Provider Relationship ManagementHealth Cloud Developer Guide

Page 277: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionPractitioner or facility name as listed in the NPI database.

Typestring

Npi

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTen-digit identifier for a provider from the National Plan and Provider Enumeration System.

Typepicklist

NpiType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifies whether the NPI is for an individual or an organization.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the practitioner that this NPI belongs to.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

273

Provider Relationship ManagementHealth Cloud Developer Guide

Page 278: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the system from which the record was sourced.

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

HealthcareProviderNpiFeedFeed tracking is available for the object.

HealthcareProviderNpiHistoryHistory is available for tracked fields of the object.

HealthcareProviderNpiOwnerSharingRuleSharing rules are available for the object.

HealthcareProviderNpiShareSharing is available for the object.

HealthcareProviderSpecialtyRepresents specialties for a practitioner or a provider service organization. A provider can have multiple specialties such asanesthesiology and cardiovascular.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAccount associated with this specialty.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this provider specialty is effective.

274

Provider Relationship ManagementHealth Cloud Developer Guide

Page 279: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this provider specialty is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

Typeboolean

IsPrimarySpecialty

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the specialty is the provider's primary specialty.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

275

Provider Relationship ManagementHealth Cloud Developer Guide

Page 280: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionName of the provider’s specialty.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner associated with the specialty.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of an external record on its source system.

Typereference

SpecialtyId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCare specialty record associated with the provider.

Typepicklist

SpecialtyRole

PropertiesCreate, Filter, Group, Nillable, Sort, Update

276

Provider Relationship ManagementHealth Cloud Developer Guide

Page 281: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionRole of the specialty for the provider or practitioner.

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

HealthcareProviderSpecialtyFeedFeed tracking is available for the object.

HealthcareProviderSpecialtyHistoryHistory is available for tracked fields of the object.

HealthcareProviderSpecialtyOwnerSharingRuleSharing rules are available for the object.

HealthcareProviderSpecialtyShareSharing is available for the object.

HealthcareProviderTaxonomyRepresents taxonomy or subspecialty codes for a practitioner or facility. A provider or facility can have multiple taxonomies.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe business account associated with the provider taxonomy.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this taxonomy is effective.

277

Provider Relationship ManagementHealth Cloud Developer Guide

Page 282: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

EffectiveTo

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this taxonomy is no longer effective.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

Typeboolean

IsPrimaryTaxonomy

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the taxonomy is the provider's primary taxonomy.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

278

Provider Relationship ManagementHealth Cloud Developer Guide

Page 283: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionName of the provider taxonomy.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionContact record for the practitioner.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRecord ID in source system of provider directory.

Typereference

TaxonomyId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCare taxonomy record associated with the provider taxonomy.

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

279

Provider Relationship ManagementHealth Cloud Developer Guide

Page 284: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthcareProviderTaxonomyFeedFeed tracking is available for the object.

HealthcareProviderTaxonomyHistoryHistory is available for tracked fields of the object.

HealthcareProviderTaxonomyOwnerSharingRuleSharing rules are available for the object.

HealthcareProviderTaxonomyShareSharing is available for the object.

PersonEducationRepresents information about professional education for a person in a party role.

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

Fields

DetailsField

TypedateTime

CompletionDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionEducation's completion date.

Typereference

ContactId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the person who earned the degree and is listed as a contact.

Typepicklist

EducationLevel

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLevel of education achieved. Example values:

• Undergraduate degree

• Medical school

280

Provider Relationship ManagementHealth Cloud Developer Guide

Page 285: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Internship

• Residency

• Fellowship

TypedateTime

GraduationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionGraduation date from institution.

Typestring

Identifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID issued to the recipient by the educational institution.

Typestring

IdentifierIssuer

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEducational institution's name.

Typereference

IndividualId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the person who earned the degree and is listed as an individual.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the record is active.

TypedateTime

LastReferencedDate

281

Provider Relationship ManagementHealth Cloud Developer Guide

Page 286: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe most recent date on which a user viewed this record.

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the degree earned.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

TypedateTime

StartDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionEducation's start date.

Typepicklist

Status

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionCurrent status of education. Valid values:

• Inactive

• Revoked

282

Provider Relationship ManagementHealth Cloud Developer Guide

Page 287: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Draft

• Verified

The default value is Inactive.

Typereference

UserId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the person who earned the degree and is listed as a user.

Typepicklist

VerificationStatus

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionCurrent educational status. Valid values:

• Authorized

• None

The default value is None.

TypedateTime

VerifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionEducation was validated on this date.

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

PersonEducationFeedFeed tracking is available for the object.

PersonEducationHistoryHistory is available for tracked fields of the object.

PersonEducationOwnerSharingRuleSharing rules are available for the object.

PersonEducationShareSharing is available for the object.

283

Provider Relationship ManagementHealth Cloud Developer Guide

Page 288: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareProviderAdverseActionThis object captures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is available in APIversion 47.0 and later.

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

Fields

DetailsField

Typereference

AccountId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe account this adverse action is associated with.

Typereference

AccreditationId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe accreditation that might be affected by this adverse action.

Typepicklist

ActionType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of adverse action that is being taken.

Possible values are:

• AdministrativeDisciplinaryAction

• CourtOrder

• FelonyConviction

• MalpracticeJudgement

• MisdemeanorConviction

• ProbationaryLicense

Typereference

BoardCertificationId

284

Provider Relationship ManagementHealth Cloud Developer Guide

Page 289: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe board certification that might be affected by this adverse action

Typereference

BusinessLicenseId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe business license that might be affected by this adverse action.

Typestring

CaseNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe case number associated with this adverse action.

Typestring

CourtSentence

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe final sentence by the governing court, if any.

Typestring

Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSummary of the adverse action.

Typedate

EffectiveFrom

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date from which this Adverse Action is effective.

Typedate

EffectiveTo

285

Provider Relationship ManagementHealth Cloud Developer Guide

Page 290: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date on which this Adverse Action is no longer effective.

Typereference

HealthcareProviderId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHealthcareProvider that this Adverse Action is associated with

Typestring

Jurisdiction

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the court or goverment body that issued the legal determination.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionThe name of the adverse action that is being taken.

286

Provider Relationship ManagementHealth Cloud Developer Guide

Page 291: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionTime stamp that indicates when the current user last viewed this record.

Typereference

PractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe practitioner this adverse action record is associated with.

Typestring

ReportingEntity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the entity or organization that reported this action.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the record was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionUnique record ID in source system.

Typepicklist

Status

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the license or certification, such as "revoked" or "suspended."

287

Provider Relationship ManagementHealth Cloud Developer Guide

Page 292: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Possible values are:

• Active

• Revoked

• Suspended

CareProviderSearchableFieldThis object holds denormalized data from certain fields in the Provider data model. Provider search APIs query this object instead ofmultiple objects, which improves search performance. This object is available in API version 47.0 and later.

Supported Callsdelete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),search(), undelete()

Fields

DetailsField

Typetextarea

Address

PropertiesNillable

DescriptionSpecified in Account.ShippingAddress.

Typetextarea

CertificationType

PropertiesNillable

DescriptionSpecified in BoardCertification.CertificationType.

Note: BoardCertification.HealthcareProvider must also bespecified.

Typetextarea

EducationLevel

PropertiesNillable

DescriptionSpecified in PersonEducation.EducationLevel. Not applicable for a facility.

288

Provider Relationship ManagementHealth Cloud Developer Guide

Page 293: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Note: Degree, Status, DegreeEarner, and HealthCareProvidermust also be specified.

Typereference

Facility

PropertiesFilter, Group, Nillable, Sort

DescriptionRepresents the facility with which the practitioner is associated. Use for practitioner recordsonly. If the provider is a facility, this should be null.

Typestring

FacilityName

PropertiesFilter, Group, Nillable, Sort

DescriptionSpecified in Account.Name.

Typephone

FacilityPhone

PropertiesFilter, Group, Nillable, Sort

DescriptionFacility's main contact telephone number. Specified in Account.Phone.

Typeboolean

IsAcceptingNewPatients

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the practitioner is accepting new patients. Specified inHealthcareFacilityNetwork.PanelStatus, where PanelStatus =Open indicates Accepting New Patients = true.

Note: This field applies only to practitioners, not facilities.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

289

Provider Relationship ManagementHealth Cloud Developer Guide

Page 294: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

NationalProviderIdentifier

PropertiesFilter, Group, Nillable, Sort

DescriptionProvider’s unique NPI number. Specified in HealthcareProviderNpi.Accountfor a facility, and HealthcareProviderNpi.Practitioner for a practitioner.

Typereference

OperatingHours

PropertiesFilter, Group, Nillable, Sort

DescriptionIdentifies a set of operating hours for this practitioner at this facility. Specified inAccount.OperatingHours for a facility, or inHeathcarePractitionerFacility.OperatingHours for a practioner-facilitycombination. Hours must be specified in OperatingHours.

Typestring

PhotoUrl

PropertiesFilter, Group, Nillable, Sort

DescriptionThe URL for a photograph of the practitioner. Field is synced based onAccount-PhotoUrl or Contact.PhotoUrl.

Typetextarea

PlanType

PropertiesNillable

DescriptionThe type of plan, with the following default options:

• PPO

• HMO

290

Provider Relationship ManagementHealth Cloud Developer Guide

Page 295: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Medicare

• Medicaid

• Workers Comp

Specified in HealthcareFacilityNetwork.Account for a facility, orHealthcareFacilityNetwork.PractitionerFacility for apractitioner-facility combination.

Note: HealthcareFacilityNetwork.Name and PayerNetwork.Namemust also be populated.

Typereference

Provider

PropertiesFilter, Group, Nillable, Sort

DescriptionLookup to HealthcareProvider. Represents a facility or practitioner-facilitycombination.

Typestring

ProviderName

PropertiesFilter, Group, Nillable, Sort

DescriptionName of the provider. Specified in Account for a facility, or in Contact for a practitioner.

Typestring

ProviderType

PropertiesFilter, Group, Nillable, Sort

DescriptionType of provider or facility. For example, pharmacist or ambulatory care facility. Specified inHealthCareProvider.ProviderType.

Typetextarea

Specialty

PropertiesNillable

DescriptionSpecialty associated with the provider. Specified inCareProviderFacilitySpecialty.Account for a facility, orHealthCarePractitionerFacility.SpecialtyType for a practitioner.

Note: Specialty.SpecialtyType must also be specified.

291

Provider Relationship ManagementHealth Cloud Developer Guide

Page 296: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

SubSpecialty

PropertiesNillable

DescriptionProvider's subspecialty. Specified inHealthcareProviderTaxonomy.TaxonomyType. Not valid for apractitioner-facility combination.

Note: Taxonomy.TaxonomyType must also be specified.

CareProviderSearchConfigRepresents fields that can appear in provider search results. Use this object to specify fields in arbitrary objects (source) that are madeavailable in the search object (target). This object is available in API version 48.0 and later.

Supported Callscreate(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

DetailsField

Typestring

DeveloperName

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe unique name of the object in the API. This name can contain only underscores andalphanumeric characters, and must be unique in your org.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this configuration is active.

Typepicklist

Language

292

Provider Relationship ManagementHealth Cloud Developer Guide

Page 297: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe language that the care provider search uses.

Possible values are:

• da—Danish

• de—German

• en_US—English

• es—Spanish

• es_MX—Spanish (Mexico)

• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian

• pt_BR—Portuguese (Brazil)

• ru—Russian

• sv—Swedish

• th—Thai

• zh_CN—Chinese (Simplified)

• zh_TW—Chinese (Traditional)

Typepicklist

MappedObject

PropertiesCreate, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

DescriptionIndicates mapped objects.

Possible values are:

• HealthcarePractitionerFacility

• HealthcareProvider

Typestring

MasterLabel

PropertiesCreate, Filter, Group, Sort, Update

293

Provider Relationship ManagementHealth Cloud Developer Guide

Page 298: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe label for the care provider.

Typestring

SourceField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe API name of the field that is copied to the target object.

Typestring

TargetField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe API name of the field to copy the data to.

Utilization Management

EDITIONS

Health Cloud is available inSalesforce Classic andLightning Experience

Available in: Enterprise,Performance, andUnlimited Editions

Utilization Management (UM) is a health insurance plan's process of interfacing with plan membersand contracted medical providers to interpret, administer, and explain the medical policies of thehealth plan. Health Cloud provides objects you can use to review and evaluate medical care services,communicate about clinical policies, and help health plan members ensure they receive the rightcare in the right setting at the right time.

294

Utilization ManagementHealth Cloud Developer Guide

Page 299: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDiagnosis

Represents the details of a diagnosis including code type, name, and description. One or more care diagnoses can be associatedwith a care request.

CareRequest

Represents the general details of a care-related request including member information, admission date, decision reason, and so on.A single request can contain multiple diagnoses, services, or drugs. Care requests include preauthorizations for drugs and services,admission notifications, concurrent review of admissions, appeals, complaints, and grievances.

CareRequestConfiguration

Represents the details for a record type such as service request, drug request, or admission request. One or more record types canbe associated with a care request.

CareRequestDrug

Represents the details of a requested drug including name, strength, frequency, and instructions for administration. One or moredrug requests can be associated with a care request.

295

Utilization ManagementHealth Cloud Developer Guide

Page 300: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareRequestExtension

Represents extra details for a care request such as the subscriber details for the member's health plan, home health care status, andambulance transportation details.

CareRequestItem

Represents the details of a care service request, including name, modifiers, and the effective date. One or more care service requestscan be associated with a care request.

CareDiagnosisRepresents the details of a diagnosis including code type, name, and description. One or more care diagnoses can be associated with acare request.

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

Fields

DetailsField Name

Typereference

CareRequestCaseId

PropertiesCreate, Filter, Group, Sort

DescriptionCase related to the care request.

Typereference

CareRequestId

PropertiesCreate, Filter, Group, Sort, Update

DescriptionCare request for the diagnosis.

Typestring

CodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDiagnosis code description.

Typepicklist

CodeType

296

Utilization ManagementHealth Cloud Developer Guide

Page 301: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode type for the diagnosis.

Typestring

CodeTypeIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the code type for the diagnosis.

Typereference

DiagnosisCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDiagnosis code.

Typestring

DischargeCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDischarge diagnosis code.

Typestring

DischargeCodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the discharge diagnosis code.

Typepicklist

DischargeCodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode type for the discharge diagnosis.

Typestring

DischargeCodeTypeIdentifier

297

Utilization ManagementHealth Cloud Developer Guide

Page 302: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the code type for the discharge diagnosis.

Typereference

DischargeDiagnosisCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDiagnosis code at discharge.

Typedate

DischargeDiagnosisEffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEffective date for the discharge diagnosis.

Typedate

DischargeDiagnosisEndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for the discharge diagnosis.

Typedate

EffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEffective date for the diagnosis.

Typedate

EndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for the diagnosis.

Typeboolean

IsDischargeDiagnosisPrimary

298

Utilization ManagementHealth Cloud Developer Guide

Page 303: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this is the primary discharge diagnosis.

Typeboolean

IsModifiedDiagnosisPrimary

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this modified diagnosis is the primary diagnosis.

Typeboolean

IsPrimary

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this diagnosis is the primary diagnosis.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

ModifiedCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified diagnosis code.

299

Utilization ManagementHealth Cloud Developer Guide

Page 304: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

ModifiedCodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified diagnosis code description.

Typepicklist

ModifiedCodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode type for the modified diagnosis.

Typestring

ModifiedCodeTypeIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the code type for the modified diagnosis.

Typereference

ModifiedDiagnosisCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the code type for the modified diagnosis.

Typedate

ModifiedEffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified effective date for the diagnosis.

Typedate

ModifiedEndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified termination date for the diagnosis.

300

Utilization ManagementHealth Cloud Developer Guide

Page 305: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the diagnosis code.

Typereference

RecordTypeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the record type assigned to this object.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which this request was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the request was sourced.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system.

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

CareDiagnosisFeedFeed tracking is available for the object.

301

Utilization ManagementHealth Cloud Developer Guide

Page 306: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareDiagnosisHistoryHistory is available for tracked fields of the object.

CareRequestRepresents the general details of a care-related request including member information, admission date, decision reason, and so on. Asingle request can contain multiple diagnoses, services, or drugs. Care requests include preauthorizations for drugs and services, admissionnotifications, concurrent review of admissions, appeals, complaints, and grievances.

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

Fields

DetailsField Name

TypedateTime

AcknowledgementLetterSentDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when an acknowledgment letter was sent to the requester.

TypedateTime

ActualAdmissionDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionActual admission date for the patient.

TypedateTime

ActualDischargeDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionActual discharge date for the patient.

Typetextarea

AdmissionNotes

PropertiesCreate, Nillable, Update

DescriptionNotes related to the admission.

302

Utilization ManagementHealth Cloud Developer Guide

Page 307: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typepicklist

AdmissionSource

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhere the patient was admitted from, for example, a clinic or an emergencyroom.

Typepicklist

AdmissionType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Type of admission, for example, emergency or elective.

TypedateTime

AorReceivedDate

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Date and time when the Appointment of Representative (AOR) form was received.

TypedateTime

AorRequestedDate

PropertiesCreate, Filter, Nillable, Sort, Update

Description

Date and time when the AOR form was requested.

Typereference

AppointedRepresentativeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the appointed representative for the member.

TypedateTime

AppointedRepVerbalContactDate

PropertiesCreate, Filter, Nillable, Sort, Update

303

Utilization ManagementHealth Cloud Developer Guide

Page 308: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionDate and time of verbal contact with the member's appointed representative.

TypedateTime

AppointedRepWrittenContactDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time correspondence was sent to the member's appointedrepresentative.

Typeint

ApprovedLengthOfStay

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionApproved number of days for the admission.

Typepicklist

ApprovedLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionApproved level of care for the patient, for example, Hospital-Observatonor SNF-Rehabilitation.

Typereference

CareRequestCaseId

PropertiesCreate, Filter, Group, Sort

DescriptionCase related to the care request.

Typestring

ClaimNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionClaim number for the medical service or medication, if one exists.

Typepicklist

ClinicalCaseType

304

Utilization ManagementHealth Cloud Developer Guide

Page 309: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionClinical case type for the patient, for example, High Risk Fall or AdultDiabetes.

Typepicklist

CriteriaMet

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Indicates whether criteria for care was met.

Typeint

CumulativeLengthOfStay

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Total number of days for the admission.

Typepicklist

CurrentLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Level of care that the patient is receiving.

TypedateTime

DecisionDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate by which the decision must be made for the request.

Typeint

DecisionDaysRemaining

PropertiesFilter, Group, Nillable, Sort

DescriptionNumber of days remaining for a decision or resolution.

305

Utilization ManagementHealth Cloud Developer Guide

Page 310: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typetextarea

DecisionLetter

PropertiesCreate, Nillable, Update

DescriptionThe text of the determination letter sent to the member and provider.

Typetextarea

DecisionNotes

PropertiesCreate, Nillable, Update

Description

Notes related to the decision.

Typepicklist

DecisionReason

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Reason for the decision.

Typetextarea

DecisionReasonDescription

PropertiesCreate, Nillable, Update

Description

Text describing the reason for the decision.

Typeint

DeniedLengthOfStay

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Number of days denied for the admission.

Typepicklist

DeniedLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

306

Utilization ManagementHealth Cloud Developer Guide

Page 311: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Description

Level of care denied for the patient.

Typetextarea

DispositionNotes

PropertiesCreate, Nillable, Update

Description

Notes related to the disposition of the request.

TypedateTime

DueDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the request is due for completion.

TypedateTime

EffectiveFrom

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe start date for an effective-date range.

TypedateTime

EffectiveTo

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe end date for an effective-date range.

TypedateTime

ExpirationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionExpiration date for the request.

TypedateTime

ExtensionRequestReceivedDate

307

Utilization ManagementHealth Cloud Developer Guide

Page 312: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time an extension was requested.

Typestring

ExternalComplaintIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionComplaint ID number.

Typestring

FacilityRecordNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typepicklist

FacilityRoomBedType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of facility bed for the patient.

Typestring

FacilityRoomNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe facility room number for the patient.

Typepicklist

FinalLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFinal level of care the patient.

Typereference

FirstReviewerId

308

Utilization ManagementHealth Cloud Developer Guide

Page 313: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the person who reviewed the request.

Typetextarea

FirstReviewerNotes

PropertiesCreate, Nillable, Update

DescriptionNotes from the first reviewer related to the case.

Typereference

GeneralPractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMember's primary or general care practitioner.

TypedateTime

GeneralPractitionerVerbalNotifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the primary care practitioner was verbally notified of the decision

TypedateTime

GeneralPractitionerWrittenNotifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the primary care practitioner was notified of the decision by writtencorrespondence.

TypedateTime

InfoReceivedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when additional information was received from the provider ormember.

309

Utilization ManagementHealth Cloud Developer Guide

Page 314: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

TypedateTime

InfoRequestedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when additional information was requested from the provider ormember.

Typedate

InitialDenialNotificationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate of initial denial notification.

Typeboolean

IsExtendedRequest

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether a request was extended.

Typeboolean

IsServiceOrMedicationReceived

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the member has already received the medial service ormedication.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

310

Utilization ManagementHealth Cloud Developer Guide

Page 315: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typereference

MedicalDirectorId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the medical director who reviewed the request.

Typetextarea

MedicalDirectorNotes

PropertiesCreate, Nillable, Update

DescriptionNotes from the medical director related to the request.

Typetextarea

MemberCondition

Create, Filter, Group, Nillable, Sort, Update

DescriptionFree-form description of the member's condition.

TypedateTime

MemberContactDateTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when the member was contacted.

Typedate

MemberDateOfBirth

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Date of birth of the member.

Typestring

MemberFirstName

311

Utilization ManagementHealth Cloud Developer Guide

Page 316: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

First name of the member.

Typepicklist

MemberGender

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionGender of the member.

Typestring

MemberGroupNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Insurance group number for the member.

Typereference

MemberId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Insurance identifier for the member.

Typestring

MemberIdentificationNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Insurance identification number for the member.

Typestring

MemberLastName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Last name of the member.

312

Utilization ManagementHealth Cloud Developer Guide

Page 317: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typepicklist

MemberPrognosis

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicator of the provider's prognosis for the member.

Typetextarea

MemberStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe member's status at admission, date of outpatient service, or start of care.

TypedateTime

MemberVerbalNotificationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the member was verbally notified of the decision.

TypedateTime

MemberWrittenNotificationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the member was notified of the decision by written correspondence.

TypedateTime

ModificationDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the case was modified.

Typeint

ModifiedLengthOfStay

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified number of days for the admission.

313

Utilization ManagementHealth Cloud Developer Guide

Page 318: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typepicklist

ModifiedLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified level of care for the patient.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the care request.

TypedateTime

NextReviewDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the next review is scheduled for completion.

Typereference

OriginalDenialMedicalDirectorId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the medical director who denied the original request.

Typepicklist

ParProvider

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicator of whether this provider has entered into an agreement with theinsurance carrier.

Typepicklist

PlaceOfService

PropertiesCreate, Filter, Group, Nillable, Sort, Update

314

Utilization ManagementHealth Cloud Developer Guide

Page 319: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionPlace of service for the member's care such as an inpatient hospital or anambulatory surgery center.

TypedateTime

PractitionerContactDateTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when the provider was contacted.

Typepicklist

QuantityType

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionQuantity type for the request such as days, units, or visits.

TypedateTime

ReceivedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the request was received.

Typedate

ReconsiderationDenialNotificationDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate of reconsideration denial notification.

Typestring

ReferenceCaseNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReference authorization number for an appeal, complaint, or grievance.

TypedateTime

ReopenedDate

315

Utilization ManagementHealth Cloud Developer Guide

Page 320: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the request was reopened.

Typepicklist

ReopenReason

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason the request was reopened.

Typetextarea

ReopenReasonDescription

PropertiesCreate, Nillable, Update

DescriptionDescription of why the request was reopened.

TypedateTime

RequestedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the request was originally requested.

Typeint

RequestedLengthOfStay

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRequested number of days for the admission.

Typepicklist

RequestedLevelOfCare

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRequested level of care for the patient.

Typepicklist

RequesterType

316

Utilization ManagementHealth Cloud Developer Guide

Page 321: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates the role of the individual initiating the request.

Typereference

RequestingPractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionOrdering or referring practitioner for the request.

Typepicklist

RequestingPractitionerLicense

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLicense type of the practitioner.

Typepicklist

RequestingPractitionerSpecialty

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSpecialty of the practitioner, for example, Family Practice or GeneralSurgery.

TypedateTime

RequestingPractitionerVerbalNotifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the practitioner was verbally notified of the decision.

TypedateTime

RequestingPractitionerWrittenNotifiedDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the practitioner was notified of the decision by writtencorrespondence.

317

Utilization ManagementHealth Cloud Developer Guide

Page 322: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

TypedateTime

ResolutionDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate when the complaint, appeal, or grievance was resolved.

TypedateTime

ResolutionLetterSentDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when a resolution letter was sent to the requester.

Typetextarea

ResolutionNotes

PropertiesCreate, Nillable, Update

DescriptionResolution notes for the request.

TypedateTime

ReviewDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate the review was completed.

Typetextarea

RootCauseNotes

PropertiesCreate, Nillable, Update

DescriptionField for notes related to the root cause for the request.

TypedateTime

ScheduledAdmissionDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionAnticipated admission date for the patient.

318

Utilization ManagementHealth Cloud Developer Guide

Page 323: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

TypedateTime

ScheduledDischargeDate

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionScheduled discharge date for the patient.

Typedate

ServiceDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate when patient received the service.

Typereference

ServicingFacilityId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFacility where the service is being provided.

Typereference

ServicingPractitionerId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner administering the service.

Typepicklist

ServicingPractitionerLicense

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLicense type of the practitioner.

Typepicklist

ServicingPractitionerSpecialty

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSpecialty of the practitioner.

319

Utilization ManagementHealth Cloud Developer Guide

Page 324: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which this request was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the request was sourced.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system.

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

CareRequestFeedFeed tracking is available for the object.

CareRequestHistoryHistory is available for tracked fields of the object.

CareRequestConfigurationRepresents the details for a record type such as service request, drug request, or admission request. One or more record types can beassociated with a care request.

Supported Callscreate(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

320

Utilization ManagementHealth Cloud Developer Guide

Page 325: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typemultipicklist

CareRequestRecords

PropertiesCreate, Filter, Nillable, Update

DescriptionThe list of available objects used to configure the care request. The possible values are:

• CareDiagnosis

• CareRequestItem

• CareRequestDrug

Typestring

CareRequestRecordType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe record type for the care request.

Typepicklist

CareRequestType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of care request. For example, an appeal, a service request, or an admission.

Typestring

DeveloperName

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe unique name of the object in the API. This name can contain only underscores andalphanumeric characters, and must be unique in your org. It must begin with a letter, notinclude spaces, not end with an underscore, and not contain two consecutive underscores.In managed packages, this field prevents naming conflicts on package installations. Withthis field, a developer can change the object’s name in a managed package and the changesare reflected in a subscriber’s organization.

Typeboolean

IsActive

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

321

Utilization ManagementHealth Cloud Developer Guide

Page 326: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether this configuration is active.

Typeboolean

IsDefaultRecordType

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether this is the default record type.

Typepicklist

Language

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe language that the care request uses. The possible values are:

• da (Danish)

• de (German)

• en_US (English)

• es (Spanish)

• es_MX (Spanish (Mexico))

• fi (Finnish)

• fr (French)

• it (Italian)

• ja (Japanese) ^(\S+)

• ko (Korean)

• nl_NL (Dutch)

• no (Norwegian)

• pt_BR (Portuguese - Brazil)

• ru (Russian)

• sv (Swedish)

• th (Thai)

• zh_CN (Chinese - Simplified)

• zh_TW (Chinese - Traditional)

Typestring

MasterLabel

PropertiesCreate, Filter, Group, Sort, Update

322

Utilization ManagementHealth Cloud Developer Guide

Page 327: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe label for the care request.

CareRequestDrugRepresents the details of a requested drug including name, strength, frequency, and instructions for administration. One or more drugrequests can be associated with a care request.

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

Fields

DetailsField Name

Typeint

ApprovedUnits

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionApproved quantity of the drug.

Typereference

CareRequestCaseId

PropertiesCreate, Filter, Group, Sort

DescriptionCase related to the care request.

Typereference

CareRequestId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCare request for the care request drug.

Typestring

Code

PropertiesCreate, Filter, Group, Nillable, Sort, Update

323

Utilization ManagementHealth Cloud Developer Guide

Page 328: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionCode for the drug.

Typepicklist

CodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID code type for the drug.

Typeint

DaysSupply

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNumber of days to supply the drug.

Typeint

DeniedUnits

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDenied quantity of the drug.

Typeaddress

DispenserAddress

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPharmacy address.

Typephone

DispenserFaxNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPharmacy fax number.

Typestring

DispenserIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

324

Utilization ManagementHealth Cloud Developer Guide

Page 329: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionID for the pharmacy.

Typestring

DispenserName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID for the pharmacy.

Typephone

DispenserPhoneNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPharmacy phone number.

Typestring

DispenserTaxIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPharmacy tax identification number.

TypedateTime

DispenserVerbalNotificationDateTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when the pharmacy or pharmacy benefit manager was contactedverbally.

TypedateTime

DispenserWrittenNotificationDateTime

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time when the pharmacy or pharmacy benefit manager was notifiedin writing or electronically.

Typestring

Dose

325

Utilization ManagementHealth Cloud Developer Guide

Page 330: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDose of the drug.

Typestring

Frequency

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFrequency of the drug.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

ModifiedCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode for the modified drug.

Typepicklist

ModifiedCodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID code type for the modified drug.

326

Utilization ManagementHealth Cloud Developer Guide

Page 331: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typeint

ModifiedDaysSupply

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNumber of days of supply for the modified drug.

Typestring

ModifiedDose

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDose of the modified drug.

Typestring

ModifiedFrequency

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionFrequency of the modified drug.

Typestring

ModifiedName

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the modified drug.

Typetextarea

ModifiedSig

PropertiesCreate, Nillable, Update

DescriptionDirections for use of the modified drug.

Typestring

ModifiedStrength

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionStrength of the modified drug.

327

Utilization ManagementHealth Cloud Developer Guide

Page 332: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typeint

ModifiedTherapyDuration

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDuration of therapy for the modified drug.

Typeint

ModifiedUnits

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModified quantity of the drug.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

Name of the drug.

Typedate

PrescriptionDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate for the prescription.

Typedate

PrescriptionFillDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNumber of fills for the prescription.

Typeint

PrescriptionFills

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNumber of fills for the prescription.

328

Utilization ManagementHealth Cloud Developer Guide

Page 333: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typestring

PrescriptionNumber

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDrug prescription number.

Typestring

ServiceCategory

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the service type such as medical care, diagnostic radiology, pharmacy,or diagnostic laboratory.

Typestring

ServiceCategoryCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAlphanumeric code that uniquely identifies a service type.

Typetextarea

Sig

PropertiesCreate, Nillable, Update

DescriptionDirections for use of the drug.

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which this request was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

329

Utilization ManagementHealth Cloud Developer Guide

Page 334: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionID of the system from which the request was sourced.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system.

Typestring

Strength

PropertiesCreate, Filter, Group Nillable, Sort, Update

DescriptionStrength of the drug.

Typeint

TherapyDuration

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDuration of therapy for the drug.

Typeint

Units

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionQuantity of the drug.

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

CareRequestDrugFeedFeed tracking is available for the object.

CareRequestDrugHistoryHistory is available for tracked fields of the object.

330

Utilization ManagementHealth Cloud Developer Guide

Page 335: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CareRequestExtensionRepresents extra details for a care request such as the subscriber details for the member's health plan, home health care status, andambulance transportation details.

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

Fields

DetailsField

Typepicklist

AmbulanceTransportReason

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason for ambulance transport.

Typepicklist

AmbulanceTransportType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of ambulance transport.

Typereference

CareRequestCaseId

PropertiesCreate, Filter, Group, Sort

DescriptionCase related to the care request extension.

Typereference

CareRequestId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCare request related to the care request extension.

Typedate

HomeHealthCertificationEndDate

331

Utilization ManagementHealth Cloud Developer Guide

Page 336: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCertification end date for home health care.

Typedate

HomeHealthCertificationStartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCertification start date for home health care.

Typedate

HomeHealthStartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDate that home health services are scheduled or anticipated to start.

Typeboolean

IsMedicareCoverage

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the member has Medicare coverage.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to this record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

332

Utilization ManagementHealth Cloud Developer Guide

Page 337: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesCreate, Filter, Group, Sort, Update

DescriptionName of the care request extension.

Typepicklist

NursingHomeResidentialStatus

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionNursing home resident status at the time of service.

Typereference

RecordTypeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the associated record type.

Typepicklist

RequestType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCategory type of the request.

Typepicklist

ServiceLevel

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe level of service rendered.

Typestring

ServiceType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionClassification of the type of service.

333

Utilization ManagementHealth Cloud Developer Guide

Page 338: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

SubscriberId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier for the person who has subscribed to the health plan.

Typestring

SubscriberMemberIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMember ID for the subscriber.

Typedouble

TotalAmbulanceTransportDistance

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTotal distance traveled during ambulance transport.

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

CareRequestExtensionFeedFeed tracking is available for the object.

CareRequestExtensionHistoryHistory is available for tracked fields of the object.

CareRequestItemRepresents the details of a care service request, including name, modifiers, and the effective date. One or more care service requests canbe associated with a care request.

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

334

Utilization ManagementHealth Cloud Developer Guide

Page 339: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField Name

Typedouble

AmbulanceTransportDistance

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDistance traveled during ambulance transport.

Typepicklist

AmbulanceTransportReason

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason for ambulance transport.

Typepicklist

AmbulanceTransportType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of ambulance transport.

Typeint

ApprovedQuantity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe approved quantity of the care item.

Typereference

CareRequestCaseId

PropertiesCreate, Filter, Group, Sort

DescriptionCase related to the care request.

Typereference

CareRequestId

PropertiesCreate, Filter, Group, Sort, Update

335

Utilization ManagementHealth Cloud Developer Guide

Page 340: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionCare request for the care request item.

Typestring

CodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the denied service code.

Typepicklist

CodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Code type for the service.

Typestring

CodeTypeIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

ID of the code type for the service.

Typeint

DeniedQuantity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe quantity of the denied service.

Typedate

EffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Effective date for the diagnosis.

Typedate

EndDate

336

Utilization ManagementHealth Cloud Developer Guide

Page 341: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Termination date for the service.

Typetextarea

FreeFormProcedureDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Free-form description of the procedure.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed a record related to thisrecord.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value isnull, it’s possible that this record was referenced (LastReferencedDate) and notviewed.

Typestring

ModifiedCodeDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDescription of the modified service code.

Typestring

ModifiedCodeIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

337

Utilization ManagementHealth Cloud Developer Guide

Page 342: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionID of the code for the modified service.

Typepicklist

ModifiedCodeType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode type for the modified service.

Typestring

ModifiedCodeTypeIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the code type for the modified service.

Typedate

ModifiedEffectiveDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEffective date for the modified service.

Typedate

ModifiedEndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTermination date for the modified service.

Typestring

ModifiedModifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionModifier for modified service code.

Typestring

ModifiedModifierDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

338

Utilization ManagementHealth Cloud Developer Guide

Page 343: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionModifier description for modified service code.

Typereference

ModifiedProcedureCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode for the modified service, drug, or equipment.

Typeint

ModifiedQuantity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe modified quantity of requested care.

Typestring

Modifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Modifier for the service code.

Typestring

Modifier2

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Second modifier for service code.

Typestring

Modifier2Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the second modifier for the service code.

Typestring

Modifier3

339

Utilization ManagementHealth Cloud Developer Guide

Page 344: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Third modifier for service code.

Typestring

Modifier3Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the third modifier for the service code.

Typestring

Modifier4

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Fourth modifier for service code.

Typestring

Modifier4Description

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the fourth modifier for the service code.

Typestring

ModifierDescription

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Description of the modifier for the service code

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

Description

ID of the service code.

340

Utilization ManagementHealth Cloud Developer Guide

Page 345: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typereference

ProcedureCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Code for the service, drug, or equipment.

Typereference

ProcedureCodeId

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Code for the service, drug, or equipment.

Typeint

Quantity

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

The quantity of the item that is requested.

Typepicklist

QuantityType

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

Quantity type for the request such as days, units, or visits.

Typestring

ServiceCategory

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the service type such as medical care, diagnostic radiology, pharmacy,or diagnostic laboratory.

Typestring

ServiceCategoryCode

PropertiesCreate, Filter, Group, Nillable, Sort, Update

341

Utilization ManagementHealth Cloud Developer Guide

Page 346: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionAlphanumeric code that uniquely identifies a service type

Typestring

SourceSystem

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionSystem from which the request was sourced.

Typestring

SourceSystemIdentifier

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionID of the system from which the request was sourced.

TypedateTime

SourceSystemModified

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionTimestamp of the most recent update from the source system.

Typepicklist

Status

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe authorization status of this service.

Typepicklist

StatusReason

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionReason for the authorization status of this service.

Typereference

TransportLocationId

PropertiesCreate, Filter, Nillable, Sort, Update

342

Utilization ManagementHealth Cloud Developer Guide

Page 347: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

DescriptionDestination location for ambulance transport.

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

CareRequestItemFeedFeed tracking is available for the object.

CareRequestItemHistoryHistory is available for tracked fields of the object.

Electronic Health RecordsSalesforce Health Cloud provides custom objects to store the data contained in the standard electronic health record (EHR) fields.

EhrAllergyIntolerance__c

Represents information about the patient’s susceptibility to an adverse reaction upon exposure to a specified substance.

EhrCarePlan__c

Represents how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to carefor a specific condition or set of conditions.

EhrCarePlanActivity__c

Represents a planned action to occur as part of a care plan. Examples include a medication to be used, lab tests to perform, andeducation.

EhrCarePlanConcern__c

Represents the conditions, problems, concerns, diagnoses, and so on, whose management and mitigation are handled by this plan.

EhrCarePlanGoal__c

Represents the intended objectives of carrying out the care plan.

EhrCarePlanParticipant__c

Represents people and organizations who are expected to be involved in the care envisioned by a care plan.

EhrCondition__c

Represents detailed information about conditions, problems, and diagnoses recognized by a clinician.

EhrConditionRelatedItem__c

Represents an item that’s related to a patient’s conditions, problems, or diagnoses recognized by a clinician.

EhrDevice__c

Represents a manufactured item that’s used in the providing of healthcare without being substantially changed through that activity.Examples include machines, inserts, computers, and applications. Devices can be durable (reusable) medical equipment or disposableequipment used for diagnostic, treatment, and research for healthcare.

EhrDosageInstruction__c

Represents instructions for how a medication is to be used by a patient.

343

Electronic Health RecordsHealth Cloud Developer Guide

Page 348: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrEncounter__c

Represents an interaction between a patient and one or more healthcare providers for the purpose of providing the patient withhealthcare services or assessing a patient’s health status.

EhrEncounterAccommodation__c

Represents the type of accommodation received by the patient during an encounter.

EhrEncounterParticipant__c

Represents a person, other than the patient, who’s involved in the patient encounter.

EhrImmunization__c

Represents information about the administration of vaccines to patients.

EhrImmunizationReaction__c

Represents categorical data indicating that an adverse event is associated in time with an immunization.

EhrMedicationPrescription__c

Represents an order for supply of a medication and the instructions for administration of the medicine to a patient.

EhrMedicationStatement__c

Represents a record of the medication that the patient takes or that was given to the patient,where the record is the result of a reportfrom the patient or another clinician.

EhrObservation__c

Represents measurements and assertions made regarding a patient or device. Observations are a central element in healthcare, usedto support diagnosis, monitor progress, determine baselines and patterns, and even capture demographic characteristics.

EhrPatient__c

Represents the demographics and other administrative information about a patient who’s receiving health-related services.

EhrPatientCareProvider

Represents the patient’s nominated care provider.

EhrPatientContact__c

Represents a contact party (for example, a guardian, partner, or friend) for the patient.

EhrPractitioner__c

Represents a person who’s involved in the providing of healthcare.

EhrPractitionerIdentity__c

Represents external identities such as licenses and regional identifiers for a practitioner.

EhrPractitionerQualification__c

Represents qualifications obtained by the practitioner through training and certification.

EhrPractitionerRole__c

Represents a list of roles that the practitioner can perform for a given time period.

EhrProcedure__c

A medical action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive likecounseling or hypnotherapy.

EhrProcedurePerformer__c

A junction object that relates EhrProcedure__c and EhrPractitioner__c.

EhrProcedureRequest__c

Represents a request for a procedure to be performed. It can be used to represent a procedure that is planned, proposed, or ordered.

344

Electronic Health RecordsHealth Cloud Developer Guide

Page 349: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrProgram__c

Represents information about the program that the company is participating in. Programs include Medicare Chronic Care Management(CCM), Medicare accountable care organizations Hierarchical Condition Category (HCC) risk scoring, among others.

EhrRelatedObservation__c

Represents another observation that’s a component of a parent observation or that provides supporting information, context, orwarnings about the primary observation. Examples are components, previous observations, and statements of derivation.

EhrRelatedPerson__c

Represents a person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’t have a formal responsibility inthe process.

EhrVaccinationProtocol__c

Represents information about the protocol under which a vaccine is administered.

EhrVirtualDevice__c

Represents a group of related data items.

EhrVirtualDeviceChannel__c

Represents the channel a virtual device operates on.

SEE ALSO:

Working With Electronic Health Records

EhrAllergyIntolerance__cRepresents information about the patient’s susceptibility to an adverse reaction upon exposure to a specified substance.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

Typestring

CriticalityCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

345

Electronic Health RecordsHealth Cloud Developer Guide

Page 350: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalityLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalitySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines an estimate of the potential clinical harm or seriousness of thereaction to the identified substance.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

346

Electronic Health RecordsHealth Cloud Developer Guide

Page 351: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe EHR allergy intolerance ID. Limit: 255 characters.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient who has the sensitivity. Lookup to EhrPatient__c.

Typestring

Reaction255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA description of the allergic reaction, including details of the manifestation if required. Limit:255 characters.

Typetextarea

Reaction__c

PropertiesCreate, Nillable, Update

347

Electronic Health RecordsHealth Cloud Developer Guide

Page 352: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA long text description of the allergic reaction, including details of the manifestation ifrequired.

TypedateTime

RecordedDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when the sensitivity was recorded.

Typestring

RecorderName255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the individual who recorded the record and takes responsibility for its content.Limit: 255 characters.

Typetextarea

RecorderName__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the name of the individual who recorded the record and takesresponsibility for its content.

Typereference

Recorder__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe individual who takes responsibility for the content and can reference its source. Lookupto EhrPractitioner__c.

Typereference

SensitivityTest1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.

348

Electronic Health RecordsHealth Cloud Developer Guide

Page 353: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

SensitivityTest2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.

Typereference

SensitivityTest3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.

Typestring

SensitivityTypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the patient’s sensitivity.

Typestring

SensitivityTypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the patient’s sensitivity

Typestring

SensitivityTypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the patient’s sensitivity

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

349

Electronic Health RecordsHealth Cloud Developer Guide

Page 354: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

StatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the level of certainty associated with the potential risk of a reactionto the identified substance.

Typestring

Substance255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

350

Electronic Health RecordsHealth Cloud Developer Guide

Page 355: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe substance or class of substances that’s considered responsible for the adverse reactionrisk. Limit: 255 characters.

Typetextarea

SubstanceLong__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the substance or class of substances that’s considered responsiblefor the adverse reaction risk.

EhrCarePlan__cRepresents how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care fora specific condition or set of conditions.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe individual account that represents the patient in Lightning Platform.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

351

Electronic Health RecordsHealth Cloud Developer Guide

Page 356: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR care plan ID. Limit: 255 characters.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

352

Electronic Health RecordsHealth Cloud Developer Guide

Page 357: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionNotes about the execution of the activity.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

TypedateTime

PeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when the plan is in effect.

TypedateTime

PeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the plan comes (or is intended to come) into effect.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

353

Electronic Health RecordsHealth Cloud Developer Guide

Page 358: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhether the plan is currently being acted upon, represents future intentions, or is onlyhistorical record.

UsageThis resource captures basic details about who’s involved in the care plan and what actions are intended without dealing in discretedata about dependencies and timing relationships.

EhrCarePlanActivity__cRepresents a planned action to occur as part of a care plan. Examples include a medication to be used, lab tests to perform, and education.

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

Fields

DetailsField

Typetextarea

ActionsResulting__c

PropertiesCreate, Nillable, Update

DescriptionResources that describe follow-on actions resulting from the care plan, such as drugprescriptions, encounter records, and appointments.

Typestring

ActivityPeriod__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe period when the described activity is to occur.

354

Electronic Health RecordsHealth Cloud Developer Guide

Page 359: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ActivitySchedule__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhen the described activity is scheduled to occur.

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort,

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.

Typestring

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA high-level categorization of the type of activity in a care plan.

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a detailed description of the type of planned activity.Examples of activity types include what lab test, what procedure, and what kind of encounter.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a detailed description of the type of plannedactivity. Examples of activity types include what lab test, what procedure, and what kind ofencounter.

Typestring

CodeSystem__c

355

Electronic Health RecordsHealth Cloud Developer Guide

Page 360: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a detailed description of the type of planned activity. Examples ofactivity types include what lab test, what procedure, and what kind of encounter.

Typestring

DailyAmount__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe quantity expected to be consumed in a given day.

Typetextarea

Details__c

PropertiesCreate, Nillable, Update

DescriptionA summary of a planned activity suitable for a general care plan system that doesn’t knowabout specific resources such as procedure.

Typeboolean

IsProhibited__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the described activity must not be engaged in when following the plan (true) orcan be engaged in when following the plan (false). The default checkbox value isunselected.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

356

Electronic Health RecordsHealth Cloud Developer Guide

Page 361: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

LocationId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the facility where the activity will occur. Examples of locationsinclude home, hospital, and specific clinic.

Typestring

LocationLine1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the facility where the activity will occur.

357

Electronic Health RecordsHealth Cloud Developer Guide

Page 362: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

LocationLine2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the facility where the activity will occur.

Typestring

LocationName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the facility where the activity will occur. Examples of locations include home,hospital, and specific clinic.

Typestring

LocationPostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the facility where the activity will occur.

TypedateTime

LocationStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as the facility where the activity will occur.

Typestring

LocationState__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the facility where the activity will occur.

Typestring

LocationTelecom__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

358

Electronic Health RecordsHealth Cloud Developer Guide

Page 363: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA contact detail for the facility where the activity will occur.

Typetextarea

LocationText__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the facility where the activity will occur.

Typestring

LocationType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the activity will occur.

Typestring

LocationUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to the facility where the activity will occur.

Typestring

Name

PropertiesAutonumber, Defaulted on create , Filter, idLookup, Sort

DescriptionThe EHR care plan activity ID. Limit: 255 characters.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

DescriptionNotes about the execution of the activity.

Typestring

ProductMedication255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

359

Electronic Health RecordsHealth Cloud Developer Guide

Page 364: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe drug to be consumed or supplied in the activity. Limit: 255 characters.

Typetextarea

ProductMedication__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the drug to be consumed or supplied in the activity.

Typestring

ProductSubstance255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA homogeneous material with a definite composition. Limit: 255 characters.

Typetextarea

ProductSubstance__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of a homogeneous material with a definite composition.

Typestring

Quantity__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe quantity expected to be supplied, administered, or consumed.

Typereference

RelatedCarePlanGoal1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference

RelatedCarePlanGoal2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

360

Electronic Health RecordsHealth Cloud Developer Guide

Page 365: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference

RelatedCarePlanGoal3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference

RelatedCarePlanGoal4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference

RelatedCarePlanGoal5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference

RelatedEncounter__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related interaction between a patient and one or more healthcare providers for the purposeof providing the patient with healthcare services or assessing a patient’s health status. Lookupto EhrEncounter__c.

Typereference

RelatedMedicationPrescription__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA related order for supply of a medication and the instructions for administration of themedicine to a patient. Lookup to EhrMedicationPrescription__c.

361

Electronic Health RecordsHealth Cloud Developer Guide

Page 366: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn indicator of the progress being made by the specific activity.

Typestring

TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of activity in a care plan.

Typestring

TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of activity in a care plan.

Typestring

TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of activity in a care plan.

362

Electronic Health RecordsHealth Cloud Developer Guide

Page 367: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrCarePlanConcern__cRepresents the conditions, problems, concerns, diagnoses, and so on, whose management and mitigation are handled by this plan.

Supported Callscreate(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),retrieve(), undelete(), update(), upsert()

Fields

DetailsField

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.

Typereference

CarePlanGoal__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe intended objectives of carrying out the care plan.

Typereference

Condition__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe problems and diagnoses recognized by a clinician. Lookup to EhrCondition__c.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

363

Electronic Health RecordsHealth Cloud Developer Guide

Page 368: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR care plan concern ID. Limit: 255 characters.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrCarePlanGoal__cRepresents the intended objectives of carrying out the care plan.

364

Electronic Health RecordsHealth Cloud Developer Guide

Page 369: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.

Typetextarea

Description__c

PropertiesCreate, Nillable, Update

DescriptionA description of the care plan goal.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

365

Electronic Health RecordsHealth Cloud Developer Guide

Page 370: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe EHR care plan goal ID. Limit: 255 characters.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

DescriptionComments about the care plan goal.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

366

Electronic Health RecordsHealth Cloud Developer Guide

Page 371: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhether the plan is currently being acted upon, represents future intentions, or is onlyhistorical record.

EhrCarePlanParticipant__cRepresents people and organizations who are expected to be involved in the care envisioned by a care plan.

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

Fields

DetailsField

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort

DescriptionHow one or more practitioners intend to deliver care for a particular patient for a period oftime, possibly limited to care for a specific condition or set of conditions.

Typereference

CarePlanActivity__c

PropertiesCreate, Filter, Group, Sort

DescriptionA planned action to occur as part of the plan. Examples include a medication to be used, labtests to perform, and education.

367

Electronic Health RecordsHealth Cloud Developer Guide

Page 372: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

368

Electronic Health RecordsHealth Cloud Developer Guide

Page 373: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR care plan participant ID. Limit: 255 characters.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

Typestring

Practitioner255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA person who’s involved in the providing of healthcare. Limit: 255 characters.

Typereference

Practitioner__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA person who’s involved in the providing of healthcare. Lookup to EhrPractitioner__c.

Typetextarea

PractitionerName__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the name of a person who’s involved in the providing ofhealthcare.

Typereference

RelatedPerson__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’thave a formal responsibility in the process. Lookup to EhrRelatedPerson__c.

369

Electronic Health RecordsHealth Cloud Developer Guide

Page 374: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

RoleCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the specific responsibility of an individual withinthe care plan. Examples of roles include primary physician, team coordinator, and caregiver.

Typestring

RoleLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the specific responsibility of an individual withinthe care plan. Examples of roles include primary physician, team coordinator, and caregiver.

Typestring

RoleSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the specific responsibility of an individual within the care plan.Examples of roles include primary physician, team coordinator, and caregiver.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

370

Electronic Health RecordsHealth Cloud Developer Guide

Page 375: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrCondition__cRepresents detailed information about conditions, problems, and diagnoses recognized by a clinician.

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

Fields

DetailsField

Typestring

AbatementDetail255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date or estimated date when the condition was resolved or went into remission. Limit:255 characters.

Typestring

AbatementDetail__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the date or estimated date when the condition was resolved orwent into remission.

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort,

DescriptionThe individual account that represents the patient in Lightning Platform.

Typestring

AsserterPatient__c

371

Electronic Health RecordsHealth Cloud Developer Guide

Page 376: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe person who asserts the condition.

Typestring

AsserterPractitioner__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe person reporting the condition.

Typestring

CategoryCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the category that’s assigned to the condition.Examples of categories are complaint, symptom, and diagnosis.

Typestring

CategoryLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the category that’s assigned to the condition.Examples of categories are complaint, symptom, and diagnosis.

Typestring

CategorySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the category that’s assigned to the condition. Examples of categoriesare complaint, symptom, and diagnosis.

Typestring

CertaintyCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents level of confidence that the condition is correct.

372

Electronic Health RecordsHealth Cloud Developer Guide

Page 377: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

CertaintyLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the certainty of a correct condition.

Typestring

CertaintySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the certainty.

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the condition, problem, or diagnosis.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the condition, problem, or diagnosis.

Typestring

CodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the condition, problem, or diagnosis.

TypedateTime

DateAsserted__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

373

Electronic Health RecordsHealth Cloud Developer Guide

Page 378: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe estimated or actual date when the condition, problem, or diagnosis was first detectedor suspected.

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe encounter during which the condition was first asserted. Lookup to EhrEncounter__c.

Typestring

EvidenceCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the manifestation or symptom that led to therecording of this condition. Evidence can be a simple list of coded symptoms ormanifestations, or references to observations or formal assessments, or both.

Typetextarea

EvidenceDetail__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of supporting information such as pathology reports.

Typestring

EvidenceLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the manifestation or symptom that led to therecording of this condition. Evidence can be a simple list of coded symptoms ormanifestations, or references to observations or formal assessments, or both.

Typestring

EvidenceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

374

Electronic Health RecordsHealth Cloud Developer Guide

Page 379: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines the manifestation or symptom that led to the recording of thiscondition. Evidence can be a simple list of coded symptoms or manifestations, or referencesto observations or formal assessments, or both.

Typeboolean

IsAbated__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the condition is resolved or in remission (true) or not (false). The defaultcheckbox value is deselected.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

375

Electronic Health RecordsHealth Cloud Developer Guide

Page 380: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

LocationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the anatomical location where the condition ismanifested.

Typetextarea

LocationDetail__c

PropertiesCreate, Nillable, Update

DescriptionA long text description with precise details about the anatomical location where the conditionis manifested.

Typestring

LocationLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the anatomical location where the condition ismanifested.

Typestring

LocationSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the anatomical location where the condition is manifested.

Typestring

Name

376

Electronic Health RecordsHealth Cloud Developer Guide

Page 381: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR condition ID. Limit: 255 characters.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the condition, including general comments about thedescription of the condition, its diagnosis, and prognosis.

Typestring

Onset__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe estimated or actual date or date-time when the condition began, in the clinician’sopinion. Age is typically used when the patient reports an age when the condition began.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s name. Lookup to EhrPatient__c.

Typestring

SeverityCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a subjective assessment of the condition’s severityas evaluated by the clinician. Where possible, coding of the severity with a terminology ispreferred.

Typestring

SeverityLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

377

Electronic Health RecordsHealth Cloud Developer Guide

Page 382: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents a subjective assessment of the condition’s severityas evaluated by the clinician. Where possible, coding of the severity with a terminology ispreferred.

Typestring

SeveritySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a subjective assessment of the condition’s severity as evaluated bythe clinician Where possible, coding of the severity with a terminology is preferred.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Stage__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA condition’s clinical stage or grade, including a summary (such as “Stage 3”) or assessment(a reference to a formal record of the evidence on which the staging assessment is based).The determination of the stage is disease-specific. Can include formal severity assessments.

378

Electronic Health RecordsHealth Cloud Developer Guide

Page 383: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

StatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the condition’s clinical status.

Typestring

StatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the condition’s clinical status.

Typestring

StatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the condition’s clinical status.

UsageUses include recording a diagnosis during an encounter and populating a problem list or summary statement, such as a dischargesummary.

EhrConditionRelatedItem__cRepresents an item that’s related to a patient’s conditions, problems, or diagnoses recognized by a clinician.

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

Fields

DetailsField

Typestring

Code__c

379

Electronic Health RecordsHealth Cloud Developer Guide

Page 384: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the item related to the patient’s condition.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the item related to the patient’s condition.

Typestring

CodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the item related to the patient’s condition.

Typereference

Condition__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe patient’s problem or diagnosis recognized by a clinician.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

380

Electronic Health RecordsHealth Cloud Developer Guide

Page 385: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typereference

MedicationStatement__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA record of the medication that the patient takes or that was given to the patient,where therecord is the result of a report from the patient or another clinician. Lookup toEhrMedicationStatement__c.

Typestring

Name

PropertiesCreate, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe EHR condition name. Limit: 255 characters.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

381

Electronic Health RecordsHealth Cloud Developer Guide

Page 386: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionAdditional information about the item related to the patient’s condition.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

TargetCondition__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to EhrCondition__c.

Typetextarea

TargetDetail__c

PropertiesCreate, Nillable, Update

Description

Typereference

TargetImmunization__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to EhrImmunization__c.

382

Electronic Health RecordsHealth Cloud Developer Guide

Page 387: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrDevice__cRepresents a manufactured item that’s used in the providing of healthcare without being substantially changed through that activity.Examples include machines, inserts, computers, and applications. Devices can be durable (reusable) medical equipment or disposableequipment used for diagnostic, treatment, and research for healthcare.

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

Fields

DetailsField

Typetextarea

Contact__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of the contact details for an organization or person who’s responsiblefor support for the device.

Typetextarea

DeviceURL__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of the network address on which the device can be directly contacted.

Typedate

Expiry__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date and time after which this device is not valid or should not be used.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

383

Electronic Health RecordsHealth Cloud Developer Guide

Page 388: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Location255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhere the device is found. Can be a literal location (for example, GPS coordinates), a logicalplace (for example, “with the patient”), or a coded location. Limit: 255 characters.

Typetextarea

Location__c

384

Electronic Health RecordsHealth Cloud Developer Guide

Page 389: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Nillable, Update

DescriptionA long text description of where the device is found. Can be a literal location (for example,GPS coordinates), a logical place (for example, “with the patient”), or a coded location.

Typestring

LotNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA lot number assigned by the manufacturer.

Typestring

Manufacturer__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the device’s manufacturer.

Typestring

Model__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier that’s assigned by the manufacturer to identify the product by its type. Thisnumber is shared by the all devices that are sold as the same type.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR device ID. Limit: 255 characters.

Typestring

Owner255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization that’s responsible for the provision and maintenance of the device. Limit:255 characters.

385

Electronic Health RecordsHealth Cloud Developer Guide

Page 390: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

Owner__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization that’s responsible for the provision andmaintenance of the device.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the record owner.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s name. Lookup to EhrPatient__c.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

386

Electronic Health RecordsHealth Cloud Developer Guide

Page 391: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe type of device.

Typestring

Udi__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe United States Food and Drug Administration-mandated Unique Device Identifier (UDI).Use the human-readable information (the content that the user sees, which sometimesdiffers from the syntax in the barcode). The unique identifier can identify an instance of adevice uniquely or just identify the type of the device. The DI part can be extracted from theUDI when required and used to find information about the device through the GUDID.

Typestring

Version__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe version of the device, if the device has multiple releases under the same model, issoftware, or carries firmware.

UsageThis resource is typically used to record which device performed an action and to track device location. It’s also used for prescribing anddispensing devices for patient use. If the device is implanted in a patient, the patient element is present, and there’s no location.

EhrDosageInstruction__cRepresents instructions for how a medication is to be used by a patient.

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

Fields

DetailsField

Typestring

AdditionalInstruction__c

387

Electronic Health RecordsHealth Cloud Developer Guide

Page 392: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAdditional dosage instructions such as “Take with food.”

Typestring

AdditionalInstructionCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents additional dosage instructions.

Typestring

AdditionalInstructionLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents additional dosage instructions.

Typestring

AdditionalInstructionSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines additional dosage instructions.

Typeboolean

AsNeeded__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether a medication is taken only when needed within the specified schedule (true) orat every scheduled dose (false). The default checkbox value is deselected.

Typestring

AsNeededCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents whether a medication is taken only when neededwithin the specified schedule rather than at every scheduled dose.

388

Electronic Health RecordsHealth Cloud Developer Guide

Page 393: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

AsNeededLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents whether a medication is taken only when neededwithin the specified schedule rather than at every scheduled dose.

Typestring

AsNeededSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines whether a medication is taken only when needed within the specifiedschedule rather than at every scheduled dose.

Typestring

DoseQuantityUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the amount of medication that was dispensed.

Typestring

DoseQuantityValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe amount of medication that was dispensed.

Typereference

EhrPatient__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual receiving healthcare services.

Typetextarea

Instruction__c

PropertiesCreate, Nillable, Update

389

Electronic Health RecordsHealth Cloud Developer Guide

Page 394: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA long text description of how a medication is to be used by a patient.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

390

Electronic Health RecordsHealth Cloud Developer Guide

Page 395: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

MaxDosePerPeriodAmountUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the maximum total quantity of a therapeutic substance thatcan be administered to a subject over a period of time.

Typestring

MaxDosePerPeriodAmountValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe maximum total quantity of a therapeutic substance that can be administered to a subjectover a period of time.

Typestring

MaxDosePerPeriodDenominatorUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the denominator of the maximum total quantity of a therapeuticsubstance that can be administered to a subject over a period of time.

Typestring

MaxDosePerPeriodDenominatorValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe denominator in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.

Typestring

MaxDosePerPeriodNumeratorUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the numerator of the maximum total quantity of a therapeuticsubstance that can be administered to a subject over a period of time.

Typestring

MaxDosePerPeriodNumeratorValue__c

391

Electronic Health RecordsHealth Cloud Developer Guide

Page 396: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe numerator in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.

Typestring

MaxDosePerPeriodTimeUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement of time in the maximum total quantity of a therapeutic substancethat can be administered to a subject over a period of time.

Typestring

MaxDosePerPeriodTimeValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe time value in the maximum total quantity of a therapeutic substance that can beadministered to a subject over a period of time.

Typereference

MedicationPrescription__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn order for supply of a medication and the instructions for administration of the medicineto a patient. Lookup to EhrMedicationPrescription__c.

Typereference

MedicationStatement__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA record of the medication that the patient takes or that was given to the patient, where therecord is the result of a report from the patient or another clinician. Lookup toEhrMedicationStatement__c.

Typestring

MethodCode__c

392

Electronic Health RecordsHealth Cloud Developer Guide

Page 397: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the method by which a medication is introducedinto or onto the body, most commonly used for injections.

Typestring

MethodLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the method by which a medication is introducedinto or onto the body, most commonly used for injections.

Typestring

MethodSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the method by which a medication is introduced into or onto thebody, most commonly used for injections.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR dosage instruction ID. Limit: 255 characters.

Typestring

RateDenominator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe denominator in the speed at which the substance is introduced into the subject, typicallythe rate for an infusion. An example rate is 200ml in 2 hours.

Typestring

RateNumerator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

393

Electronic Health RecordsHealth Cloud Developer Guide

Page 398: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe numerator in the speed at which the substance is introduced into the subject, typicallythe rate for an infusion. An example rate is 200ml in 2 hours.

Typestring

RouteCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

Typestring

RouteLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

Typestring

RouteSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the route or physiological path of administration of a therapeuticagent into or onto a subject.

Typestring

SiteCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

394

Electronic Health RecordsHealth Cloud Developer Guide

Page 399: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the anatomic site where the medication first enters the body.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typetextarea

SupplementalInstructions__c

PropertiesCreate, Nillable, Update

DescriptionAny additional instructions.

TypedateTime

TimingPeriod__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe defined period of time.

TypedateTime

TimingPeriodEnd__c

395

Electronic Health RecordsHealth Cloud Developer Guide

Page 400: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last day of the time period.

TypedateTime

TimingPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first day of the time period.

EhrEncounter__cRepresents an interaction between a patient and one or more healthcare providers for the purpose of providing the patient with healthcareservices or assessing a patient’s health status.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe individual account that represents the patient in Lightning Platform.

Typestring

Class__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe classification of the encounter. Examples include inpatient, outpatient, ambulatory, andemergency.

396

Electronic Health RecordsHealth Cloud Developer Guide

Page 401: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the interaction during which services are provided to the patient. Lookup toEhrEncounter__c.

Typestring

HospitalizeAdmitSourceCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the source from which the patient was admitted.Examples of sources include physician referral and transfer.

Typestring

HospitalAdmitSourceLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the source from which the patient was admitted.Examples of sources include physician referral and transfer.

Typestring

HospitalizeAdmitSourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the source from which the patient was admitted. Examples of sourcesinclude physician referral and transfer.

Typestring

HospitalizeDestination__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location to which the patient is discharged.

Typestring

HospitalizeDietCode__c

397

Electronic Health RecordsHealth Cloud Developer Guide

Page 402: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents diet preferences that the patient reports.

Typestring

HospitalizeDietLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents diet preferences that the patient reports. Dietpreferences include medical, cultural, and ethical food preferences to help with cateringrequirements.

Typestring

HospitalizeDietSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines diet preferences that the patient reports. Diet preferences includemedical, cultural, and ethical food preferences to help with catering requirements.

Typetextarea

HospitalizeDischargeDiagnosis__c

PropertiesCreate, Nillable, Update

DescriptionA long text description of the final diagnosis that a patient receives before release from thehospital after all testing, surgery, and workup are completed.

Typestring

HospitalizeDischargeDispositionCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

398

Electronic Health RecordsHealth Cloud Developer Guide

Page 403: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the category or kind of patient location after discharge.

Typetextarea

HospitalizeOrigin__c

PropertiesCreate, Nillable, Update

DescriptionThe location from which the patient came before admission.

TypedateTime

HospitalizePeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last day when the specified participant was present during the encounter. Periods canoverlap or be subsets of the overall encounters period.

TypedateTime

HospitalizePeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first day when the specified participant was present during the encounter. Periods canoverlap or be subsets of the overall encounters period.

Typestring

HospitalizePreAdmissionId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier for hospitalization pre-admission.

399

Electronic Health RecordsHealth Cloud Developer Guide

Page 404: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

HospitalizeReadmission__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionWhether this hospitalization is a readmission (true) or not (false). The default checkboxvalue is deselected.

Typestring

HospitalizeSpecialArrangementCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents special arrangements such as a wheelchair,translator, or stretcher.

Typestring

HospitalizeSpecialArrangementLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents special arrangements such as a wheelchair,translator, or stretcher.

Typestring

HospitalizeSpecialArrangementSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines special arrangements such as a wheelchair, translator, or stretcher.

Typestring

HospitalizeSpecialCourtesyCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesyLabel__c

400

Electronic Health RecordsHealth Cloud Developer Guide

Page 405: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a special courtesy such as a courtesy that’s extended to a boardmember or VIP.

Typetextarea

HospitalizationOrigin__c

PropertiesCreate, Nillable, Update

DescriptionThe location from which the patient came before admission.

Typestring

HospitalizationPreAdmissionId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier for hospitalization pre-admission.

Typestring

Indication__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe reason that the encounter occurs, as specified by using information from another resource.For admissions, this is the admission diagnosis. Typically the indication is a condition or aprocedure.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

401

Electronic Health RecordsHealth Cloud Developer Guide

Page 406: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

LengthUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA unit of measurement of time that the encounter lasted, excluding the time during leavesof absence.

402

Electronic Health RecordsHealth Cloud Developer Guide

Page 407: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

LengthValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe length of time that the encounter lasted, excluding the time during leaves of absence.

Typestring

Location1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where a patient encounter occurs.

Typestring

Location1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where a patient encounter occurs.

Typestring

Location1Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location1Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the location where a patient encounter occurs.

403

Electronic Health RecordsHealth Cloud Developer Guide

Page 408: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location1Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the location where a patient encounter occurs.

404

Electronic Health RecordsHealth Cloud Developer Guide

Page 409: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location1TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

TypedateTime

Location1TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location1TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location1TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.

Typestring

Location1TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

405

Electronic Health RecordsHealth Cloud Developer Guide

Page 410: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typetextarea

Location1Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location1TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location1Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the patient encounter occurs.

406

Electronic Health RecordsHealth Cloud Developer Guide

Page 411: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where a patient encounter occurs.

Typestring

Location2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where a patient encounter occurs.

Typestring

Location2Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location2Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the location where a patient encounter occurs.

407

Electronic Health RecordsHealth Cloud Developer Guide

Page 412: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location2Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the location where a patient encounter occurs.

408

Electronic Health RecordsHealth Cloud Developer Guide

Page 413: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location2TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

TypedateTime

Location2TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location2TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location2TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.

Typestring

Location2TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

409

Electronic Health RecordsHealth Cloud Developer Guide

Page 414: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typetextarea

Location2Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location2TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location2TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location2TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location2Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the patient encounter occurs.

410

Electronic Health RecordsHealth Cloud Developer Guide

Page 415: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where a patient encounter occurs.

Typestring

Location3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where a patient encounter occurs.

Typestring

Location3Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location3Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the location where a patient encounter occurs.

411

Electronic Health RecordsHealth Cloud Developer Guide

Page 416: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location3Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the location where a patient encounter occurs.

412

Electronic Health RecordsHealth Cloud Developer Guide

Page 417: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location3TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

TypedateTime

Location3TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location3TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location3TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.

Typestring

Location3TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

413

Electronic Health RecordsHealth Cloud Developer Guide

Page 418: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typetextarea

Location3Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location3TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location3TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location3TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location3Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the patient encounter occurs.

414

Electronic Health RecordsHealth Cloud Developer Guide

Page 419: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where a patient encounter occurs.

Typestring

Location4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where a patient encounter occurs.

Typestring

Location4Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location4Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the location where a patient encounter occurs.

415

Electronic Health RecordsHealth Cloud Developer Guide

Page 420: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location4Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the location where a patient encounter occurs.

416

Electronic Health RecordsHealth Cloud Developer Guide

Page 421: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location4TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

TypedateTime

Location4TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location4TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location4TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.

Typestring

Location4TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

417

Electronic Health RecordsHealth Cloud Developer Guide

Page 422: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typetextarea

Location4Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location4TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location4TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location4TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location4Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the patient encounter occurs.

418

Electronic Health RecordsHealth Cloud Developer Guide

Page 423: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where a patient encounter occurs.

Typestring

Location5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where a patient encounter occurs.

Typestring

Location5Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when this location is valid as a patient encounter location.

Typestring

Location5Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the location where a patient encounter occurs.

419

Electronic Health RecordsHealth Cloud Developer Guide

Page 424: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location5Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

Typestring

Location5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of the location where a patient encounter occurs.

420

Electronic Health RecordsHealth Cloud Developer Guide

Page 425: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location5TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

TypedateTime

Location5TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location5TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typestring

Location5TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for this location.Communication devices available at the location can include phone numbers, fax numbers,mobile numbers, email addresses, and websites.

Typestring

Location5TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

421

Electronic Health RecordsHealth Cloud Developer Guide

Page 426: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe contact detail such as a phone number for this location. Communication devices availableat the location can include phone numbers, fax numbers, mobile numbers, email addresses,and websites.

Typetextarea

Location5Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location5TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location5TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location5TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location5Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of location where the patient encounter occurs.

422

Electronic Health RecordsHealth Cloud Developer Guide

Page 427: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR encounter ID. Limit: 255 characters.

Typereference

Patient__c

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe patient’s name. Lookup to EhrPatient__c.

TypedateTime

PeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date and time when the period is valid for this patient encounter.

TypedateTime

PeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date and time when the period is valid for this patient encounter.

Typestring

PriorityCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the urgency of the patient encounter.

423

Electronic Health RecordsHealth Cloud Developer Guide

Page 428: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

PriorityLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the urgency of the patient encounter.

Typestring

PrioritySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the urgency of the patient encounter.

Typestring

Priority__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn indication of the urgency of the patient encounter. Examples include immediate,emergency, urgent, semi-urgent, and non-urgent.

Typestring

ReasonCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the reason why the patient encounter occurs. Foradmissions, the reason can be used for a coded admission diagnosis.

Typestring

ReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the reason why the patient encounter occurs. Foradmissions, the reason can be used for a coded admission diagnosis.

Typestring

ReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

424

Electronic Health RecordsHealth Cloud Developer Guide

Page 429: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines the reason why the patient encounter occurs. For admissions, thereason can be used for a coded admission diagnosis.

Typestring

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn indication of the status of the patient encounter. Examples include planned, arrived,in-progress, onleave, finished, and cancelled.

Typestring

TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the specific type of patient encounter. Examplesof types include e-mail consultation, surgical day-care, skilled nursing, and rehabilitation.

Typestring

TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the specific type of patient encounter. Examplesof types include e-mail consultation, surgical day-care, skilled nursing, and rehabilitation.

Typestring

TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the specific type of patient encounter. Examples of types includee-mail consultation, surgical day-care, skilled nursing, and rehabilitation.

UsageA patient encounter is characterized by the setting in which it occurs. For example, the encounter can be ambulatory, emergency, homehealth, inpatient, or virtual. An encounter encompasses the lifecycle from pre-admission to discharge (for inpatient encounters). Duringthe encounter the patient can move from practitioner to practitioner and location to location.

425

Electronic Health RecordsHealth Cloud Developer Guide

Page 430: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrEncounterAccommodation__cRepresents the type of accommodation received by the patient during an encounter.

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

Fields

DetailsField

Typestring

Bed__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn indicator for the type of bed that the patient uses during the encounter.

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Sort

DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

426

Electronic Health RecordsHealth Cloud Developer Guide

Page 431: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR encounter accommodation ID. Limit: 255 characters.

Typestring

Period__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe time period when the accommodation type is valid.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

427

Electronic Health RecordsHealth Cloud Developer Guide

Page 432: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA name that identifies the system that created the record and owns update rights to it.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrEncounterParticipant__cRepresents a person, other than the patient, who’s involved in the patient encounter.

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

Fields

DetailsField

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Sort

DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status.

Typedate

EndDate__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe last date when the specified participant was present during the patient encounter.Periods can overlap or be subsets of the overall encounters period.

Typeboolean

IsRestricted__c

428

Electronic Health RecordsHealth Cloud Developer Guide

Page 433: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

429

Electronic Health RecordsHealth Cloud Developer Guide

Page 434: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe EHR encounter participant ID. Limit: 255 characters.

Typereference

Practitioner__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionA person who’s involved in the providing of healthcare services. Lookup to EhrPractitioner__c.

Typereference

RelatedPerson__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionA person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’thave a formal responsibility in the process. Lookup to EhrRelatedPerson__c.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typedate

StartDate__c

430

Electronic Health RecordsHealth Cloud Developer Guide

Page 435: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe last date when the specified participant was present during the patient encounter.Periods can overlap or be subsets of the overall encounters period.

Typestring

TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the role of the participant in the patient encounter.The type indicates how an individual participates in a patient encounter. It includesnonpractitioner participants and differs from practitioner roles. Examples include admittingdoctor, attending doctor, translator, and consulting doctor.

Typestring

TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the role of the participant in the patient encounter.The type indicates how an individual participates in a patient encounter. It includesnonpractitioner participants and differs from practitioner roles. Examples include admittingdoctor, attending doctor, translator, and consulting doctor.

Typestring

TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the role of the participant in the patient encounter. The type indicateshow an individual participates in a patient encounter. It includes nonpractitioner participantsand differs from practitioner roles. Examples include admitting doctor, attending doctor,translator, and consulting doctor.

EhrImmunization__cRepresents information about the administration of vaccines to patients.

431

Electronic Health RecordsHealth Cloud Developer Guide

Page 436: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform

TypedateTime

DateAdministered__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when a vaccine was administered or was to be administered.

Typestring

DoseQuantity__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe quantity of vaccine product that was administered.

Typestring

DoseQuantityUnits__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the quantity of vaccine product that was administered.

Typestring

DoseQuantityValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe quantity of vaccine product that was administered.

432

Electronic Health RecordsHealth Cloud Developer Guide

Page 437: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

ExpirationDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when a vaccine batch expires.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

433

Electronic Health RecordsHealth Cloud Developer Guide

Page 438: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

LocationCity__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city where the vaccine was administered.

Typestring

LocationCountry__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country where the vaccine was administered.

Typestring

LocationId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for the service delivery location where the vaccine was administered.

Typestring

LocationLline1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of the address where the vaccine was administered.

Typestring

LocationLline2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of the address where the vaccine was administered.

Typestring

LocationName__c

434

Electronic Health RecordsHealth Cloud Developer Guide

Page 439: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the location where the vaccine was administered.

Typestring

LocationPostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address where the vaccine was administered.

TypedateTime

LocationStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the vaccination location is valid.

Typestring

LocationState__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state where the vaccine was administered.

Typestring

LocationTelecom__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA contact detail for the location where the vaccine was administered.

Typetextarea

LocationText__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of the location where the vaccine was administered.

Typestring

LocationType__c

435

Electronic Health RecordsHealth Cloud Developer Guide

Page 440: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA type of location where the vaccine was administered.

Typestring

LocationUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to the location where the vaccine was administered.

Typestring

LotNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe lot number of the vaccine product that was administered.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe name of the vaccine product that was administered. Limit: 255 characters.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient who received or was to receive the vaccine. Lookup to EhrPatient__c.

Typereference

Performer__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe clinician who administered the vaccine. Lookup to EhrPractitioner__c.

Typestring

PerformerName255__c

436

Electronic Health RecordsHealth Cloud Developer Guide

Page 441: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe clinician who administered the vaccine. Limit: 255 characters.

Typetextarea

PerformerName__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the name of the clinician who administered the vaccine.

Typestring

ReasonCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the reason why a vaccination was administered.

Typestring

ReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the reason why a vaccination was administered.

Typestring

ReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the reason why a vaccination was administered.

Typestring

RefusalLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that indicates that the vaccine wasn’t administered.

Typestring

RefusalReasonCode__c

437

Electronic Health RecordsHealth Cloud Developer Guide

Page 442: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the reason why a vaccine wasn’t administrated.

Typeboolean

RefusedIndicator__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the vaccine was refused (true) or not (false). The default checkbox value isdeselected.

Typereference

Requestor__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe clinician who ordered the vaccine. Lookup to EhrPractitioner__c.

Typestring

RequestorName255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe clinician who ordered the vaccine. Limit: 255 characters.

438

Electronic Health RecordsHealth Cloud Developer Guide

Page 443: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

RequestorName__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the name of the clinician who ordered the vaccine.

Typestring

RouteCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the path through which the vaccine is taken intothe body.

Typestring

RouteLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the path through which the vaccine is taken intothe body.

Typestring

RouteSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the path through which the vaccine is taken into the body.

Typeboolean

SelfReported__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the vaccine is self-reported (true) or not (false). The default checkbox valueis deselected.

Typestring

SiteCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

439

Electronic Health RecordsHealth Cloud Developer Guide

Page 444: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents the body site where the vaccine was administered.

Typestring

SiteLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the body site where the vaccine was administered.

Typestring

SiteSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the body site where the vaccine was administered.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

VaccineTypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

440

Electronic Health RecordsHealth Cloud Developer Guide

Page 445: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of vaccine that was administered or was to be administered.

UsageThis resource excludes the administration of nonvaccine agents, even those that have or claim to have immunological effects.

EhrImmunizationReaction__cRepresents categorical data indicating that an adverse event is associated in time with an immunization.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

441

Electronic Health RecordsHealth Cloud Developer Guide

Page 446: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

Details__c

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the reaction.

Typereference

EhrObservation__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMeasurements and assertions made regarding a patient or device. Lookup toEhrObservation__c.

Typereference

Immunization__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionInformation about the administration of vaccines to patients. Lookup to EhrImmunization__c.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

442

Electronic Health RecordsHealth Cloud Developer Guide

Page 447: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR immunization reaction ID. Limit: 255 characters.

Typestring

Reaction255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails about a reaction that follows an immunization. Limit: 255 characters.

Typetextarea

Reaction__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of a reaction that follows an immunization.

443

Electronic Health RecordsHealth Cloud Developer Guide

Page 448: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

ReactionStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when the reaction to the immunization first occurred.

Typeboolean

SelfReported__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the reaction was self-reported (true) or not (false). The default checkbox valueis deselected.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrMedicationPrescription__cRepresents an order for supply of a medication and the instructions for administration of the medicine to a patient.

444

Electronic Health RecordsHealth Cloud Developer Guide

Page 449: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

TypedateTime

DateWritten__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date (and optionally time) when the prescription was written.

Typedouble

DispenseExpectedSupplyDuration__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe period of time over which the supplied product is expected to be used, or the length oftime the dispense is expected to last.

Note: In some situations, this attribute can be used instead of quantity to identifythe amount supplied by how long it’s expected to last rather than by the physicalquantity issued, for example, a 90-day supply of medication (based on an ordereddosage). This attribute is an estimate that can be influenced by external factors, sospecifying quantity is more precise.

Typestring

DispenseMedicationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that identifies the medication being administered.

Typestring

DispenseMedicationCodeSystem__c

445

Electronic Health RecordsHealth Cloud Developer Guide

Page 450: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the code that identifies this medication.

TypedateTime

DispenseMedicationExpiration__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when a specific batch of product expires.

Typeboolean

DispenseMedicationIsBrand__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.

Note: The manufacture doesn’t have to be known.

Typestring

DispenseMedicationKindCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

Typestring

DispenseMedicationKindLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

Typestring

DispenseMedicationKindSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

446

Electronic Health RecordsHealth Cloud Developer Guide

Page 451: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.

Typestring

DispenseMedicationLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that identifies and defines a medication.

Typestring

DispenseMedicationLotNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe assigned lot number of a batch of the specified product.

Typestring

DispenseMedicationName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA common commercial name for the medication.

Typestring

DispenseMedicationProductFormCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the form of the product: powder, tablet, or carton+ code.

Typestring

DispenseMedicationProductFormLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the form of the product: powder, tablet, or carton+ human-readable label.

447

Electronic Health RecordsHealth Cloud Developer Guide

Page 452: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

DispenseMedicationProductFormSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the form of the product: powder, tablet, or carton + system.

Typedouble

DispenseNumberOfRepeatedAllowed__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe number of allowed repeats of the medication dispense. For example, the number oftimes the prescribed quantity is to be supplied, including the initial standard fill.

Typestring

DispenseQuantityUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA unit of measurement in the amount to be dispensed for one fill.

Typedouble

DispenseQuantityValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe amount of medication to supply per dispense.

TypedateTime

DispenseValidityPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when the prescription is considered valid (not stale) by the prescriber. Dispensesmust not be made against the prescription after this date.

TypedateTime

DispenseValidityPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

448

Electronic Health RecordsHealth Cloud Developer Guide

Page 453: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe earliest date when the prescription can be filled for the first time. If not specified, theprescription is open-ended or defaults to a stale date based on regulations.

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn interaction between a patient and one or more healthcare providers for the purpose ofproviding the patient with healthcare services or assessing a patient’s health status. Lookupto EhrEncounter__c.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

449

Electronic Health RecordsHealth Cloud Developer Guide

Page 454: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

MedicationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that identifies a medication.

Typestring

MedicationCodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that identifies a medication.

Typestring

MedicationCodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a medication.

TypedateTime

MedicationExpiration__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when a specific batch of product expires.

Typeboolean

MedicationIsBrand__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

450

Electronic Health RecordsHealth Cloud Developer Guide

Page 455: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.

Note: The manufacturer doesn’t have to be known.

Typestring

MedicationKindCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

Typestring

MedicationKindLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

Typestring

MedicationKindSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.

Typestring

MedicationLotNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe assigned lot number of a batch of the specified product.

Typestring

MedicationName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

451

Electronic Health RecordsHealth Cloud Developer Guide

Page 456: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA common commercial name for the medication.

Typestring

MedicationProductFormCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

Typestring

MedicationProductFormLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring

MedicationProductFormSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR medication prescription ID. Limit: 255 characters.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe person to whom a medication will be given. Lookup to EhrPatient__c.

Typereference

Prescriber__c

452

Electronic Health RecordsHealth Cloud Developer Guide

Page 457: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe healthcare professional who’s responsible for authorizing the prescription. Lookup toEhrPractitioner__c.

Typestring

PrescriberName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe long text description of the name of the healthcare professional who’s responsible forauthorizing the prescription.

Typestring

ReasonCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the reason or indication for writing the prescription.

Typereference

ReasonCondition__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to EhrCondition__c.

Typestring

ReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the reason or indication for writing the prescription.

Typestring

ReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the reason or indication for writing the prescription.

453

Electronic Health RecordsHealth Cloud Developer Guide

Page 458: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

StatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe code that specifies the state of the order, typically active or completed.

Typestring

StatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that specifies the state of the order, typically active or completed.

Typestring

StatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the state of the order, typically active or completed.

454

Electronic Health RecordsHealth Cloud Developer Guide

Page 459: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

SubstituteRestrictReasonCode__c

PropertiesCreate, Nillable, Update

DescriptionThe system-defined code that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictTypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

455

Electronic Health RecordsHealth Cloud Developer Guide

Page 460: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines whether a different drug can be dispensed from what was prescribed.

EhrMedicationStatement__cRepresents a record of the medication that the patient takes or that was given to the patient,where the record is the result of a reportfrom the patient or another clinician.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe individual account that represents the patient in Lightning Platform

Typereference

Device__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA manufactured item that’s used in the providing of healthcare without being substantiallychanged through that activity. Lookup to EhrDevice__c.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

456

Electronic Health RecordsHealth Cloud Developer Guide

Page 461: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

MedicationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that identifies a medication.

Typestring

MedicationCodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

457

Electronic Health RecordsHealth Cloud Developer Guide

Page 462: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that identifies a medication.

Typestring

MedicationCodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a medication.

TypedateTime

MedicationExpiration__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when a specific batch of product expires.

Typeboolean

MedicationIsBrand__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the item is attributable to a specific manufacturer (true) or not (false). Thedefault checkbox value is deselected.

Note: The manufacturer doesn’t have to be known.

Typestring

MedicationKindCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

Typestring

MedicationKindLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the kind of medication. Medications are either asingle administrable product or a package that contains one or more products.

458

Electronic Health RecordsHealth Cloud Developer Guide

Page 463: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

MedicationKindSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the kind of medication. Medications are either a single administrableproduct or a package that contains one or more products.

Typestring

MedicationLotNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe assigned lot number of a batch of the specified product.

Typestring

MedicationName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA common commercial name for the medication.

Typestring

MedicationProductFormCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

Typestring

MedicationProductFormLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring

MedicationProductFormSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

459

Electronic Health RecordsHealth Cloud Developer Guide

Page 464: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR medication statement ID. Limit: 255 characters.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe person who’s taking the medication. Lookup to EhrPatient__c.

Typestring

ReasonNotGivenCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that indicates why the medication wasn’t taken.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

460

Electronic Health RecordsHealth Cloud Developer Guide

Page 465: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typeboolean

WasNotGiven__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionWhether the medication wasn’t taken (true) or was taken (false). The default checkboxvalue is deselected.

TypedateTime

WhenGiven__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe date when the medication was taken.

EhrObservation__cRepresents measurements and assertions made regarding a patient or device. Observations are a central element in healthcare, usedto support diagnosis, monitor progress, determine baselines and patterns, and even capture demographic characteristics.

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

461

Electronic Health RecordsHealth Cloud Developer Guide

Page 466: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

TypedateTime

AppliesDateTime__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe time or time period when the observed value is asserted as being true, usually the timeof a procedure or specimen collection. Often the source of the date or time isn’t known.Unless this observation is a historical report, a date is required.

TypedateTime

AppliesPeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last day when the observed value is asserted as being true.

TypedateTime

AppliesPeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first day when the observed value is asserted as being true.

Typestring

BodySiteCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the site on the patient’s body where the observationwas made (also called the target site).

Typestring

BodySiteLabel__c

462

Electronic Health RecordsHealth Cloud Developer Guide

Page 467: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the site on the patient’s body where the observationwas made (also called the target site).

Typestring

BodySiteSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the site on the patient’s body where the observation was made (alsocalled the target site).

Typetextarea

Comments__c

PropertiesCreate, Nillable, Update

DescriptionStatements about significant, unexpected, or unreliable values—or information about thesource of the observed value—that can be relevant to the interpretation of the result.

Typereference

Device__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe device that’s used to generate the observation data. Lookup to EhrDevice__c.

Typestring

InterpretationCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the assessment that’s made based on theobservation results. For some results, especially numeric results, an interpretation is necessaryto fully understand the significance of a result.

Typestring

InterpretationLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

463

Electronic Health RecordsHealth Cloud Developer Guide

Page 468: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents the assessment that’s made based on the resultof the observation. For some results, especially numeric results, an interpretation is necessaryto fully understand the significance of a result.

Typestring

InterpretationSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the assessment that’s made based on the result of the observation.For some results, especially numeric results, an interpretation is necessary to fully understandthe significance of a result.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

TypedateTime

IssuedDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date and time when the observation was made available. Updated when the result isupdated.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

464

Electronic Health RecordsHealth Cloud Developer Guide

Page 469: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

MethodCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the mechanism that’s used to perform theobservation. In some cases, method can impact results and is therefore used to determinewhether results can be compared or to determine the significance of results.

Typestring

MethodLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the mechanism that’s used to perform theobservation. In some cases, method can impact results and is therefore used to determinewhether results can be compared or to determine the significance of results.

Typestring

MethodSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

465

Electronic Health RecordsHealth Cloud Developer Guide

Page 470: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines the mechanism that’s used to perform the observation. In somecases, method can impact results and is therefore used to determine whether results can becompared or to determine the significance of results.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR observation ID. Limit: 255 characters.

Typestring

NameCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the name of the observation.

Typestring

NameLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the name of the observation.

Typestring

NameSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the name of the observation.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s name. Lookup to Ehr_Patient__c.

Typereference

Practitioner__c

466

Electronic Health RecordsHealth Cloud Developer Guide

Page 471: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA person with a formal responsibility in the providing of healthcare services. Lookup toEhrPractitioner__c.

Typestring

ReferenceMeaningLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the meaning of the applicable reference range,which provides guidance on how to interpret the observed value by comparison to a normalor recommended range. Specify what kind of reference range it is (for example, normal,recommended, or therapeutic), or what state this reference range applies to (for example,age or hormonal cycles).

Typestring

ReferenceRangeAgeHigh__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe age at the high end of the applicable reference range. Can be a neonatal age (for example,number of weeks at term). If this element is omitted, the high value of the reference rangeis assumed to be meaningless (for example, the reference range is > 5). If the low comparatoris missing , it’s assumed to be “<”.

Typestring

ReferenceRangeAgeLow__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe age at the low end of the applicable reference range. Can be a neonatal age (for example,number of weeks at term). If this element is omitted, the low value of the reference range isassumed to be meaningless (for example, the reference range is < 2). If the high comparatoris missing, it’s assumed to be “>”.

Typestring

ReferenceRangeHighUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the applicable reference range.

467

Electronic Health RecordsHealth Cloud Developer Guide

Page 472: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ReferenceRangeHighValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe value at the high end of the applicable reference range. If this element is omitted, thehigh value of the reference range is assumed to be meaningless. (for example, the referencerange is > 5). If the low comparator is missing, it’s assumed to be “<”.

Typestring

ReferenceRangeLowUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unit of measurement in the applicable reference range.

Typestring

ReferenceRangeLowValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe value at the low end of the applicable reference range. If this element is omitted, thelow value of the reference range is assumed to be meaningless. (for example, the referencerange is < 2). If the high comparator is missing, it’s assumed to be “>”.

Typestring

ReferenceRangeMeaningCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the meaning of the applicable reference range.Specify what kind of reference range it is (for example, normal, recommended, or therapeutic),or what state this reference range applies to (for example, age or hormonal cycles).

Typestring

ReferenceRangeMeaningSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the meaning of the applicable reference range.

468

Electronic Health RecordsHealth Cloud Developer Guide

Page 473: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ReferenceRangeUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA unit of measurement within the applicable reference range.

Typepicklist

Reliability__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn estimate of the degree to which quality issues have impacted the reported value. Picklistvalues: calibrating, early, error, ok, ongoing, and questionable.

Typestring

ReliabilityCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the estimate of the degree to which quality issueshave impacted the reported value.

Typestring

SampledData__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionData that comes from a series of measurements that were taken by a device, with upper andlower limits. Can include multiple dimensions.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

469

Electronic Health RecordsHealth Cloud Developer Guide

Page 474: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typepicklist

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe status of the observation’s result value. Picklist values: amended, final, preliminary, andregistered.

Typestring

StatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the status of the observation’s result value.

Typestring

ValueAttachment__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn attachment related to the observed value. Attachments include additional data contentdefined in other formats such as PDF, typically images or reports.

Typestring

ValueCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the information determined by making theobservation, if the information has a simple value.

470

Electronic Health RecordsHealth Cloud Developer Guide

Page 475: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ValueLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the information determined by making theobservation, if the information has a simple value.

Typestring

ValuePeriod__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe period during which the observed value is valid.

TypedateTime

ValuePeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when the observed value is valid.

TypedateTime

ValuePeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the observed value is valid.

Typestring

ValueQuantity__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA measured or potentially measurable amount related to the observed value.

Typestring

ValueQuantityUnit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

471

Electronic Health RecordsHealth Cloud Developer Guide

Page 476: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA unit of measurement related to the observed value.

Typestring

ValueRatio__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA relationship between two quantities, expressed as a numerator and a denominator, relatedto the observed value.

Typestring

ValueRatioDenominator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe denominator in the relationship between two quantities related to the observed value.

Typestring

ValueRatioNumerator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe numerator in the relationship between two quantities related to the observed value.

Typetextarea

ValueSampledData__c

PropertiesCreate, Nillable, Update

DescriptionData that comes from a series of measurements taken by a device, related to the observedvalue.

Typestring

ValueSampledDataDimensions__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe number of sample points at each time point in the sampled data. If this value is greaterthan one, all sample points for a point in time are recorded at the same time.

472

Electronic Health RecordsHealth Cloud Developer Guide

Page 477: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

ValueSampledDataFactor__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA correction factor that’s applied to the sampled data points before they’re added to theorigin.

Typestring

ValueSampledDataLowerLimit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe lower limit of detection of the measured points in the sampled data. Required if anydata points have the value L (lower than detection limit).

Typestring

ValueSampledDataOrigin__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe base quantity that a measured value of zero represents in the sampled data. This valueprovides the units of the entire measurement series.

Typestring

ValueSampledDataOriginCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeSystem__c

473

Electronic Health RecordsHealth Cloud Developer Guide

Page 478: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginComparator__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA comparator used with the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginUnits__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionUnits of measurement in the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable value used in the base quantity that a measured value of zero representsin the sampled data.

Typestring

ValueSampledDataPeriodMili__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

474

Electronic Health RecordsHealth Cloud Developer Guide

Page 479: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionA time period defined by a start and end date and optionally time, related to the sampleddata.

Typestring

ValueSampledDataUpperLimit__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe upper limit in data that comes from a series of measurements taken by a device.

Typestring

ValueSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the information determined by making the observation, if theinformation has a simple value.

UsageMost observations are simple name-value pair assertions with some metadata, but some observations group other observations togetherlogically, or even are multicomponent observations.

EhrPatient__cRepresents the demographics and other administrative information about a patient who’s receiving health-related services.

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

475

Electronic Health RecordsHealth Cloud Developer Guide

Page 480: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

476

Electronic Health RecordsHealth Cloud Developer Guide

Page 481: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address1Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient.

Typestring

Address1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

477

Electronic Health RecordsHealth Cloud Developer Guide

Page 482: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

478

Electronic Health RecordsHealth Cloud Developer Guide

Page 483: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

Address2Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient.

Typestring

Address2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

479

Electronic Health RecordsHealth Cloud Developer Guide

Page 484: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address3Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient.

Typestring

Address3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

480

Electronic Health RecordsHealth Cloud Developer Guide

Page 485: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

TypedateTime

Address4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

481

Electronic Health RecordsHealth Cloud Developer Guide

Page 486: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

Typetextarea

Address4Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient.

Typestring

Address4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

Typestring

Address5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient.

Typestring

Address5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient.

482

Electronic Health RecordsHealth Cloud Developer Guide

Page 487: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient is valid.

Typestring

Address5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient.

Typestring

Address5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient.

Typestring

Address5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient.

TypedateTime

Address5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient is valid.

Typestring

Address5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient.

483

Electronic Health RecordsHealth Cloud Developer Guide

Page 488: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

Address5Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient.

Typestring

Address5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient.

TypedateTime

BirthDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe patient’s birth date.

Typestring

Communication1Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication1Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

484

Electronic Health RecordsHealth Cloud Developer Guide

Page 489: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication2Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication2Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication3Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication3Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

485

Electronic Health RecordsHealth Cloud Developer Guide

Page 490: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication4Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication4Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typestring

Communication5Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

486

Electronic Health RecordsHealth Cloud Developer Guide

Page 491: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a language that can be used to communicate withthe patient about his or her health.

Typestring

Communication5Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that can be used to communicatewith the patient about his or her health.

Typestring

Communication5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that can be used to communicate with the patient abouthis or her health.

Typeboolean

Deceased__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the patient is deceased (true) or not (false). The default checkbox value isdeselected.

Typestring

FamilyName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).

487

Electronic Health RecordsHealth Cloud Developer Guide

Page 492: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

FamilyName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).

Typestring

GenderCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the gender that the patient is considered to havefor administration and record-keeping purposes.

Typestring

GenderSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the gender that the patient is considered to have for administrationand record-keeping purposes.

Typestring

GivenName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

488

Electronic Health RecordsHealth Cloud Developer Guide

Page 493: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typeboolean

IntegrationIsActive__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether integration is active (true) or not (false). The default checkbox value is selected.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

489

Electronic Health RecordsHealth Cloud Developer Guide

Page 494: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

MaritalStatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

490

Electronic Health RecordsHealth Cloud Developer Guide

Page 495: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe human-readable label that represents the patient’s most recent civil marital status.

Typestring

MaritalStatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the patient’s most recent civil marital status.

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typeboolean

MultipleBirth__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the patient is part of a multiple birth (true) or not (false). The default checkboxvalue is deselected.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe EHR patient ID. Limit: 255 characters.

Typetextarea

Name__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of a name associated with the patient.

Typestring

Organization255__c

491

Electronic Health RecordsHealth Cloud Developer Guide

Page 496: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization on behalf of which the patient contact is acting, for which the patientcontact is working, or that’s the custodian of the patient record. Limit: 255 characters.

Typetextarea

Organization__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization on behalf of which the patient contact is acting,for which the patient contact is working, or that’s the custodian of the patient record.

Typetextarea

PhotoUrl__c

PropertiesCreate, Nillable, Update

DescriptionThe URL for a photo of the patient.

Typestring

PrefixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first prefix in the patient’s name.

Typestring

PrefixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in the patient’s name.

Typestring

PrefixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in the patient’s name.

492

Electronic Health RecordsHealth Cloud Developer Guide

Page 497: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

SuffixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first suffix in the patient’s name.

Typestring

SuffixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second suffix in the patient’s name.

Typestring

SuffixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third suffix in the patient’s name.

493

Electronic Health RecordsHealth Cloud Developer Guide

Page 498: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Telecom1PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom1PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom1Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom2PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

494

Electronic Health RecordsHealth Cloud Developer Guide

Page 499: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom2PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom2Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom3PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

495

Electronic Health RecordsHealth Cloud Developer Guide

Page 500: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Telecom3PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom3Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom4PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom4PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

496

Electronic Health RecordsHealth Cloud Developer Guide

Page 501: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

Typestring

Telecom4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom4Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom5PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

TypedateTime

Telecom5PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient.

497

Electronic Health RecordsHealth Cloud Developer Guide

Page 502: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Telecom5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom5Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

UsageA patient record is typically created and maintained by each organization providing care for a patient. A patient receiving care at multipleorganizations can have information present in multiple patient resources.

EhrPatientCareProviderRepresents the patient’s nominated care provider.

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

Fields

DetailsField

Typeboolean

IsRestricted__c

498

Electronic Health RecordsHealth Cloud Developer Guide

Page 503: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

499

Electronic Health RecordsHealth Cloud Developer Guide

Page 504: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe EHR patient care provider ID. Limit: 255 characters.

Typestring

Organization255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization on behalf of which the patient contact is acting, for which the patientcontact is working, or that’s the custodian of the patient record. Limit: 255 characters.

Typetextarea

Organization__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization on behalf of which the patient contact is acting,for which the patient contact is working, or that’s the custodian of the patient record.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe patient’s name.

Typereference

Practitioner__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe practitioner’s name. Lookup to EhrPractitioner__c.

Typestring

PractitionerName255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe practitioner’s name. Limit: 255 characters.

Typestring

PractitionerName__c

500

Electronic Health RecordsHealth Cloud Developer Guide

Page 505: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe long text description of the practitioner’s name.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

Typestring

SourceSystemModified__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrPatientContact__cRepresents a contact party (for example, a guardian, partner, or friend) for the patient.

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

Fields

DetailsField

Typestring

Address1City__c

501

Electronic Health RecordsHealth Cloud Developer Guide

Page 506: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient contact.

Typestring

Address1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient contact.

TypedateTime

Address1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient contact.

Typestring

Address1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient contact.

Typestring

Address1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient contact.

TypedateTime

Address1StartDate__c

502

Electronic Health RecordsHealth Cloud Developer Guide

Page 507: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient contact.

Typetextarea

Address1Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient contact.

Typestring

Address1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

Address2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient contact.

Typestring

Address2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient contact.

TypedateTime

Address2EndDate__c

503

Electronic Health RecordsHealth Cloud Developer Guide

Page 508: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient contact.

Typestring

Address2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient contact.

Typestring

Address2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient contact.

TypedateTime

Address2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient contact.

Typetextarea

Address2Text__c

504

Electronic Health RecordsHealth Cloud Developer Guide

Page 509: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient contact.

Typestring

Address2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

Address3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient contact.

Typestring

Address3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient contact.

TypedateTime

Address3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient contact.

Typestring

Address3Line2__c

505

Electronic Health RecordsHealth Cloud Developer Guide

Page 510: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient contact.

Typestring

Address3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient contact.

TypedateTime

Address3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient contact.

Typetextarea

Address3Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient contact.

Typestring

Address3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

Address4City__c

506

Electronic Health RecordsHealth Cloud Developer Guide

Page 511: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient contact.

Typestring

Address4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient contact.

TypedateTime

Address4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient contact.

Typestring

Address4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient contact.

Typestring

Address4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient contact.

TypedateTime

Address4StartDate__c

507

Electronic Health RecordsHealth Cloud Developer Guide

Page 512: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient contact.

Typetextarea

Address4Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient contact.

Typestring

Address4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

Address5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the patient contact.

Typestring

Address5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the patient contact.

TypedateTime

Address5EndDate__c

508

Electronic Health RecordsHealth Cloud Developer Guide

Page 513: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the patient contact is valid.

Typestring

Address5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the patient contact.

Typestring

Address5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the patient contact.

Typestring

Address5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the patient contact.

TypedateTime

Address5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the patient contact is valid.

Typestring

Address5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the patient contact.

Typetextarea

Address5Text__c

509

Electronic Health RecordsHealth Cloud Developer Guide

Page 514: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Nillable, Update

DescriptionA complete address for the patient contact.

Typestring

Address5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the patient contact.

Typestring

FamilyName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient contact’s family name (Smith in Carol Smith Rodgers Andrews)

Typestring

FamilyName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient contact’s family name (Rodgers in Carol Smith RodgersAndrews)

Typestring

FamilyName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient contact’s family name (Andrews in Carol Smith RodgersAndrews)

Typestring

GenderCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

510

Electronic Health RecordsHealth Cloud Developer Guide

Page 515: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

GenderLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

Typestring

GenderSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the gender that the patient contact is considered to have foradministration and record-keeping purposes.

Typestring

GivenName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient contact’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName4__c

511

Electronic Health RecordsHealth Cloud Developer Guide

Page 516: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fourth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typestring

GivenName5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fifth name in the patient contact’s given name. (Lisa Marie is the given name of LisaMarie Smith.)

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

Description

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

512

Electronic Health RecordsHealth Cloud Developer Guide

Page 517: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Due date of the most recently closed task associated with the record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed this record.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR patient contact ID. Limit: 255 characters.

Typetextarea

Name__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the name of the patient contact.

Typestring

Organization255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization on behalf of which the contact is acting, for which the contact is working,or that’s the custodian of the patient record. Limit: 255 characters.

Typetextarea

Organization__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization on behalf of which the contact is acting, forwhich the contact is working, or that’s the custodian of the patient record.

Typereference

Patient__c

513

Electronic Health RecordsHealth Cloud Developer Guide

Page 518: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Sort

DescriptionThe patient’s name.

TypedateTime

PeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last day when the contact or organization is valid and can be contacted regarding thepatient.

TypedateTime

PeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first day when the contact or organization is valid and can be contacted regarding thepatient.

Typestring

PrefixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first prefix in a patient contact name.

Typestring

PrefixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in a patient contact name.

Typestring

PrefixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in a patient contact name.

514

Electronic Health RecordsHealth Cloud Developer Guide

Page 519: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

RelationshipCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the nature of the relationship between the patient and the patientcontact.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

515

Electronic Health RecordsHealth Cloud Developer Guide

Page 520: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

SuffixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first suffix in a patient contact name.

Typestring

SuffixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second suffix in a patient contact name.

Typestring

SuffixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third suffix in a patient contact name.

TypedateTime

Telecom1PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime

Telecom1PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

Typestring

Telecom1System__c

516

Electronic Health RecordsHealth Cloud Developer Guide

Page 521: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.

Typestring

Telecom1Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom2PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime

Telecom2PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

Typestring

Telecom2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

517

Electronic Health RecordsHealth Cloud Developer Guide

Page 522: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.

Typestring

Telecom2Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom3PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime

Telecom3PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

Typestring

Telecom3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

518

Electronic Health RecordsHealth Cloud Developer Guide

Page 523: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Telecom3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.

Typestring

Telecom3Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom4PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime

Telecom4PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

Typestring

Telecom4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom4Use__c

519

Electronic Health RecordsHealth Cloud Developer Guide

Page 524: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.

Typestring

Telecom4Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

TypedateTime

Telecom5PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

TypedateTime

Telecom5PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the patient contact.

Typestring

Telecom5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

520

Electronic Health RecordsHealth Cloud Developer Guide

Page 525: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the patient contact.

Typestring

Telecom5Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the patient.

EhrPractitioner__cRepresents a person who’s involved in the providing of healthcare.

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

Fields

DetailsField

Typestring

Address1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address1EndDate__c

521

Electronic Health RecordsHealth Cloud Developer Guide

Page 526: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

522

Electronic Health RecordsHealth Cloud Developer Guide

Page 527: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address1Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.

Typestring

Address2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

523

Electronic Health RecordsHealth Cloud Developer Guide

Page 528: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

524

Electronic Health RecordsHealth Cloud Developer Guide

Page 529: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address2Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.

Typestring

Address3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

525

Electronic Health RecordsHealth Cloud Developer Guide

Page 530: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

526

Electronic Health RecordsHealth Cloud Developer Guide

Page 531: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address3Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.

Typestring

Address4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

527

Electronic Health RecordsHealth Cloud Developer Guide

Page 532: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

528

Electronic Health RecordsHealth Cloud Developer Guide

Page 533: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address4Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.

Typestring

Address5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

529

Electronic Health RecordsHealth Cloud Developer Guide

Page 534: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address is valid as a postal address where the practitioner can befound or visited or to which mail can be delivered.

Typestring

Address5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

530

Electronic Health RecordsHealth Cloud Developer Guide

Page 535: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address5Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a postal address where the practitioner can be foundor visited or to which mail can be delivered.

TypedateTime

BirthDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe practitioner’s birth date, needed for identification.

Typestring

Communication1Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication1Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

531

Electronic Health RecordsHealth Cloud Developer Guide

Page 536: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Communication1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring

Communication2Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication2Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring

Communication3Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication3Label__c

532

Electronic Health RecordsHealth Cloud Developer Guide

Page 537: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring

Communication4Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication4Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring

Communication5Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

533

Electronic Health RecordsHealth Cloud Developer Guide

Page 538: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication5Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring

Communication5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring

FamilyName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the practitioner’s family name (Smith in Carol Smith Rodgers Andrews).

Typestring

FamilyName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the practitioner’s family name (Rodgers in Carol Smith Rodgers Andrews).

Typestring

FamilyName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the practitioner’s family name (Andrews in Carol Smith Rodgers Andrews).

534

Electronic Health RecordsHealth Cloud Developer Guide

Page 539: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Gender__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe gender that the practitioner is considered to have for administration and record-keepingpurposes, needed to address the practitioner correctly.

Typestring

GivenName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fourth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c

535

Electronic Health RecordsHealth Cloud Developer Guide

Page 540: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fifth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typestring

Location1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country associated with a location where the practitioner provides care.

Typestring

Location1Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of a location where the practitioner provides care.

536

Electronic Health RecordsHealth Cloud Developer Guide

Page 541: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location1Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location1Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of a location where the practitioner provides care.

Typestring

Location1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of a location where the practitioner provides care.

537

Electronic Health RecordsHealth Cloud Developer Guide

Page 542: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Location1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime

Location1TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime

Location1TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring

Location1TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring

Location1TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

538

Electronic Health RecordsHealth Cloud Developer Guide

Page 543: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring

Location1TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location1Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location1Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where the practitioner provides care.

Typestring

Location2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location2Country__c

539

Electronic Health RecordsHealth Cloud Developer Guide

Page 544: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country associated with a location where the practitioner provides care.

Typestring

Location2Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location2Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location2Name__c

540

Electronic Health RecordsHealth Cloud Developer Guide

Page 545: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of a location where the practitioner provides care

Typestring

Location2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime

Location2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime

Location2TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime

Location2TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

541

Electronic Health RecordsHealth Cloud Developer Guide

Page 546: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location2TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring

Location2TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring

Location2TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location2Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location2Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

542

Electronic Health RecordsHealth Cloud Developer Guide

Page 547: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home or office related to a location where the practitioner provides care.

Typestring

Location3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country associated with a location where the practitioner provides care.

Typestring

Location3Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location3Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

543

Electronic Health RecordsHealth Cloud Developer Guide

Page 548: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location3Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of a location where the practitioner provides care.

Typestring

Location3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime

Location3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime

Location3TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

544

Electronic Health RecordsHealth Cloud Developer Guide

Page 549: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime

Location3TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring

Location3TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring

Location3TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring

Location3TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location3Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of a location where the practitioner provides care.

545

Electronic Health RecordsHealth Cloud Developer Guide

Page 550: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location3Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office about a location where the practitioner provides care.

Typestring

Location4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country associated with a location where the practitioner provides care.

Typestring

Location4Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a location is valid as a location where the practitioner provides care.

546

Electronic Health RecordsHealth Cloud Developer Guide

Page 551: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location4Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location4Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of a location where the practitioner provides care.

Typestring

Location4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime

Location4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as a location where the practitioner provides care.

547

Electronic Health RecordsHealth Cloud Developer Guide

Page 552: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime

Location4TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime

Location4TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring

Location4TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring

Location4TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring

Location4TelecomValue__c

548

Electronic Health RecordsHealth Cloud Developer Guide

Page 553: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location4Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location4Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where the practitioner provides care.

Typestring

Location5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country associated with a location where the practitioner provides care.

549

Electronic Health RecordsHealth Cloud Developer Guide

Page 554: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location5Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location5Id__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location5Name__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of a location where the practitioner provides care.

550

Electronic Health RecordsHealth Cloud Developer Guide

Page 555: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Location5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime

Location5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime

Location5TelecomPeriodEnd__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime

Location5TelecomPeriodStart__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring

Location5TelecomSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

551

Electronic Health RecordsHealth Cloud Developer Guide

Page 556: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring

Location5TelecomUse__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring

Location5TelecomValue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location5Text__c

PropertiesCreate, Nillable, Update

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location5Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to a location where the practitioner provides care.

552

Electronic Health RecordsHealth Cloud Developer Guide

Page 557: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR practitioner ID. Limit: 255 characters.

Typestring

Name255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the practitioner. Limit: 255 characters.

Typetextarea

Name__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the practitioner’s name.

Typestring

Organization255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization where the practitioner performs the associated roles. Limit: 255 characters.

Typetextarea

Organization__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the organization where the practitioner performs the associatedroles.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

553

Electronic Health RecordsHealth Cloud Developer Guide

Page 558: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionID of the record owner.

Typestring

Period__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe period during which the practitioner is authorized to act as a practitioner in these rolesfor the organization.

Typetextarea

PhotoUrl__c

PropertiesCreate, Nillable, Update

DescriptionThe URL for a photo of the practitioner.

Typestring

PrefixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first prefix in the practitioner’s name.

Typestring

PrefixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in the practitioner’s name.

Typestring

PrefixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in the practitioner’s name.

Typestring

SourceSystem__c

554

Electronic Health RecordsHealth Cloud Developer Guide

Page 559: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

SpecialtyCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a specialty of the practitioner’s.

Typestring

SpecialtySystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner’s.

Typestring

SuffixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first suffix in the practitioner’s name.

Typestring

SuffixName2__c

555

Electronic Health RecordsHealth Cloud Developer Guide

Page 560: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second suffix in the practitioner’s name.

Typestring

SuffixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third suffix in the practitioner’s name.

TypedateTime

Telecom1PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime

Telecom1PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

556

Electronic Health RecordsHealth Cloud Developer Guide

Page 561: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Telecom1Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

TypedateTime

Telecom2PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime

Telecom2PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

Typestring

Telecom2Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

557

Electronic Health RecordsHealth Cloud Developer Guide

Page 562: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

TypedateTime

Telecom3PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime

Telecom3PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

Typestring

Telecom3Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

TypedateTime

Telecom4PeriodEndDate__c

558

Electronic Health RecordsHealth Cloud Developer Guide

Page 563: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime

Telecom4PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

Typestring

Telecom4Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

TypedateTime

Telecom5PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail is valid for the practitioner.

559

Electronic Health RecordsHealth Cloud Developer Guide

Page 564: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Telecom5PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home, office, or mobile related to contact information that can be used tocontact the practitioner.

Typestring

Telecom5Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the practitioner.

UsageThis resource covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formalresponsibilities. This resource is used for attribution of activities and responsibilities to these individuals.

EhrPractitionerIdentity__cRepresents external identities such as licenses and regional identifiers for a practitioner.

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

560

Electronic Health RecordsHealth Cloud Developer Guide

Page 565: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typestring

Description__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe description of the identifier.

Typereference

EhrPractitioner__c

PropertiesCreate, Filter, Group, Sort

DescriptionA person who’s involved in the providing of healthcare.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

Typestring

Name

561

Electronic Health RecordsHealth Cloud Developer Guide

Page 566: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR practitioner identity name. Limit: 255 characters.

Typestring

Organization__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization that the external identifier applies to. Limit: 255 characters.

Typedate

PeriodEndDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the identifier expires.

Typedate

PeriodStartDate

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first date when the identifier is active.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

562

Electronic Health RecordsHealth Cloud Developer Guide

Page 567: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the practitioner identity.

Typestring

TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the practitioner identity type.

Typestring

Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

Description

563

Electronic Health RecordsHealth Cloud Developer Guide

Page 568: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn identifier for the external system.

EhrPractitionerQualification__cRepresents qualifications obtained by the practitioner through training and certification.

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

Fields

DetailsField

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a practitioner qualification.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a practitioner qualification.

Typestring

CodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a practitioner qualification.

564

Electronic Health RecordsHealth Cloud Developer Guide

Page 569: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typestring

Issuer255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe organization that regulates and issues the qualification. Limit: 255 characters.

Typestring

Issue__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe long text description of the organization that regulates and issues the qualification.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

565

Electronic Health RecordsHealth Cloud Developer Guide

Page 570: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR practitioner qualification ID. Limit: 255 characters.

Typedate

PeriodEnd__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe last date when a qualification is valid.

Typedate

PeriodStart__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first date when a qualification is valid.

Typereference

Practitioner__c

PropertiesCreate, Filter, Group, Sort

DescriptionA person who’s involved in the providing of healthcare.

Typestring

SourceSystem__c

566

Electronic Health RecordsHealth Cloud Developer Guide

Page 571: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrPractitionerRole__cRepresents a list of roles that the practitioner can perform for a given time period.

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

Fields

DetailsField

Typereference

EhrPractitioner__c

PropertiesCreate, Filter, Group, Sort

DescriptionA person who’s involved in the providing of healthcare.

TypedateTime

EndDate__c

567

Electronic Health RecordsHealth Cloud Developer Guide

Page 572: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when the practitioner is authorized to act as a practitioner in these roles for theorganization.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR practitioner role ID. Limit: 255 characters.

Typestring

RoleCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

568

Electronic Health RecordsHealth Cloud Developer Guide

Page 573: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents the practitioner’s role.

Typestring

RoleLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the practitioner’s role.

Typestring

RoleSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the practitioner’s role.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Specialty1Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

569

Electronic Health RecordsHealth Cloud Developer Guide

Page 574: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty1Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner.

Typestring

Specialty2Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty2Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner.

Typestring

Specialty3Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

570

Electronic Health RecordsHealth Cloud Developer Guide

Page 575: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty3Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner.

Typestring

Specialty4Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty4Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner.

Typestring

Specialty5Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

571

Electronic Health RecordsHealth Cloud Developer Guide

Page 576: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty5Label__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a specialty of the practitioner.

TypedateTime

StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when the practitioner is authorized to act as a practitioner in these roles forthe organization.

EhrProcedure__cA medical action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counselingor hypnotherapy.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typereference

Account__c

572

Electronic Health RecordsHealth Cloud Developer Guide

Page 577: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe individual account that represents the patient.

Typestring

BodySite__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAnatomical location for the procedure.

Typestring

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHigh-level categorization of the procedure.

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndustry-standard name for the procedure.

Typestring

Complication__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionCode that identifies any resulting complication.

Typereference

Encounter__c

573

Electronic Health RecordsHealth Cloud Developer Guide

Page 578: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Sort, Update

DescriptionEncounter associated with the procedure.

Typetextarea

FollowUpInstructions__c

PropertiesCreate, Nillable, Update

DescriptionInstructions for follow-up care.

Typetextarea

ItemsUsed__c

PropertiesCreate, , , Nillable, , Update

DescriptionItems used during the procedure.

Typestring

Location__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPhysical location where the procedure was performed, such as a clinic or medical office.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the procedure.

Typeboolean

NotPerformed__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the procedure was not performed as scheduled.

Typestring

Outcome__c

574

Electronic Health RecordsHealth Cloud Developer Guide

Page 579: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionResult of the procedure.

TypedateTime

PerformedDateTime__c

PropertiesCreate, Filter, , Nillable, Sort, Update

DescriptionDate and time that the procedure was performed.

Typestring

Reason1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

Reason2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

Reason3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

Reason4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

ReasonNotPerformed__c

575

Electronic Health RecordsHealth Cloud Developer Guide

Page 580: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was not performed.

Typestring

Report__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the report related to the procedure.

Typereference

Request__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReference to the request for the procedure.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status_c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionStatus of the procedure. Picklist values: Completed, Entered in Error, In Progress, NotCompleted.

EhrProcedurePerformer__cA junction object that relates EhrProcedure__c and EhrPractitioner__c.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

576

Electronic Health RecordsHealth Cloud Developer Guide

Page 581: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

EHRPractitioner__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner involved in the procedure. Lookup to Practitioner__c.

Typereference

EHRProcedure__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionProcedure performed by the practitioner. Lookup to Procedure__c.

Typestring

PerformerRole__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPractitioner’s role during the procedure.

EhrProcedureRequest__cRepresents a request for a procedure to be performed. It can be used to represent a procedure that is planned, proposed, or ordered.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the person the procedure was performed on.

577

Electronic Health RecordsHealth Cloud Developer Guide

Page 582: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

BodySite__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAnatomical location for the procedure.

Typestring

Category__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionHigh-level categorization of the procedure.

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndustry-standard name for the procedure.

Typereference

Encounter__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionEncounter associated with the procedure.

Typetextarea

Notes__c

PropertiesCreate, Nillable, Update

DescriptionAdditional information about the procedure.

578

Electronic Health RecordsHealth Cloud Developer Guide

Page 583: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

OrderedBy__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the practitioner making the request.

TypedateTime

OrderedOn__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDate and time the request was created.

Typepicklist

Priority__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPriority of the procedure. Picklist values: ASAP, Routine, Stat, Urgent.

Typestring

Reason1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

Reason2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

Typestring

Reason3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

579

Electronic Health RecordsHealth Cloud Developer Guide

Page 584: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Reason4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionReason that the procedure was requested.

TypedateTime

ScheduledDateTime__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionScheduled date and time to perform the procedure.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionStatus of the procedure request. Picklist values: Accepted, Completed, Draft, In Progress, NotCompleted, Proposed, Received, Rejected, Requested, Suspended.

EhrProgram__cRepresents information about the program that the company is participating in. Programs include Medicare Chronic Care Management(CCM), Medicare accountable care organizations Hierarchical Condition Category (HCC) risk scoring, among others.

Supported Callscreate(), delete(), describeLayout(), getDeleted(), getUpdated(), query(), retrieve(), search(),undelete(), update(), upsert()

580

Electronic Health RecordsHealth Cloud Developer Guide

Page 585: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typedate

EndDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe date when the program ends.

Typeboolean

IsActive__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the program is active.

Typecurrency

Rate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe reimbursement rate for the measurement period of a patient’s program.

Typestring

ReportName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionName of the Wave report that uses this information.

Typedate

StartDate__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe date when the program begins.

Typedouble

Target__c

PropertiesCreate, Filter, Nillable, Sort, Update

581

Electronic Health RecordsHealth Cloud Developer Guide

Page 586: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionTarget time to be spent with the patient for the measurement period.

Typepicklist

TimeSpan__c

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionThe measurement period for the program. Picklist values: Annually, Monthly, Quarterly, andWeekly.

Typepicklist

UnitOfMeasure__c

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort, Update

DescriptionUnit of measurement for the time spent with the patient during the measurement perioddefined in the Target field. Picklist values: Minutes and Seconds.

Typestring

UserRoleField__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionTypes of users that qualify for evaluation during a time period, if applicable.

UsageUse this object to manage information about the programs that a company is participating in.

EhrRelatedObservation__cRepresents another observation that’s a component of a parent observation or that provides supporting information, context, or warningsabout the primary observation. Examples are components, previous observations, and statements of derivation.

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

582

Electronic Health RecordsHealth Cloud Developer Guide

Page 587: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

583

Electronic Health RecordsHealth Cloud Developer Guide

Page 588: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR related observation name. Limit: 255 characters.

Typereference

Observation__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe measurements and assertions made, regarding a patient or device, that this observationis related to.

Typereference

RelatedObservation__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe related observation. Lookup to EhrObservation__c.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

584

Electronic Health RecordsHealth Cloud Developer Guide

Page 589: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Type__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe type of relationship that exists with the target observation. Picklist values: derived-from,has-component, has-member, interfered-by, qualified-by, replaces, and sequel-to.

Typestring

TypeCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the type of relationship that exists with the targetobservation.

Typestring

TypeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the type of relationship that exists with the targetobservation.

Typestring

TypeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the type of relationship that exists with the target observation.

UsageSome observations have important relationships to other observations (for example, blood pressure = systolic + diastolic) or are derivedfrom other observations (for example, calculated apgar score). Typically an observation has either a value or a set of related observations.Some observations (for example apgar store) can have a value and related observations (for apgar, the observations from which themeasure is derived).

EhrRelatedPerson__cRepresents a person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’t have a formal responsibility in theprocess.

585

Electronic Health RecordsHealth Cloud Developer Guide

Page 590: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

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

Fields

DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort

DescriptionThe individual account that represents the patient in Lightning Platform.

Typestring

Address1City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the related person.

Typestring

Address1Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the related person.

TypedateTime

Address1EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the related person is valid.

Typestring

Address1Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the related person.

586

Electronic Health RecordsHealth Cloud Developer Guide

Page 591: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address1Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the related person.

Typestring

Address1PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the related person.

TypedateTime

Address1StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the related person is valid.

Typestring

Address1State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the related person.

Typetextarea

Address1Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the related person.

Typestring

Address1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the related person.

587

Electronic Health RecordsHealth Cloud Developer Guide

Page 592: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address2City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the related person.

Typestring

Address2Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the related person.

TypedateTime

Address2EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the related person is valid.

Typestring

Address2Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the related person.

Typestring

Address2Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the related person.

Typestring

Address2PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the related person.

588

Electronic Health RecordsHealth Cloud Developer Guide

Page 593: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address2StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the related person is valid.

Typestring

Address2State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the related person.

Typetextarea

Address2Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the related person.

Typestring

Address2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the related person.

Typestring

Address3City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the related person.

Typestring

Address3Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the related person.

589

Electronic Health RecordsHealth Cloud Developer Guide

Page 594: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address3EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the related person is valid.

Typestring

Address3Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the related person.

Typestring

Address3Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the related person.

Typestring

Address3PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the related person.

TypedateTime

Address3StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the related person is valid.

Typestring

Address3State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the related person.

590

Electronic Health RecordsHealth Cloud Developer Guide

Page 595: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typetextarea

Address3Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the related person.

Typestring

Address3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the related person.

Typestring

Address4City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the related person.

Typestring

Address4Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the related person.

TypedateTime

Address4EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the related person is valid.

Typestring

Address4Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the related person.

591

Electronic Health RecordsHealth Cloud Developer Guide

Page 596: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address4Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the related person.

Typestring

Address4PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the related person.

TypedateTime

Address4StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the related person is valid.

Typestring

Address4State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the related person.

Typetextarea

Address4Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the related person.

Typestring

Address4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the related person.

592

Electronic Health RecordsHealth Cloud Developer Guide

Page 597: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

Address5City__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe city in an address for the related person.

Typestring

Address5Country__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe country in an address for the related person.

TypedateTime

Address5EndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when an address for the related person is valid.

Typestring

Address5Line1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first line of a street address for the related person.

Typestring

Address5Line2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second line of a street address for the related person.

Typestring

Address5PostalCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe postal code of an address for the related person.

593

Electronic Health RecordsHealth Cloud Developer Guide

Page 598: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

Address5StartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when an address for the related person is valid.

Typestring

Address5State__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe state in an address for the related person.

Typetextarea

Address5Text__c

PropertiesCreate, Nillable, Update

DescriptionA complete address for the related person.

Typestring

Address5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionDetails such as home or office related to an address for the related person.

TypedateTime

BirthDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe related person’s birth date.

Typestring

FamilyName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the related person’s family name (Smith in Carol Smith Rodgers Andrews).

594

Electronic Health RecordsHealth Cloud Developer Guide

Page 599: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

FamilyName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the related person’s family name (Rodgers in Carol Smith RodgersAndrews).

Typestring

FamilyName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third name in the related person’s family name (Andrews in Carol Smith RodgersAndrews).

Typestring

Gender__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe related person’s gender.

Typestring

GivenName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

595

Electronic Health RecordsHealth Cloud Developer Guide

Page 600: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typestring

GivenName4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typestring

Language1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language2__c

596

Electronic Health RecordsHealth Cloud Developer Guide

Page 601: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language4__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language5__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

597

Electronic Health RecordsHealth Cloud Developer Guide

Page 602: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe EHR related person ID. Limit: 255 characters.

Typetextarea

NameFull__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the related person’s full name.

Typereference

Patient__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s name. Lookup to EhrPatient__c.

Typetextarea

PhotoUrl__c

PropertiesCreate, Nillable, Update

DescriptionThe URL to a photo of the related person.

598

Electronic Health RecordsHealth Cloud Developer Guide

Page 603: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

PrefixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first prefix in the related person’s name.

Typestring

PrefixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second prefix in the related person’s name.

Typestring

PrefixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third prefix in the related person’s name.

Typestring

Relationship__c

PropertiesCreate, Filter, Group, NillableSort, Update

DescriptionThe nature of the relationship between the patient and the related person.

Typestring

Role255__c

PropertiesCreate, Filter, Group, NillableSort, Update

DescriptionThe role of the related person. Limit: 255 characters.

Typetextarea

Role__c

PropertiesCreate, Nillable, Sort

DescriptionThe long text description of the role of the related person.

599

Electronic Health RecordsHealth Cloud Developer Guide

Page 604: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Typestring

Specialty255__c

PropertiesCreate, Filter, Group, NillableSort, Update

DescriptionThe related person’s specialty. Limit: 255 characters.

Typetextarea

Specialty__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the related person’s specialty.

Typestring

SuffixName1__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe first suffix in the related person’s name.

600

Electronic Health RecordsHealth Cloud Developer Guide

Page 605: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SuffixName2__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe second suffix in the related person’s name.

Typestring

SuffixName3__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe third suffix in the related person’s name.

TypedateTime

Telecom1PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime

Telecom1PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

Typestring

Telecom1System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom1Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

601

Electronic Health RecordsHealth Cloud Developer Guide

Page 606: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.

Typestring

Telecom1Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

TypedateTime

Telecom2PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime

Telecom2PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

Typestring

Telecom2System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom2Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

602

Electronic Health RecordsHealth Cloud Developer Guide

Page 607: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.

Typestring

Telecom2Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

TypedateTime

Telecom3PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime

Telecom3PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

Typestring

Telecom3System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom3Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

603

Electronic Health RecordsHealth Cloud Developer Guide

Page 608: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.

Typestring

Telecom3Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

TypedateTime

Telecom4PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime

Telecom4PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

Typestring

Telecom4System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom4Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

604

Electronic Health RecordsHealth Cloud Developer Guide

Page 609: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.

Typestring

Telecom4Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

TypedateTime

Telecom5PeriodEndDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe last date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

TypedateTime

Telecom5PeriodStartDate__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe first date when a contact detail (for example, a phone number or email address) can beused to contact the related person.

Typestring

Telecom5System__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom5Use__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

605

Electronic Health RecordsHealth Cloud Developer Guide

Page 610: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionDetails such as home, office, or mobile related to contact information (for example, a phonenumber or email address) that can be used to contact the related person.

Typestring

Telecom5Value__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe content details, such as the phone number, that can be used to contact the relatedperson.

EhrVaccinationProtocol__cRepresents information about the protocol under which a vaccine is administered.

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

Fields

DetailsField

Typestring

Authority255__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe authority who published the protocol. Limit: 255 characters.

Typetextarea

Authority__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the authority who published the protocol. Limit: 255 characters.

Typetextarea

Description__c

606

Electronic Health RecordsHealth Cloud Developer Guide

Page 611: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Nillable, Update

DescriptionThe long text description of the protocol under which a vaccine is administered.

Typestring

DoseReasonLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.

Typedouble

DoseSequence__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe dose number within a series of doses.

Typestring

DoseStatusCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusReasonCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

607

Electronic Health RecordsHealth Cloud Developer Guide

Page 612: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe system-defined code that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.

Typestring

DoseStatusReasonSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines an explanation as to why an immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines whether an immunization event counts or doesn’t count againstthe protocol.

Typestring

DoseTargetCode__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the disease that the dose targets.

Typestring

DoseTargetLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the disease that the dose targets.

Typestring

DoseTargetSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the disease that the dose targets.

608

Electronic Health RecordsHealth Cloud Developer Guide

Page 613: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

Immunization__c

PropertiesCreate, Filter, Group, Sort

DescriptionInformation about an immunization event.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

609

Electronic Health RecordsHealth Cloud Developer Guide

Page 614: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe EHR vaccination protocol ID. Limit: 255 characters.

Typestring

Series__s

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe name of the vaccine series: a possible path to achieve presumed immunity against adisease, within the context of an authority.

Typedouble

SeriesDoses__s

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe recommended number of doses for achieving immunity.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

610

Electronic Health RecordsHealth Cloud Developer Guide

Page 615: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

EhrVirtualDevice__cRepresents a group of related data items.

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

Fields

DetailsField

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the virtual device.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

611

Electronic Health RecordsHealth Cloud Developer Guide

Page 616: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR virtual device ID. Limit: 255 characters.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionThe ID of the user who owns this record.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

612

Electronic Health RecordsHealth Cloud Developer Guide

Page 617: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

EhrVirtualDeviceChannel__cRepresents the channel a virtual device operates on.

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

Fields

DetailsField

Typestring

Code__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system-defined code that represents the virtual device channel.

Typestring

CodeLabel__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe human-readable label that represents the virtual device channel.

Typestring

CodeSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe system that defines the virtual device channel.

613

Electronic Health RecordsHealth Cloud Developer Guide

Page 618: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

EhrVirtualDevice__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionA group of related data items. Lookup to EhrVirtualDevice__c.

Typeboolean

IsRestricted__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean

IsVisibleOnPatientCard__c

PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate

PropertiesFilter, Group, Nillable, Sort

DescriptionWhichever of the following is the most recent:

• Due date of the most recent event logged against the record.

• Due date of the most recently closed task associated with the record.

TypedateTime

LastReferencedDate

PropertiesFilter, Nillable, Sort

DescriptionThe time stamp that indicates when the current user last viewed a related record.

TypedateTime

LastViewedDate

PropertiesFilter, Nillable, Sort

614

Electronic Health RecordsHealth Cloud Developer Guide

Page 619: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe timestamp for when the current user last viewed this record. If this value is null, it’spossible that this record was referenced (LastReferencedDate) and not viewed.

Typetextarea

Metric__c

PropertiesCreate, Nillable, Update

DescriptionThe long text description of a piece of data reported by the device for the channel.

Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR virtual device channel name. Limit: 255 characters.

Typereference

Observation__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe data for the metric. Lookup to EhrObservation__c.

Typereference

OwnerId

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionID of the record owner.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionA name that identifies the system that created the record and owns update rights to it.

Typestring

SourceSystemId__c

615

Electronic Health RecordsHealth Cloud Developer Guide

Page 620: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

TypedateTime

SourceSystemModified__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe most recent date when the integration system wrote the record from the source record.

Health Cloud Associated Objects

This section provides a list of objects associated to Health Cloud standard objects with their standard fields.

Some fields may not be listed for some objects. To see the system fields for each object, see System Fields in the Object Reference forSalesforce and Lightning Platform.

To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspectthe WSDL or use a schema viewer.

StandardObjectNameFeedStandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the postsand feed-tracked changes of a standard object.

The object name is variable and uses StandardObjectNameFeed syntax. For example, AccountFeed represents the posts andfeed-tracked changes on an account record. We list the available associated feed objects at the end of this topic. For specific versioninformation, see the documentation for the standard object.

Supported Callsdelete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access RulesIn the internal org, users can delete all feed items they created. This rule varies in communities where threaded discussions anddelete-blocking are enabled. Community members can delete all feed items they created, provided the feed items don’t have contentnested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users withthe Modify All Data permission can delete threads.

To delete feed items they didn’t create, users must have one of these permissions:

• Modify All Data

• Modify All on the parent object, like Account for AccountFeed

616

Health Cloud Associated ObjectsHealth Cloud Developer Guide

Page 621: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• Moderate Chatter

Note: Users with the Moderate Chatter permission can delete only the feed items and comments they can see.

Only users with this permission can delete items in unlisted groups.

For more special access rules, if any, see the documentation for the standard object. For example, for AccountFeed, see the special accessrules for Account.

Fields

DetailsField

Typereference

BestCommentId

PropertiesFilter, Group, Nillable, Sort

DescriptionThe ID of the comment marked as best answer on a question post.

Typetextarea

Body

PropertiesNillable, Sort

DescriptionThe body of the post. Required when Type is TextPost. Optional when Type isContentPost or LinkPost.

Typeint

CommentCount

PropertiesFilter, Group, Sort

DescriptionThe number of comments associated with this feed item.

Typereference

ConnectionId

PropertiesFilter, Group, Nillable, Sort

DescriptionWhen a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy fieldcontains the ID of the system administrator. The ConnectionId contains the ID of thePartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for yourorganization.

617

StandardObjectNameFeedHealth Cloud Developer Guide

Page 622: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

InsertedById

PropertiesGroup, Nillable, Sort

DescriptionID of the user who added this item to the feed. For example, if an application migrates postsand comments from another application into a feed, the InsertedBy value is set to theID of the context user.

Typeboolean

isRichText

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the feed item Body contains rich text. Set IsRichText to true ifyou post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text.

Rich text supports the following HTML tags:

• <p>

Tip: Though the <br> tag isn’t supported, you can use <p>&nbsp;</p>to create lines.

• <a>

• <b>

• <code>

• <i>

• <u>

• <s>

• <ul>

• <ol>

• <li>

• <img>

The <img> tag is accessible only via the API and must reference files in Salesforcesimilar to this example: <img src="sfdc://069B0000000omjh"></img>

Note: In API version 35.0 and later, the system replaces special characters in rich textwith escaped HTML. In API version 34.0 and prior, all rich text appears as a plain-textrepresentation.

Typeint

LikeCount

618

StandardObjectNameFeedHealth Cloud Developer Guide

Page 623: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Sort

DescriptionThe number of likes associated with this feed item.

Typeurl

LinkUrl

PropertiesNillable, Sort

DescriptionThe URL of a LinkPost.

Typepicklist

NetworkScope

PropertiesGroup, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available in the default community, a specific community,or all communities. This field is available in API version 26.0 and later, if Salesforce Communitiesare enabled for your organization.

NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available. If left empty,the feed item is only available in the default community.

• AllNetworks—The feed item is available in all communities.

Note the following exceptions for NetworkScope:

• Only feed items with a Group or User parent can set a NetworkId or a null value forNetworkScope.

• For feed items with a record parent, users can set NetworkScope only toAllNetworks.

• You can’t filter a feed item on the NetworkScope field.

Typereference

ParentId

PropertiesFilter, Group, Sort

DescriptionID of the record that is tracked in the feed. The detail page for the record displays the feed.

Typereference

RelatedRecordId

619

StandardObjectNameFeedHealth Cloud Developer Guide

Page 624: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesGroup, Nillable, Sort

DescriptionID of the ContentVersion record associated with a ContentPost. This field is null for allposts except ContentPost.

Typestring

Title

PropertiesGroup, Nillable, Sort

DescriptionThe title of the feed item. When the Type is LinkPost, the LinkUrl is the URL andthis field is the link name.

Typepicklist

Type

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

DescriptionThe type of feed item. Values are:

• ActivityEvent—indirectly generated event when a user or the API adds a Taskassociated with a feed-enabled parent record (excluding email tasks on cases). Alsooccurs when a user or the API adds or updates a Task or Event associated with a caserecord (excluding email and call logging).

For a recurring Task with CaseFeed disabled, one event is generated for the series only.For a recurring Task with CaseFeed enabled, events are generated for the series and eachoccurrence.

• AdvancedTextPost—created when a user posts a group announcement and, inLightning Experience as of API version 39.0 and later, when a user shares a post.

• AnnouncementPost—Not used.

• ApprovalPost—generated when a user submits an approval.

• BasicTemplateFeedItem—Not used.

• CanvasPost—a post made by a canvas app posted on a feed.

• CollaborationGroupCreated—generated when a user creates a public group.

• CollaborationGroupUnarchived—Not used.

• ContentPost—a post with an attached file.

• CreatedRecordEvent—generated when a user creates a record from the publisher.

• DashboardComponentAlert—generated when a dashboard metric or gaugeexceeds a user-defined threshold.

• DashboardComponentSnapshot—created when a user posts a dashboardsnapshot on a feed.

620

StandardObjectNameFeedHealth Cloud Developer Guide

Page 625: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• LinkPost—a post with an attached URL.

• PollPost—a poll posted on a feed.

• ProfileSkillPost—generated when a skill is added to a user’s Chatter profile.

• QuestionPost—generated when a user posts a question.

• ReplyPost—generated when Chatter Answers posts a reply.

• RypplePost—generated when a user creates a Thanks badge in WDC.

• TextPost—a direct text entry on a feed.

• TrackedChange—a change or group of changes to a tracked field.

• UserStatus—automatically generated when a user adds a post. Deprecated.

Typepicklist

Visibility

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available to all users or internal users only. This field isavailable if Salesforce Communities are enabled for your organization.

Visibility can have the following values:

• AllUsers—The feed item is available to all users who have permission to see thefeed item.

• InternalUsers—The feed item is available to internal users only.

Note the following exceptions for Visibility:

• For record posts, Visibility is set to InternalUsers for all internal users bydefault.

• External users can set Visibility only to AllUsers.

• On user and group posts, only internal users can set Visibility toInternalUsers.

UsageA feed for an object is automatically created when a user enables feed tracking for the object. Use feeds to track changes to records. Forexample, AccountFeed tracks changes to an account record. Use feed objects to retrieve the content of feed fields, such as type of feedor feed ID.

Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root objectin the SOQL query.

Objects That Follow This ModelThese objects follow the standard pattern for associated feed objects.

621

StandardObjectNameFeedHealth Cloud Developer Guide

Page 626: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• AccreditationFeed

• BoardCertificationFeed

• CareBarrierDeterminantFeed

• CareBarrierFeed

• CareBarrierTypeFeed

• CareDeterminantFeed

• CareDeterminantTypeFeed

• CareDiagnosisFeed

• CareInterventionTypeFeed

• CareMetricTargetFeed

• CareObservationFeed

• CarePgmProvHealthcareProviderFeed

• CarePreauthFeed

• CarePreauthItemFeed

• CareProgramCampaignFeed

• CareProgramEligibilityRuleFeed

• CareProgramEnrolleeFeed

• CareProgramEnrolleeProductFeed

• CareProgramEnrollmentCardFeed

• CareProgramFeed

• CareProgramGoalFeed

• CareProgramProductFeed

• CareProgramProviderFeed

• CareProgramTeamMemberFeed

• CareProviderFacilitySpecialtyFeed

• CareRegisteredDevice

• CareRequestDrugFeed

• CareRequestExtensionFeed

• CareRequestFeed

• CareRequestItemFeed

• CareSpecialtyFeed

• CareTaxonomyFeed

• CoverageBenefitFeed

• CoverageBenefitItemFeed

• EnrollmentEligibilityCriteriaFeed

• HealthcareFacilityNetworkFeed

• HealthcarePayerNetworkFeed

• HealthcarePractitionerFacilityFeed

• HealthcareProviderFeed

• HealthcareProviderNpiFeed

622

StandardObjectNameFeedHealth Cloud Developer Guide

Page 627: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• HealthcareProviderSpecialtyFeed

• HealthcareProviderTaxonomyFeed

• MemberPlanFeed

• PlanBenefitFeed

• PlanBenefitItemFeed

• PurchaserPlanAssnFeed

• PurchaserPlanFeed

Objects That Don’t Follow This ModelThese objects don’t follow the standard pattern for associated feed objects.

• VisitedPartyFeed

• VisitorFeed

StandardObjectNameHistoryStandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent thehistory of changes to the values in the fields of a standard object.

The object name is variable and uses StandardObjectNameHistory syntax. For example, AccountHistory represents the history ofchanges to the values of an account record’s fields. We list the available associated history objects at the end of this topic. For specificversion information, see the documentation for the standard object.

Supported CallsdescribeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Special Access RulesFor specific special access rules, if any, see the documentation for the standard object. For example, for AccountHistory, see the specialaccess rules for Account.

Fields

DetailsField Name

Typereference

StandardObjectNameId

PropertiesFilter, Group, Sort

DescriptionID of the standard object.

Typepicklist

DataType

623

StandardObjectNameHistoryHealth Cloud Developer Guide

Page 628: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

DescriptionData type of the field that was changed.

Typepicklist

Field

PropertiesFilter, Group, Restricted picklist, Sort

DescriptionName of the field that was changed.

TypeanyType

NewValue

PropertiesNillable, Sort

DescriptionNew value of the field that was changed.

TypeanyType

OldValue

PropertiesNillable, Sort

DescriptionOld value of the field that was changed.

Objects That Follow This ModelThese objects follow the standard pattern for associated feed objects.

• AccreditationHistory

• BoardCertificationHistory

• CareBarrierDeterminantHistory

• CareBarrierHistory

• CareBarrierTypeHistory

• CareDeterminantHistory

• CareDeterminantTypeHistory

• CareDiagnosisHistory

• CareInterventionTypeHistory

• CareMetricTargetHistory

• CareObservationHistory

624

StandardObjectNameHistoryHealth Cloud Developer Guide

Page 629: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• CarePgmProvHealthcareProviderHistory

• CarePreauthHistory

• CarePreauthItemHistory

• CareProgramCampaignHistory

• CareProgramEligibilityRuleHistory

• CareProgramEnrolleeHistory

• CareProgramEnrolleeProductHistory

• CareProgramEnrollmentCardHistory

• CareProgramGoalHistory

• CareProgramHistory

• CareProgramProductHistory

• CareProgramProviderHistory

• CareProgramTeamMemberHistory

• CareProviderFacilitySpecialtyHistory

• CareRegisteredDeviceHistory

• CareRequestDrugHistory

• CareRequestExtensionHistory

• CareRequestHistory

• CareRequestItemHistory

• CareSpecialtyHistory

• CareTaxonomyHistory

• CoverageBenefitHistory

• CoverageBenefitItemHistory

• EnrollmentEligibilityCriteriaHistory

• HealthCareDiagnosisHistory

• HealthcareFacilityNetworkHistory

• HealthcarePayerNetworkHistory

• HealthcarePractitionerFacilityHistory

• HealthCareProcedureHistory

• HealthcareProviderHistory

• HealthcareProviderNpiHistory

• HealthcareProviderSpecialtyHistory

• HealthcareProviderTaxonomyHistory

• MemberPlanHistory

• PlanBenefitHistory

• PlanBenefitItemHistory

• PurchaserPlanAssnHistory

• PurchaserPlanHistory

• VisitedPartyHistory

• VisitorHistory

625

StandardObjectNameHistoryHealth Cloud Developer Guide

Page 630: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

StandardObjectNameOwnerSharingRuleStandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. Theseobjects represent a rule for sharing a standard object with users other than the owner.

The object name is variable and uses StandardObjectNameOwnerSharingRule syntax. For example,ChannelProgramOwnerSharingRule is a rule for sharing a channel program with users other than the channel program owner. We listthe available associated owner sharing rule objects at the end of this topic. For specific version information, see the standard objectdocumentation.

Note: To enable access to this object for your org, contact Salesforce customer support. However, we recommend that youinstead use Metadata API to programmatically update owner sharing rules because it triggers automatic sharing rule recalculation.The SharingRules Metadata API type is enabled for all orgs.

Supported Callscreate(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(),upsert()

Special Access RulesFor specific special access rules, if any, see the documentation for the standard object. For example, for ChannelProgramOwnerSharingRule,see the special access rules for ChannelProgram.

Fields

DetailsField Name

Typepicklist

AccessLevel

PropertiesCreate, Filter, Group, Restricted picklist, Sort, Update

DescriptionDetermines the level of access users have to records. Values are:

• Read (read only)

• Edit (read/write)

Typetextarea

Description

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionDescription of the sharing rule. Maximum length is 1000 characters.

Typestring

DeveloperName

626

StandardObjectNameOwnerSharingRuleHealth Cloud Developer Guide

Page 631: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe unique name of the object in the API. This name can contain only underscoresand alphanumeric characters, and must be unique in your org. It must begin witha letter, not include spaces, not end with an underscore, and not contain twoconsecutive underscores. In managed packages, this field prevents namingconflicts on package installations. With this field, a developer can change theobject’s name in a managed package and the changes are reflected in asubscriber’s organization.

Note: When creating large sets of data, always specify a uniqueDeveloperName for each record. If no DeveloperName isspecified, performance may slow while Salesforce generates one for eachrecord.

Typereference

GroupId

PropertiesCreate, Filter, Group, Sort

DescriptionID of the source group. Records that are owned by users in the source grouptrigger the rule to give access.

Typestring

Name

PropertiesCreate, Filter, Group, idLookup, Sort, Update

DescriptionLabel of the sharing rule as it appears in the UI. Maximum length is 80 characters.

Typereference

UserOrGroupId

PropertiesCreate, Filter, Group, Sort

DescriptionID of the user or group that you are granting access to.

Objects That Follow This ModelThese objects follow the standard pattern for associated feed objects.

• AccreditationOwnerSharingRule

• BoardCertificationOwnerSharingRule

627

StandardObjectNameOwnerSharingRuleHealth Cloud Developer Guide

Page 632: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• CareBarrierDeterminantOwnerSharingRule

• CareBarrierOwnerSharingRule

• CareBarrierTypeOwnerSharingRule

• CareDeterminantOwnerSharingRule

• CareDeterminantTypeOwnerSharingRule

• CareInterventionTypeOwnerSharingRule

• CareMetricTargetRule

• CarePreauthItemOwnerSharingRule

• CarePreauthOwnerSharingRule

• CareProgramEligibilityRuleOwnerSharingRule

• CareProgramEnrolleeProductOwnerSharingRule

• CareProgramEnrollmentCardOwnerSharingRule

• CareProgramGoalOwnerSharingRule

• CareProgramOwnerSharingRule

• CareProgramProductOwnerSharingRule

• CareProgramProviderOwnerSharingRule

• CareProviderFacilitySpecialtyOwnerSharingRule

• CareSpecialtyOwnerSharingRule

• CareTaxonomyOwnerSharingRule

• CoverageBenefitItemOwnerSharingRule

• CoverageBenefitOwnerSharingRule

• EnrollmentEligibilityCriteriaOwnerSharingRule

• HealthCareDiagnosisOwnerSharingRule

• HealthcareFacilityNetworkOwnerSharingRule

• HealthcarePayerNetworkOwnerSharingRule

• HealthcarePractitionerFacilityOwnerSharingRule

• HealthCareProcedureOwnerSharingRule

• HealthcareProviderNpiOwnerSharingRule

• HealthcareProviderOwnerSharingRule

• HealthcareProviderSpecialtyOwnerSharingRule

• HealthcareProviderTaxonomyOwnerSharingRule

• MemberPlanOwnerSharingRule

• PlanBenefitItemOwnerSharingRule

• PlanBenefitOwnerSharingRule

• PurchaserPlanAssnOwnerSharingRule

• PurchaserPlanOwnerSharingRule

• UnitOfMeasureRule

628

StandardObjectNameOwnerSharingRuleHealth Cloud Developer Guide

Page 633: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

StandardObjectNameShareStandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharingentry on the standard object.

The object name is variable and uses StandardObjectNameShare syntax. For example, AccountBrandShare is a sharing entry onan account brand. We list the available associated share objects at the end of this topic. For specific version information, see the standardobject documentation.

Supported Callscreate(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access RulesFor specific special access rules, if any, see the documentation for the standard object. For example, for AccountBrandShare, see thespecial access rules for AccountBrand.

Fields

DetailsField Name

Typepicklist

AccessLevel

PropertiesCreate, Filter, Group, Restricted picklist, Sort, Update

DescriptionThe level of access allowed. Values are:

• All (owner)

• Edit (read/write)

• Read (read only)

Typereference

ParentId

PropertiesCreate, Filter, Group, Sort

DescriptionID of the parent record.

Typepicklist

RowCause

PropertiesCreate, Filter, Group, Nillable, Restricted picklist, Sort

DescriptionReason that the sharing entry exists.

629

StandardObjectNameShareHealth Cloud Developer Guide

Page 634: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField Name

Typereference

UserOrGroupId

PropertiesCreate, Filter, Group, Sort

DescriptionID of the user or group that has been given access to the object.

Objects That Follow This ModelThese objects follow the standard pattern for associated feed objects.

• AccreditationShare

• BoardCertificationShare

• CareBarrierDeterminantShare

• CareBarrierShare

• CareBarrierTypeShare

• CareDeterminantShare

• CareDeterminantTypeShare

• CareInterventionTypeShare

• CareMetricTargetShare

• CarePreauthItemShare

• CarePreauthShare

• CareProgramEligibilityRuleShare

• CareProgramEnrolleeProductShare

• CareProgramEnrollmentCardShare

• CareProgramGoalShare

• CareProgramProductShare

• CareProgramProviderShare

• CareProgramShare

• CareProviderFacilitySpecialtyShare

• CareSpecialtyShare

• CareTaxonomyShare

• CoverageBenefitItemShare

• CoverageBenefitShare

• EnrollmentEligibilityCriteriaShare

• HealthCareDiagnosisShare

• HealthcareFacilityNetworkShare

• HealthcarePayerNetworkShare

• HealthcarePractitionerFacilityShare

630

StandardObjectNameShareHealth Cloud Developer Guide

Page 635: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

• HealthCareProcedureShare

• HealthcareProviderNpiShare

• HealthcareProviderShare

• HealthcareProviderSpecialtyShare

• HealthcareProviderTaxonomyShare

• MemberPlanShare

• PlanBenefitItemShare

• PlanBenefitShare

• PurchaserPlanAssnShare

• PurchaserPlanShare

• UnitOfMeasureShare

VisitedPartyFeedThis object represents the posts and feed-tracked changes of the VisitedParty object. This object is available in API version 49.0and later.

Supported Callsdelete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

DetailsField

Typereference

BestCommentId

PropertiesFilter, Group, Nillable, Sort

DescriptionThe ID of the comment marked as best answer on a question post.

Typetextarea

Body

PropertiesNillable, Sort

DescriptionThe body of the post. Required when Type is TextPost. Optional when Type is ContentPostor LinkPost.

Typeint

CommentCount

631

VisitedPartyFeedHealth Cloud Developer Guide

Page 636: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Sort

DescriptionThe number of comments associated with this feed item.

Typereference

InsertedById

PropertiesGroup, Nillable, Sort

DescriptionID of the user who added this item to the feed. For example, if an application migrates postsand comments from another application into a feed, the InsertedBy value is set to the ID ofthe context user.

Typeboolean

IsRichText

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the feed item Body contains rich text. Set IsRichText to true ifyou post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text.

Rich text supports the following HTML tags:

• <p>

Tip: Though the <br> tag isn’t supported, you can use <p>&nbsp;</p>to create lines.

• <a>

• <b>

• <code>

• <i>

• <u>

• <s>

• <ul>

• <ol>

• <li>

• <img>

The <img> tag is accessible only via the API and must reference files in Salesforcesimilar to this example: <img src="sfdc://069B0000000omjh"></img>

Typeint

LikeCount

632

VisitedPartyFeedHealth Cloud Developer Guide

Page 637: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Sort

DescriptionThe number of likes associated with this feed item.

Typeurl

LinkUrl

PropertiesNillable, Sort

DescriptionThe URL of a LinkPost.

Typepicklist

NetworkScope

PropertiesGroup, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available in the default community, a specific community,or all communities. This field is available in API version 26.0 and later, if Salesforce Communitiesare enabled for your organization.

NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available. If left empty,the feed item is only available in the default community.

• AllNetworks—The feed item is available in all communities.

Note the following exceptions for NetworkScope:

• Only feed items with a Group or User parent can set a NetworkId or a null value forNetworkScope.

• For feed items with a record parent, users can set NetworkScope only toAllNetworks.

• You can’t filter a feed item on the NetworkScope field.

Typereference

ParentId

PropertiesFilter, Group, Sort

DescriptionID of the record that is tracked in the feed. The detail page for the record displays the feed.

Typereference

RelatedRecordId

633

VisitedPartyFeedHealth Cloud Developer Guide

Page 638: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesGroup, Nillable, Sort

DescriptionID of the ContentVersion record associated with a ContentPost. This field is null for allposts except ContentPost.

Typestring

Title

PropertiesGroup, Nillable, Sort

DescriptionThe title of the feed item. When the Type is LinkPost, the LinkUrl is the URL andthis field is the link name.

Typepicklist

Type

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

Description

Possible values are:

• ActivityEvent

• AdvancedTextPost—created when a user posts a group announcement and whena user shares a post.

• AnnouncementPost

• ApprovalPost

• AttachArticleEvent

• BasicTemplateFeedItem—Basic Template Post

• CallLogPost

• CanvasPost—a post made by a canvas app posted on a feed.

• CaseCommentPost

• ChangeStatusPost

• ChatTranscriptPost

• CollaborationGroupCreated

• CollaborationGroupUnarchived

• ContentPost

• CreateRecordEvent

• DashboardComponentSnapshot

• EmailMessageEvent

• FacebookPost

634

VisitedPartyFeedHealth Cloud Developer Guide

Page 639: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• LinkPost

• MilestoneEvent

• PollPost

• ProfileSkillPost

• QuestionPost

• ReplyPost

• RypplePost—generated when a user creates a Thanks badge in WDC.

• SocialPost

• TextPost

• TrackedChange

• UserStatus

Typepicklist

Visibility

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available to all users or internal users only. This field isavailable if Salesforce Communities are enabled for your organization.

Visibility can have the following values:

• AllUsers—The feed item is available to all users who have permission to see thefeed item.

• InternalUsers—The feed item is available to internal users only.

Note the following exceptions for Visibility:

• For record posts, Visibility is set to InternalUsers for all internal users bydefault.

• External users can set Visibility only to AllUsers.

• On user and group posts, only internal users can set Visibility toInternalUsers.

UsageA feed for an object is automatically created when a user enables feed tracking for the object. Use feeds to track changes to records. Forexample, AccountFeed tracks changes to an account record. Use feed objects to retrieve the content of feed fields, such as type of feedor feed ID.

Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root objectin the SOQL query.

635

VisitedPartyFeedHealth Cloud Developer Guide

Page 640: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

VisitorFeedThis object represents the posts and feed-tracked changes of the Visitor object. This object is available in API version 49.0 and later.

Supported Callsdelete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()

Fields

DetailsField

Typereference

BestCommentId

PropertiesFilter, Group, Nillable, Sort

DescriptionThe ID of the comment marked as best answer on a question post.

Typetextarea

Body

PropertiesNillable, Sort

DescriptionThe body of the post. Required when Type is TextPost. Optional when Type is ContentPostor LinkPost.

Typeint

CommentCount

PropertiesFilter, Group, Sort

DescriptionThe number of comments associated with this feed item.

Typereference

InsertedById

PropertiesGroup, Nillable, Sort

DescriptionID of the user who added this item to the feed. For example, if an application migrates postsand comments from another application into a feed, the InsertedBy value is set to the ID ofthe context user.

Typeboolean

IsRichText

636

VisitorFeedHealth Cloud Developer Guide

Page 641: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the feed item Body contains rich text. Set IsRichText to true ifyou post a rich text feed item via SOAP API. Otherwise, the post is rendered as plain text.

Rich text supports the following HTML tags:

• <p>

Tip: Though the <br> tag isn’t supported, you can use <p>&nbsp;</p>to create lines.

• <a>

• <b>

• <code>

• <i>

• <u>

• <s>

• <ul>

• <ol>

• <li>

• <img>

The <img> tag is accessible only via the API and must reference files in Salesforcesimilar to this example: <img src="sfdc://069B0000000omjh"></img>

Typeint

LikeCount

PropertiesFilter, Group, Sort

DescriptionThe number of likes associated with this feed item.

Typeurl

LinkUrl

PropertiesNillable, Sort

DescriptionThe URL of a LinkPost.

Typepicklist

NetworkScope

637

VisitorFeedHealth Cloud Developer Guide

Page 642: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesGroup, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available in the default community, a specific community,or all communities. This field is available in API version 26.0 and later, if Salesforce Communitiesare enabled for your organization.

NetworkScope can have the following values:

• NetworkId—The ID of the community in which the FeedItem is available. If left empty,the feed item is only available in the default community.

• AllNetworks—The feed item is available in all communities.

Note the following exceptions for NetworkScope:

• Only feed items with a Group or User parent can set a NetworkId or a null value forNetworkScope.

• For feed items with a record parent, users can set NetworkScope only toAllNetworks.

• You can’t filter a feed item on the NetworkScope field.

Typereference

ParentId

PropertiesFilter, Group, Sort

DescriptionID of the record that is tracked in the feed. The detail page for the record displays the feed.

Typereference

RelatedRecordId

PropertiesGroup, Nillable, Sort

DescriptionID of the ContentVersion record associated with a ContentPost. This field is null for allposts except ContentPost.

Typestring

Title

PropertiesGroup, Nillable, Sort

DescriptionThe title of the feed item. When the Type is LinkPost, the LinkUrl is the URL andthis field is the link name.

638

VisitorFeedHealth Cloud Developer Guide

Page 643: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Type

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

Description

Possible values are:

• ActivityEvent

• AdvancedTextPost—created when a user posts a group announcement and whena user shares a post.

• AnnouncementPost

• ApprovalPost

• AttachArticleEvent

• BasicTemplateFeedItem—Basic Template Post

• CallLogPost

• CanvasPost—a post made by a canvas app posted on a feed.

• CaseCommentPost

• ChangeStatusPost

• ChatTranscriptPost

• CollaborationGroupCreated

• CollaborationGroupUnarchived

• ContentPost

• CreateRecordEvent

• DashboardComponentSnapshot

• EmailMessageEvent

• FacebookPost

• LinkPost

• MilestoneEvent

• PollPost

• ProfileSkillPost

• QuestionPost

• ReplyPost

• RypplePost—generated when a user creates a Thanks badge in WDC.

• SocialPost

• TextPost

• TrackedChange

• UserStatus

639

VisitorFeedHealth Cloud Developer Guide

Page 644: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

Visibility

PropertiesFilter, Group, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available to all users or internal users only. This field isavailable if Salesforce Communities are enabled for your organization.

Visibility can have the following values:

• AllUsers—The feed item is available to all users who have permission to see thefeed item.

• InternalUsers—The feed item is available to internal users only.

Note the following exceptions for Visibility:

• For record posts, Visibility is set to InternalUsers for all internal users bydefault.

• External users can set Visibility only to AllUsers.

• On user and group posts, only internal users can set Visibility toInternalUsers.

UsageA feed for an object is automatically created when a user enables feed tracking for the object. Use feeds to track changes to records. Forexample, AccountFeed tracks changes to an account record. Use feed objects to retrieve the content of feed fields, such as type of feedor feed ID.

Note the following SOQL restrictions. No SOQL limit if logged-in user has View All Data permission. If not, specify a LIMIT clause of1,000 records or fewer. SOQL ORDER BY on fields using relationships is not available. Use ORDER BY on fields on the root objectin the SOQL query.

Health Cloud Custom Fields on Standard Objects

Health Cloud adds custom fields to some standard Salesforce objects to represent information about individuals.

Account Custom Fields

Custom fields extend the standard Account object for use in Health Cloud to represent information about an individual.

Contact Custom Fields

Custom fields extend the standard Contact object for use in Health Cloud to represent information about an individual.

Lead Standard and Custom Fields

Standard and custom fields extend the Lead object for use in Health Cloud to represent information about an incoming patient.These fields are available only in orgs where Health Cloud is enabled.

640

Health Cloud Custom Fields on Standard ObjectsHealth Cloud Developer Guide

Page 645: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Opportunity Standard and Custom Fields

Standard and custom fields extend the Opportunity object for use in Health Cloud to represent information about an incomingpatient. These fields are available only in orgs where Health Cloud is enabled.

Task Custom Fields

Custom fields extend the standard Task object for use in Health Cloud to represent information about an individual.

Referral Management Custom Fields on Standard Objects

These custom fields on standard Salesforce objects support refefrral management.

Account Custom FieldsCustom fields extend the standard Account object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRefers to Case object. This field is the lookup to the care plan.

Typestring

IndividualId__c

PropertiesFilter, Nillable, Sort

DescriptionIdentifier for the individual.

Typepicklist

IndividualType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIdentifier for the individual, such as group or individual.

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe medical record number used to identify a patient.

641

Account Custom FieldsHealth Cloud Developer Guide

Page 646: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

PrimaryContact__c

PropertiesCreate, Filter, Group, Nillable, Sort

DescriptionRefers to Contact object.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort

DescriptionThe ID of an external record. This field can’t be encrypted.

Contact Custom FieldsCustom fields extend the standard Contact object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typestring

Age__c

PropertiesFilter, Nillable, Sort

DescriptionAge. Calculated from Contact.Birthdate.

Typestring

BirthDate__c

PropertiesFilter, Nillable, Sort

DescriptionDate of birth.

Typepicklist

CountryOfBirth__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

642

Contact Custom FieldsHealth Cloud Developer Guide

Page 647: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndividual’s country of birth.

Valid values:

• Afghanistan

• Aland Islands

• Albania

• Algeria

• Andorra

• Angola

• Anguilla

• Antarctica

• Antigua and Barbuda

• Argentina

• Armenia

• Aruba

• Australia

• Austria

• Azerbaijan

• Bahamas

• Bahrain

• Bangladesh

• Barbados

• Belarus

• Belgium

• Belize

• Benin

• Bermuda

• Bhutan

• Bolivia, Plurinational State of

• Bonaire, Sint Eustatius and Saba

• Bosnia and Herzegovina

• Botswana

• Bouvet Island

• Brazil

• British Indian Ocean Territory

• Brunei Darussalam

• Bulgaria

• Burkina Faso

643

Contact Custom FieldsHealth Cloud Developer Guide

Page 648: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Burundi

• Cambodia

• Cameroon

• Canada

• Cape Verde

• Cayman Islands

• Central African Republic

• Chad

• Chile

• China

• Christmas Island

• Cocos (Keeling) Islands

• Colombia

• Comoros

• Congo

• Congo, the Democratic Republic of the

• Cook Islands

• Costa Rica

• Cote d’Ivoire

• Croatia

• Cuba

• Curaçao

• Cyprus

• Czech Republic

• Denmark

• Djibouti

• Dominica

• Dominican Republic

• Ecuador

• Egypt

• El Salvador

• Equatorial Guinea

• Eritrea

• Estonia

• Ethiopia

• Falkland Islands (Malvinas)

• Faroe Islands

• Fiji

644

Contact Custom FieldsHealth Cloud Developer Guide

Page 649: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Finland

• France

• French Guiana

• French Polynesia

• French Southern Territories

• Gabon

• Gambia

• Georgia

• Germany

• Ghana

• Gibraltar

• Greece

• Greenland

• Grenada

• Guadeloupe

• Guatemala

• Guernsey

• Guinea

• Guinea-Bissau

• Guyana

• Haiti

• Heard Island and McDonald Islands

• Holy See (Vatican City State)

• Honduras

• Hungary

• Iceland

• India

• Indonesia

• Iran, Islamic Republic of

• Iraq

• Ireland

• Isle of Man

• Israel

• Italy

• Jamaica

• Japan

• Jersey

• Jordan

645

Contact Custom FieldsHealth Cloud Developer Guide

Page 650: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Kazakhstan

• Kenya

• Kiribati

• Korea, Democratic People’s Republic of

• Korea, Republic of

• Kuwait

• Kyrgyzstan

• Lao People’s Democratic Republic

• Latvia

• Lebanon

• Lesotho

• Liberia

• Libyan Arab Jamahiriya

• Liechtenstein

• Lithuania

• Luxembourg

• Macao

• Macedonia, the former Yugoslav Republic of

• Madagascar

• Malawi

• Malaysia

• Maldives

• Mali

• Malta

• Martinique

• Mauritania

• Mauritius

• Mayotte

• Mexico

• Moldova, Republic of

• Monaco

• Mongolia

• Montenegro

• Montserrat

• Morocco

• Mozambique

• Myanmar

• Namibia

646

Contact Custom FieldsHealth Cloud Developer Guide

Page 651: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Nauru

• Nepal

• Netherlands

• New Caledonia

• New Zealand

• Nicaragua

• Niger

• Nigeria

• Niue

• Norfolk Island

• Norway

• Oman

• Pakistan

• Palestine

• Panama

• Papua New Guinea

• Paraguay

• Peru

• Philippines

• Pitcairn

• Poland

• Portugal

• Qatar

• Reunion

• Romania

• Russian Federation

• Rwanda

• Saint Barthélemy

• Saint Helena, Ascension and Tristan da Cunha

• Saint Kitts and Nevis

• Saint Lucia

• Saint Martin (French part)

• Saint Pierre and Miquelon

• Saint Vincent and the Grenadines

• Samoa

• San Marino

• Sao Tome and Principe

• Saudi Arabia

647

Contact Custom FieldsHealth Cloud Developer Guide

Page 652: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Senegal

• Serbia

• Seychelles

• Sierra Leone

• Singapore

• Sint Maarten (Dutch part)

• Slovakia

• Slovenia

• Solomon Islands

• Somalia

• South Africa

• South Georgia and the South Sandwich Islands

• South Sudan

• Spain

• Sri Lanka

• Sudan

• Suriname

• Svalbard and Jan Mayen

• Swaziland

• Sweden

• Switzerland

• Syrian Arab Republic

• Taiwan

• Tajikistan

• Tanzania, United Republic of

• Thailand

• Timor-Leste

• Togo

• Tokelau

• Tonga

• Trinidad and Tobago

• Tunisia

• Turkey

• Turkmenistan

• Turks and Caicos Islands

• Tuvalu

• Uganda

• Ukraine

648

Contact Custom FieldsHealth Cloud Developer Guide

Page 653: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• United Arab Emirates

• United Kingdom

• United States

• Uruguay

• Uzbekistan

• Vanuatu

• Venezuela, Bolivarian Republic of

• Vietnam

• Virgin Islands, British

• Wallis and Futuna

• Western Sahara

• Yemen

• Zambia

• Zimbabwe

Typeboolean

CreatedFromLead__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the individual was created from a converted lead (true) or not (false).

Typepicklist

Gender__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionGender. Valid values:

• Female

• Male

• Decline to Specify

• Other

Typestring

IndividualId__c

PropertiesFilter, Nillable, Sort

DescriptionIdentifier for the individual.

649

Contact Custom FieldsHealth Cloud Developer Guide

Page 654: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

IndividualType__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionType of individual. Valid values:

• Individual

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typestring

PreferredName__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndividual’s preferred name.

Typepicklist

PrimaryLanguage__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionIndividual’s primary language.

Valid values:

• Abkhaz

• Adyghe

• Afrikaans

• Akan

• Albanian

• American Sign Language

• Amharic

• Ancient Greek

• Arabic

• Aragonese

• Aramaic

650

Contact Custom FieldsHealth Cloud Developer Guide

Page 655: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Armenian

• Aymara

• Balinese

• Basque

• Betawi

• Bosnian

• Breton

• Bulgarian

• Cantonese

• Catalan

• Cherokee

• Chickasaw

• Chinese

• Coptic

• Cornish

• Corsican

• Crimean Tatar

• Croatian

• Czech

• Danish

• Dawro

• Dutch

• English

• Esperanto

• Estonian

• Ewe

• Fiji Hindi

• Filipino

• Finnish

• French

• Galician

• Georgian

• German

• Greek, Modern

• Greenlandic

• Haitian Creole

• Hawaiian

• Hebrew

651

Contact Custom FieldsHealth Cloud Developer Guide

Page 656: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Hindi

• Hungarian

• Icelandic

• Indonesian

• Interlingua

• Inuktitut

• Irish

• Italian

• Japanese

• Javanese

• Kabardian

• Kalasha

• Kannada

• Kashubian

• Khmer

• Kinyarwanda

• Korean

• Kurdish/Kurdî

• Ladin

• Latgalian

• Latin

• Lingala

• Livonian

• Lojban

• Low German

• Lower Sorbian

• Macedonian

• Malay

• Malayalam

• Mandarin

• Manx

• Maori

• Mauritian Creole

• Middle Low German

• Min Nan

• Mongolian

• Norwegian

• Oriya

652

Contact Custom FieldsHealth Cloud Developer Guide

Page 657: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Pangasinan

• Papiamentu

• Pashto

• Persian

• Pitjantjatjara

• Polish

• Portuguese

• Proto-Slavic

• Quenya

• Rapa Nui

• Romanian

• Russian

• Sanskrit

• Scots

• Scottish Gaelic

• Serbian

• Serbo-Croatian

• Sinhalese

• Slovak

• Slovene

• Spanish

• Swahili

• Swedish

• Tagalog

• Tajik

• Tamil

• Tarantino

• Telugu

• Thai

• Tok Pisin

• Turkish

• Twi

• Ukrainian

• Upper Sorbian

• Urdu

• Uzbek

• Venetian

• Vietnamese

653

Contact Custom FieldsHealth Cloud Developer Guide

Page 658: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Vilamovian

• Volapük

• Võrro

• Welsh

• Xhosa

• Yiddish

• Zazaki

Typepicklist

SecondaryLanguage__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndividual’s secondary language.

Valid values:

• Abkhaz

• Adyghe

• Afrikaans

• Akan

• Albanian

• American Sign Language

• Amharic

• Ancient Greek

• Arabic

• Aragonese

• Aramaic

• Armenian

• Aymara

• Balinese

• Basque

• Betawi

• Bosnian

• Breton

• Bulgarian

• Cantonese

• Catalan

• Cherokee

• Chickasaw

• Chinese

654

Contact Custom FieldsHealth Cloud Developer Guide

Page 659: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Coptic

• Cornish

• Corsican

• Crimean Tatar

• Croatian

• Czech

• Danish

• Dawro

• Dutch

• English

• Esperanto

• Estonian

• Ewe

• Fiji Hindi

• Filipino

• Finnish

• French

• Galician

• Georgian

• German

• Greek, Modern

• Greenlandic

• Haitian Creole

• Hawaiian

• Hebrew

• Hindi

• Hungarian

• Icelandic

• Indonesian

• Interlingua

• Inuktitut

• Irish

• Italian

• Japanese

• Javanese

• Kabardian

• Kalasha

• Kannada

655

Contact Custom FieldsHealth Cloud Developer Guide

Page 660: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Kashubian

• Khmer

• Kinyarwanda

• Korean

• Kurdish/Kurdî

• Ladin

• Latgalian

• Latin

• Lingala

• Livonian

• Lojban

• Low German

• Lower Sorbian

• Macedonian

• Malay

• Malayalam

• Mandarin

• Manx

• Maori

• Mauritian Creole

• Middle Low German

• Min Nan

• Mongolian

• Norwegian

• Oriya

• Pangasinan

• Papiamentu

• Pashto

• Persian

• Pitjantjatjara

• Polish

• Portuguese

• Proto-Slavic

• Quenya

• Rapa Nui

• Romanian

• Russian

• Sanskrit

656

Contact Custom FieldsHealth Cloud Developer Guide

Page 661: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

• Scots

• Scottish Gaelic

• Serbian

• Serbo-Croatian

• Sinhalese

• Slovak

• Slovene

• Spanish

• Swahili

• Swedish

• Tagalog

• Tajik

• Tamil

• Tarantino

• Telugu

• Thai

• Tok Pisin

• Turkish

• Twi

• Ukrainian

• Upper Sorbian

• Urdu

• Uzbek

• Venetian

• Vietnamese

• Vilamovian

• Volapük

• Võrro

• Welsh

• Xhosa

• Yiddish

• Zazaki

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Unique, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

657

Contact Custom FieldsHealth Cloud Developer Guide

Page 662: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

SourceSystem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionAn external data source.

Lead Standard and Custom FieldsStandard and custom fields extend the Lead object for use in Health Cloud to represent information about an incoming patient. Thesefields are available only in orgs where Health Cloud is enabled.

Fields

DetailsField

Typereference

AssignCareCoordinatorContact__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to Contact object. If populated and the AssignCareCoordinatorUser__c field isblank, assigns the care coordinator role based on the contact record.

Typereference

AssignCareCoordinatorUser__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to User object. If populated, assigns the care coordinator role based on the userrecord.

Typedate

BirthDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s birthdate.

Typeboolean

CreatedFromLead__c

658

Lead Standard and Custom FieldsHealth Cloud Developer Guide

Page 663: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the individual was created from a converted lead (true) or not(false).

Typestring

InsuranceGroupId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionGroup ID of the patient or member’s insurance.

Typestring

InsuranceMemberId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMember ID of the patient or member’s insurace.

Typepicklist

InsuranceType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of primary insurance: Medicare, Medicaid, commercial or self-pay.

Typeboolean

IsMarkedForPatientConversion__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the lead will be converted to a patient record.

Typeboolean

IsOutOfNetwork__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates that the referral is out-of-network.

659

Lead Standard and Custom FieldsHealth Cloud Developer Guide

Page 664: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typedouble

NumberOfLocations__c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionNumber of locations associated with the lead.

Typepicklist

Primary__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the individual is the primary member of the household (true) or not(false).

Typereference

PrimaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

Typepicklist

PrimaryInsurance__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPrimary health insurance company associated with the patient.

Typepicklist

Priority__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

660

Lead Standard and Custom FieldsHealth Cloud Developer Guide

Page 665: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionPriority of the referral as designated by the referring provider.

Typepicklist

ReasonForOutOfNetworkReferral__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionReason the referral is sent out-of-network.

Typepicklist

ReasonForReferral__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionReason for the referral.

Typepicklist

ReferralStatus__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionIndicates status of referral processing.

Typereference

ReferredToOrganization__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the organization receiving or fulfilling the referral.

Typereference

ReferredToPractitioner__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the practitioner to whom the patient or member is being referred.

Typereference

ReferredToUser__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

661

Lead Standard and Custom FieldsHealth Cloud Developer Guide

Page 666: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionName of the user to whom the referral is sent.

Typereference

ReferringOrganization__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the referring organization.

Typereference

ReferringPractitioner__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the practitioner who submitted the referral.

Typereference

ReferringUser__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the user who submitted the referral.

Typereference

RelatedAccount__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLook up to the account of the patient or member who is being referred.

Typereference

SecondaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

662

Lead Standard and Custom FieldsHealth Cloud Developer Guide

Page 667: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionThe ID of an external record. This field can’t be encrypted.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe system that created the record and owns updating rights for it.

Typepicklist

Specialty__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionSpecialty associated with the referral.

Typereference

TertiaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

Typepicklist

TypeOfService__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionType of service requested.

Opportunity Standard and Custom FieldsStandard and custom fields extend the Opportunity object for use in Health Cloud to represent information about an incoming patient.These fields are available only in orgs where Health Cloud is enabled.

663

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 668: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Fields

DetailsField

Typereference

AssignCareCoordinatorContact__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to Contact object. If populated and the AssignCareCoordinatorUser__cfield is blank, assigns the care coordinator role based on the contact record.

Typereference

AssignCareCoordinatorUser__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionLookup to User object. If populated, assigns the care coordinator role based onthe user record.

Typedate

BirthDate__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe patient’s birthdate.

Typeboolean

CreatedFromLead__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates whether the individual was created from a converted lead (true) ornot (false).

Typereference

PrimaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

Typestring

InsuranceGroupId__c

664

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 669: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionGroup ID of the patient or member’s insurance.

Typestring

InsuranceMemberId__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionMember ID of the patient or member’s insurace.

Typepicklist

InsuranceType__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionType of primary insurance: Medicare, Medicaid, commercial or self-pay.

Typeboolean

IsMarkedForPatientConversion__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionWhether the lead will be converted to a patient record.

Typeboolean

IsOutOfNetwork__c

PropertiesCreate, Defaulted on create, Filter, Group, Sort, Update

DescriptionIndicates that the referral is out-of-network.

Typestring

MedicalRecordNumber__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe medical record number used to identify a patient.

Typedouble

NumberofLocations__c

665

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 670: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionNumber of locations associated with the lead.

Typepicklist

Primary__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionIndicates whether the individual is the primary member of the household (true)or not (false).

Typepicklist

PrimaryInsurance__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPrimary health insurance company associated with the patient.

Typepicklist

Priority__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionPriority of the referral as designated by the referring provider.

Typepicklist

ReasonForOutOfNetworkReferral__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionReason the referral is sent out-of-network.

Typepicklist

ReasonForReferral__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionReason for the referral.

666

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 671: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedate

ReferralReceivedDate__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionDate referral was received by the organization.

Typereference

ReferredToOrganization__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the organization receiving or fulfilling the referral.

Typereference

ReferredToPractitioner__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the practitioner to whom the patient or member is being referred.

Typereference

ReferredToUser__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the user to whom the referral is sent.

Typereference

ReferringOrganization__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the referring organization.

Typereference

ReferringPractitioner__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the practitioner who submitted the referral.

667

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 672: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typereference

ReferringUser__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionName of the user who submitted the referral.

Typereference

SecondaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionThe ID of an external record. This field can’t be encrypted.

Typestring

SourceSystem__c

PropertiesCreate, Defaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionThe system that created the record and owns updating rights for it.

Typepicklist

Specialty__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionSpecialty associated with the referral.

Typereference

TertiaryDiagnosis__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionLookup to the HealthcareDiagnosis object.

668

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Page 673: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typepicklist

TypeOfService__c

PropertiesCreate, Filter, Group, idLookup, Nillable, Sort, Update

DescriptionType of service requested.

Task Custom FieldsCustom fields extend the standard Task object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typereference

CarePlanGoal__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRepresents the intended objectives of carrying out a care plan.

Typereference

CarePlanProblem__c

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionRepresents the conditions, problems, concerns, diagnoses, and so on, whose managementand mitigation are handled by this plan.

Typedouble

SortOrder___c

PropertiesCreate, Filter, Nillable, Sort, Update

DescriptionThe order in which the task appears among other tasks associated with a goal.

Typepicklist

TaskType__c

669

Task Custom FieldsHealth Cloud Developer Guide

Page 674: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesCreate, Filter, Group, Nillable, Sort, Update

DescriptionThe list of healthcare-related tasks configured in the org.

Referral Management Custom Fields on Standard ObjectsThese custom fields on standard Salesforce objects support refefrral management.

ContactThese custom fields on the Contact standard object support referral management.

• ConvertedReferrals__c

• ReferrerScore__c

• TotalReferrals__c

LeadThese custom fields on the Lead standard object support referral management.

• Diagnosis__c

• InsuranceGroupId__c

• InsuranceMemberId__c

• InsuranceType__c

• IsOutOfNetwork__c

• PrimaryInsurance__c

• Priority__c

• ReasonForOutOfNetworkReferral__c

• ReasonForReferral__c

• ReferralStatus__c

• ReferredToOrganization__c

• ReferredToPractitioner__c

• ReferredToUser__c

• ReferringOrganization__c

• ReferringPractitioner__c

• ReferringUser__c

• RelatedAccount__c

• Specialty__c

• TypeOfService__c

670

Referral Management Custom Fields on Standard ObjectsHealth Cloud Developer Guide

Page 675: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

OpportunityThese custom fields on the Opportunity standard object support referral management.

• Diagnosis__c

• InsuranceGroupId__c

• InsuranceMemberId__c

• InsuranceType__c

• IsOutOfNetwork__c

• PrimaryInsurance__c

• Priority__c

• ReasonForOutOfNetworkReferral__c

• ReferralReceivedDate__c

• ReferredToOrganization__c

• ReferredToPractitioner__c

• ReferredToUser__c

• ReferringOrganization__c

• ReferringPractitioner__c

• ReferringUser__c

• Specialty__c

• TypeOfService__c

Patient Creation

When patients are first imported into Health Cloud, the information required to identify and represent those patients is created. Historicalmedical information associated with patients is not imported into Health Cloud by default; however, you can choose to map morehistorical information, as needed. You can implement a custom integration to import historical medical records from the EHR systemand append it to the default patient creation job flow.

Patient Creation Job Flow in Health Cloud

Each patient is initially represented in Health Cloud as a candidate for services that are managed in Health Cloud. As a result, eachpatient starts with a CandidatePatient__c record. The data copied to the Salesforce objects is based on mapping of fields betweenCandidatePatient__c and the appropriate Salesforce objects.

Create a Custom Apex Class for the Patient Creation Job Flow

Create a custom Apex class that extends a base class and implements an interface from the Health Cloud package. The custom classoverrides the methods in the base class and the interface.

Customize the Patient Conversion Process

Patient creation includes two processes: a job flow that creates the patients and then a mapping group that maps data from theCandidate Patient object to other patient objects.

671

Patient CreationHealth Cloud Developer Guide

Page 676: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Patient Creation Job Flow in Health CloudEach patient is initially represented in Health Cloud as a candidate for services that are managed in Health Cloud. As a result, each patientstarts with a CandidatePatient__c record. The data copied to the Salesforce objects is based on mapping of fields betweenCandidatePatient__c and the appropriate Salesforce objects.

When the candidate patient is converted, the patient creation process creates corresponding objects in Salesforce:

• An account and contact representing a patient

• A case representing a care plan

• A care team (case team) linked to the care plan coordinator user and the patient contact

The candidate patient record (CandidatePatient__c) is a cross-reference between the representation of a patient in the EHR system andin Health Cloud. The records are linked through the medical record number, which is represented in Salesforce by the MedicalRecord Number field. Salesforce uses the MedicalRecordNumber__c and SourceSystem__c fields to check for duplicatepatient records during the patient creation process. You can create a validation rule to verify that all candidate patient records havevalues in these fields before converting patient records.

The following diagram shows the patient creation job flow. This flow consists of two jobs that perform the steps that occur when acandidate patient record is converted. The third job (Invoke Patient EHR Migration) is a custom integration that you can implement tomigrate more data for that patient into Health Cloud.

672

Patient Creation Job Flow in Health CloudHealth Cloud Developer Guide

Page 677: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Create a Custom Apex Class for the Patient Creation Job FlowCreate a custom Apex class that extends a base class and implements an interface from the Health Cloud package. The custom classoverrides the methods in the base class and the interface.

Your Apex class extends the HealthCloudGA.MoiJobFlowFactory.MoiJobBase base class and implements theHealthCloudGA.MoiJobFlowFactory.MoiIJob interface from the Health Cloud package. Your class signature looks asfollows:

public with sharing class InvokePatientDataMigrateextends HealthCloudGA.MoiJobFlowFactory.MoiJobBaseimplements HealthCloudGA.MoiJobFlowFactory.MoiIJob { }

Your class overrides the following methods, which are in the base class.

boolean processJob(HealthCloudGA.MoiJobFlowFactory.MoiIJobContext flowCtxts)Override this method to implement the logic of your data migration job that is part of the patient creation flow. In this method, youcall another method to make a callout to the external EHR system to get more medical records for the patient.

673

Create a Custom Apex Class for the Patient Creation JobFlow

Health Cloud Developer Guide

Page 678: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

The patient creation job flow runs all the jobs as a single Apex transaction. Partial data changes aren’t saved when an error occursbecause all changes are rolled back in that transaction. Any callouts must be invoked from a future method so that the data fromthe first two jobs is saved even if the callout fails. Future methods are executed asynchronously, in the background. For example,this method signature represents the callout utility method in our sample.

@Future(callout=true)private static void invokeIntegration(String jsonPatientIds)

The type of the parameter passed to the processJob() method is theHealthCloudGA.MoiJobFlowFactory.MoiIJobContext class, installed from the Health Cloud package. The patientcreation job flow uses this context object to pass information about the created objects to the next job. The jobs for creating a patientpopulate this context object with the account and contact. Next, the job for creating the care plan accesses the objects in the contextto link the case (care plan record type) to CaseTeam members. You can use the objects in the context parameter to discover whichobjects have been created in Health Cloud and link them to the EHR system. The objects you can access from the flowCtxtsparameter are:

• Account

• Contact

• CandidatePatient__c

• Case (CarePlan record type)

You can obtain these objects by calling getContextData() on the flowCtxts parameter. The getContextData()method returns a list of maps. Each map corresponds to the context of one patient and contains the objects related to that patient.The map is keyed by the name of the object. For example, this snippet shows how to get the CandidatePatient__c object from areturned map object:

for (Map<String, Object> flowCtxt : flowCtxts.getContextData()) {HealthCloudGA__CandidatePatient__c candidatePatient =

(HealthCloudGA__CandidatePatient__c)flowCtxt.get('CandidatePatient__c'); }

HealthCloudGA.MoiJobFlowFactory.MoiIErrorHandler getErrorHandler()Override this method to add error handling logic when an exception is thrown from processJob(). This method returns aninstance of a class that performs error handling. The class performing the error handling must implement theHealthCloudGA.MoiJobFlowFactory.MoiIErrorHandler interface and override its method:

public void handleError(HealthCloudGA.MoiJobFlowFactory.MoiIJobContext context, Exceptione)

We’ve provided a sample Apex class that you can copy and modify to suit your needs. The implementation of the callout in theinvokeIntegration helper method is not provided and is left for you to provide. Details of how to communicate with the serviceendpoint and fetch data differs based on what you want to accomplish. For information about how to make callouts from Apex, seeInvoking Callouts Using Apex in the Lightning Platform Apex Code Developer's Guide.

You can create an Apex class by using various tools. This walkthrough uses the Developer Console.

1. From Setup, click Your Name and then click Developer Console to open the Developer Console.

2. Click File > New > Apex Class.

3. Enter InvokePatientDataMigrate for the class name, and then press OK.

4. Delete the auto-generated content and paste the following sample.

public with sharing class InvokePatientDataMigrate extendsHealthCloudGA.MoiJobFlowFactory.MoiJobBase

implements HealthCloudGA.MoiJobFlowFactory.MoiIJob {

674

Create a Custom Apex Class for the Patient Creation JobFlow

Health Cloud Developer Guide

Page 679: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

private static final String CTXTVAR_ACCOUNT = 'Account';private static final String CTXTVAR_CONTACT = 'Contact';private static final String CTXTVAR_CAREPLAN = 'CarePlan';private static final String CTXTVAR_CANDIDIATEPATIENT = 'CandidatePatient__c';

public with sharing class IntegrationErrorHandler implementsHealthCloudGA.MoiJobFlowFactory.MoiIErrorHandler {

public void handleError(HealthCloudGA.MoiJobFlowFactory.MoiIJobContext context,

Exception e) {// Code can be placed here to address the failureSystem.debug('Exception: '+e+' thrown on Job with context '+context);//No Exception

}}

public override HealthCloudGA.MoiJobFlowFactory.MoiIErrorHandler getErrorHandler(){

return (HealthCloudGA.MoiJobFlowFactory.MoiIErrorHandler)new IntegrationErrorHandler();

}

// Invokes asynchronous migration of patient data for list of patient identifiers@Future(callout=true)private static void invokeIntegration(String jsonPatientIds){

String SalesforceOrgId = System.UserInfo.getOrganizationId();

////////////////////////////////////////////////////////////////////// Make call to integration system passing patient Identifiers// and organization Id.// Integration System should respond asynchronously by push Patient// EHR records to the org.////////////////////////////////////////////////////////////////////

}

private class PatientId{public PatientId(String MedicalRecordNumber, Id accountId, Id contactId,

Id carePlanId){this.SFDCMedicalRecordNumber = MedicalRecordNumber;this.SFDCAccountId = accountId;this.SFDCContactId = contactId;this.carePlanId = carePlanId;

}// Id of account created in CreateIndividual Jobpublic Id SFDCAccountId;// Id of contact created in CreateIndividual Jobpublic Id SFDCContactId;// Id of Careplan created in CreateCarePlan jobpublic Id carePlanId;// Medical Record Number of patient in external Electronic// Health Record System

675

Create a Custom Apex Class for the Patient Creation JobFlow

Health Cloud Developer Guide

Page 680: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

public String SFDCMedicalRecordNumber;

}

// Override processJob method to be called when this job is invoked// by MoiJobFlowManager.public override boolean processJob(HealthCloudGA.MoiJobFlowFactory.MoiIJobContext

flowCtxts) {

System.debug('Entered InvokeIntegration.processJob');// Compile List of strings with Patient Ids// {CandidatePatient__c.MedicalRecordNumber_c, Account.Id and Contact.Id}// to pass to integration system to invoke asynchronous publish// of patient EHR records.List<PatientId> patientIds = new List<PatientId>();

for (Map<String, Object> flowCtxt : flowCtxts.getContextData()) {HealthCloudGA__CandidatePatient__c candidatePatient =

(HealthCloudGA__CandidatePatient__c)flowCtxt.get(CTXTVAR_CANDIDIATEPATIENT);

if (candidatePatient == null ||candidatePatient.HealthCloudGA__MedicalRecordNumber__c == '')throw new IntegrationException(

'Failure: No CandidatePatient record set. ' + candidatePatient);

patientIds.add(new PatientId(candidatePatient.HealthCloudGA__MedicalRecordNumber__c,

((Account)flowCtxt.get(CTXTVAR_ACCOUNT)).Id,((Contact)flowCtxt.get(CTXTVAR_CONTACT)).Id,((Case)flowCtxt.get(CTXTVAR_CAREPLAN)).Id)

);}/* for Flow Ctxts (on for each patient in creation flow */

System.debug('Calling future method InvokeIntegration('+patientIds+')');invokeIntegration(JSON.serializePretty(patientIds));return true;

} // processJob()

class IntegrationException extends Exception{}} //class InvokePatientDataMigrate

5. Click File > Save.

Register a Remote Site — Before the callout in this integration can be made, the service endpoint must be registered as a remote sitein Salesforce. To register the remote site:

1. From Setup, enter Remote Site Settings in the Quick Find box, then select Remote Site Settings.

2. Click New Remote Site.

3. Enter a descriptive term for the Remote Site Name. For example, ClinicalIntegrationEndPoint.

4. Enter the URL for the remote site.

5. Optionally, enter a description of the site.

6. Click Save.

676

Create a Custom Apex Class for the Patient Creation JobFlow

Health Cloud Developer Guide

Page 681: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Customize the Patient Conversion ProcessPatient creation includes two processes: a job flow that creates the patients and then a mapping group that maps data from the CandidatePatient object to other patient objects.

The settings that control these processes are available for customization so that you can control how patient creation and data mappingoccur in your org. From Setup, enter Custom metadata in the Quick Find box, then select Custom Metadata Types.

• Health Cloud Setting (1) contains the configuration values for processes like the job flow that creates patients.

• Job Flow Data Mapping (2) holds the rules that determine which fields from the Candidate Patient object get mapped to patientobjects like Account, Contact, and Case.

• Job Flow Setting (3) contains the actual job flows that execute in the patient creation process.

You can customize the delivered patient creation job flow by creating your own custom Apex class and adding your own job, changingthe order in which the jobs run, or overriding the job entirely and using your own job flow. You can also change which fields are mappedduring patient creation.

Health Cloud SettingsHealth Cloud Settings contains a variety of key/value pairs of configuration settings for the Health Cloud application. This includes thetwo default settings that control which flow to use when creating patients. PatientCreateFlow_default controls which jobflow to use when creating patients and PatientCreateMappingGroup__default controls which group of mappings is used.You can deactivate either of these records and create your own patient creation flow or mapping group.

When creating your own job flows, you must rename the Setting Name and Setting Value fields. For readability, it’s helpfulto make the object name and label of Health Cloud Setting record be a combination of the setting name and something about the newvalue. For example, you can rename PatientCreateFlow_default to PatientCreateFlow_mynewflow.

To learn more about overriding one of the Health Cloud job settings, see Use Custom Metadata Settings to Configure Health Cloud.

Patient Creation and Data Mapping Job FlowsYou can also add new steps to the patient creation job flow or add new mappings to the data mapping process. To deactivate a step inthe job flow, deselect the Active field for the record.

Override the Health Cloud Job Flows

You can override either of the delivered jobs in the default patient creation job flow and use your own custom job to create patientsor to map patient data from the source record system.

677

Customize the Patient Conversion ProcessHealth Cloud Developer Guide

Page 682: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Add Your Job to the Patient Creation Job Flow

Create a JobFlowSetting custom metadata record for every job that you want executed. Whether you have chosen to add a job tothe existing patient creation job flow, or have defined an entirely new patient creation job flow, create a new record.

Data Mapping to Health Cloud Objects

When a patient is converted, Health Cloud copies patient data from CandidatePatient__c to the corresponding Account, Contact,and Case (CarePlan record type) objects. A mapping defines how patient data maps to the fields in the destination Salesforce objects.This mapping is specified in the JobFlowDataMapping__mdt custom metadata object.

SEE ALSO:

Use Custom Metadata Settings to Configure Health Cloud

Add Your Job to the Patient Creation Job Flow

Data Mapping to Health Cloud Objects

Override the Health Cloud Job FlowsYou can override either of the delivered jobs in the default patient creation job flow and use your own custom job to create patients orto map patient data from the source record system.

Your custom integration consists of an Apex class that extends a base class and implements an interface from the Health Cloud package.The previous job passes your job relevant patient record information through a context parameter. By providing your own implementationfor this custom job, you can choose which patient records you want to migrate to Health Cloud.

Because Health Cloud populates objects with minimal information when a patient is converted, you can add a custom integration toimport more medical records. To migrate more data, append your custom integration as the last job in the patient creation job flow.You can also deactivate either of the delivered jobs and add your own customized job instead. Or, you can override the entire deliveredjob flow and instead use a custom job flow that you create.

Useful data migrations after a candidate patient has been converted in Health Cloud might include:

• Import medical records for a patient from the EHR system, such as:

– The full patient record

– Encounters

– Conditions

– Observations

– Diagnosis

– Treatments

• Flag EHR patient data to be published to Health Cloud if it is changed or created.

• Establish cross-references of patient records between Health Cloud and the EHR system. This cross-reference linkage enables postingdata back to the EHR system through another integration. For example, when one of the following records is created in Health Cloud,it can be updated in the EHR system later.

– Encounters: phone calls to the patient, emails, or Chatter messages

– Observations: Performed remotely by patient or caregivers, or performed by devices

Note: EHR systems can update only the records they create. If records were created in an external system and were migrated,they are viewable, but not editable in the current system.

You can deactivate the delivered jobs and use your own custom job when you create and activate a new record with the same job flowname. Since you’re not deleting the delivered setting, you can reactivate it and use it in the future.

678

Customize the Patient Conversion ProcessHealth Cloud Developer Guide

Page 683: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

1. From Setup, enter Custom Metadata in the Quick Find box, then select Custom Metadata Types.

2. Click Health Cloud Setting, then click Manage Health Cloud Settings.

3. Click name of the setting you want to change and click Edit.

• To override the delivered patient creation job, click PatientCreateFlow_default.

• To override the delivered patient data mapping job, click PatientCreateMappingGroup_default

4. Clear the Active checkbox and then click Save.

5. Navigate back to the Health Cloud Settings page, and click New, and fill out the information for your custom job and Apex class.

Make sure to use the same Setting Name as the default job flow that you are overriding. For example, PatientCreateFlow,if you are overriding the default patient creation job flow with your own entirely new job flow.

6. Select the Active checkbox to make the setting available.

Add Your Job to the Patient Creation Job FlowCreate a JobFlowSetting custom metadata record for every job that you want executed. Whether you have chosen to add a job to theexisting patient creation job flow, or have defined an entirely new patient creation job flow, create a new record.

JobFlowSetting Custom MetadataJob flows for Health Cloud consist of one or more jobs, each represented by a JobFlowSetting__mdt custom metadata record. Eachrecord points to an Apex class that implements that job.

The settings for each job are defined as one row. You can insert custom metadata records the same way you'd create an instance ofanother sObject. You can also override any of the jobs within the Patient Create job flow by deselecting the Active field on the job.The jobs that make up the default patient creation job flow are represented by these custom metadata records.

Table 1: Default Patient Create Job Flow

CustomActiveJob OrderJob NameJob Flow NameLabel

falsetrue1HcCreatePatientDefaultJobs.CreateIndividualJobdefaultPatientCreatePatientCreate

falsetrue2HcCreatePatientDefaultJobs.CreateCarePlanJobdefaultPatientCreateCare PlanCreate

The default Patient Create flow defines the steps for creating a patient record. The jobs in this flow create one Account record and oneContact record, and a Case record for the patient’s care plan. This flow uses the JobFlowDataMapping__mdt custom metadata objectto define the field mapping from the source CandidatePatient__c to the Account, Contact, and Case records.

The following are descriptions of the fields in the JobFlowSetting__mdt custom metadata type.

Master LabelThe friendly name for the job flow entry.

Object NameThe API name of the job flow entry.

Job Flow NameThe name of the job flow. All jobs in the same flow share the job flow name.

679

Customize the Patient Conversion ProcessHealth Cloud Developer Guide

Page 684: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Job NameThe name of the Apex class that implements the job. This class extends theHealthCloudGA.MoiJobFlowFactory.MoiJobBase class and overrides its processJob() method.

Job OrderAn integer number that specifies the order of the job in the job flow. Jobs in a job flow must have unique job order numbers, andtheir order must be linear.

ActiveIndicates whether the job is used (true) or not (false).

CustomFalse if provided by default in the Health Cloud package; otherwise true.

Protected ComponentSpecifies whether this Job Flow Setting component is hidden outside a managed package. This field is unchecked (false) in theHealth Cloud package as the component is accessible outside the package.

To register your custom integration job, insert a record to the JobFlowSetting__mdt custom metadata. To do so in the user interface:

1. From Setup, enter Custom Metadata Types in the Quick Find box, then select Custom Metadata Types.

2. Click Job Flow Setting, then click Manage Job Flows Settings.

3. Click New, and fill out the information for your custom job and Apex class, including the job flow name, job name, and order inwhich it runs.

4. Ensure that the Active and Custom checkboxes are checked.

5. Click Save.

For example, to register the sample class that’s provided, enter the following information.

1. For Master Label, enter Create Patient: Invoke Integration.

2. For Object Name, enter CreatePatientInvokeIntegration.

3. For Job Flow Name, enter defaultPatientCreate to append your job to the existing job flow.

4. For Job Name, enter the class name InvokePatientDataMigrate.

5. For Job Order, enter 3 to ensure that Health Cloud invokes this job after the second default job for patient creation.

6. Ensure that the Active and Custom checkboxes are checked.

7. Click Save.

SEE ALSO:

Customize the Patient Conversion Process

Data Mapping to Health Cloud ObjectsWhen a patient is converted, Health Cloud copies patient data from CandidatePatient__c to the corresponding Account, Contact, andCase (CarePlan record type) objects. A mapping defines how patient data maps to the fields in the destination Salesforce objects. Thismapping is specified in the JobFlowDataMapping__mdt custom metadata object.

These mappings can’t be changed or deleted. To change the mappings in your org, create another mapping group and change theHealth Cloud Settings to use that mapping group instead of the default mappings.

680

Customize the Patient Conversion ProcessHealth Cloud Developer Guide

Page 685: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Note: Salesforce uses the MedicalRecordNumber__c and SourceSystem__c fields to check for duplicate patientrecords during the patient creation process. You can create a validation rule to verify that all candidate patient records have valuesin these fields before converting patient records.

Table 2: JobFlowDataMapping__mdt

TargetFieldTargetObjectSourceFieldSourceObjectMappingGroupName

NameAccountName__cCandidatePatient__cdefaultPatientCreate

MedicalRecordNumber__cAccountMedicalRecordNumber__cCandidatePatient__cdefaultPatientCreate

SubjectCare Plan2Health Cloud Care Plan1nulldefaultPatientCreate

MedicalRecordNumber__cContactMedicalRecordNumber__cCandidatePatient__cdefaultPatientCreate

MailingStreetContactAddress1Line1__cCandidatePatient__cdefaultPatientCreate

FirstNameContactGivenName1__cCandidatePatient__cdefaultPatientCreate

LastNameContactFamilyName1__cCandidatePatient__cdefaultPatientCreate

BirthdateContactBirthDate__cCandidatePatient__cdefaultPatientCreate

MailingCityContactAddress1City__cCandidatePatient__cdefaultPatientCreate

MailingCountryContactAddress1Country__cCandidatePatient__cdefaultPatientCreate

PhoneContactTelecom1Value__cCandidatePatient__cdefaultPatientCreate

MailingPostalCodeContactAddress1PostalCode__cCandidatePatient__cdefaultPatientCreate

1 Because the source object for this record is null, Health Cloud Care Plan is a string literal and not a field name. This stringvalue is applied to the target field, Subject.2 Care Plan is a string literal that corresponds to the object that represents a care plan, namely a Case whose record type is CarePlan.

The following is a description of the fields in the JobFlowDataMapping__mdt custom metadata type that’s used for mapping.

Mapping Group NameThe name of a mapping group, which represents a set of field mappings. The patient creation job flow uses only one mapping groupnamed defaultPatientCreate.

Source ObjectThe API name of the sObject from which data is copied to the target object.

Source FieldThe API name of the field that is copied to the target object.

Target ObjectThe API name of the sObject to copy the data to.

Target FieldThe API name of the field to copy the data to.

ActiveIndicates whether the job is used (true) or not (false).

681

Customize the Patient Conversion ProcessHealth Cloud Developer Guide

Page 686: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Mapping Extra FieldsYou can add new field mappings by inserting a record in the JobFlowDataMapping__mdt custom metadata object for each newmapping. Custom mappings can be changed and removed.

To add a mapping in the user interface:

1. From Setup, enter Custom Metadata Types in the Quick Find box, then select Custom Metadata Types.

2. Click Job Flow Data Mapping, then click Manage Job Flow Data Mappings.

3. Click New, and fill out the information for the new mapping.

4. Click Save.

Note: You can also deactivate the delivered JobFlowDataMapping__mdt and use your own custom set of mappings when youcreate and activate a new record with the same setting name and setting value.

SEE ALSO:

Customize the Patient Conversion Process

Working With Electronic Health Records

HL7 (Health Level Seven) is a standard for exchanging electronic health records (EHR). You can parse EHR data transmitted via HL7 datamessages and store it in the Salesforce Health Cloud data model. You can create parsers or use parsers supplied by Health Cloud.

Salesforce is committed to interoperability and the use of standards to facilitate the exchange of health data. As a voting member ofHL7.org, Salesforce can share excerpts of HL7 standards, post the standards on Salesforce digital assets, and use HL7 organizational and“Care Connected” logos. Here we reference some of the key data elements in the HL7 standards to facilitate mapping to the Salesforcedata model.

Note: Elements that aren't mapped here are not yet supported. We are continuing to map additional elements.

Storing HL7 Admission, Discharge, Transfer (ADT) Data in Salesforce Objects

The HL7 Admission, Discharge, Transfer (ADT) message handles information such as the identity of the patient, the patient’s next ofkin, patient visits, payers, and allergies. Data elements in ADT messages are stored in the Salesforce Account and Contact objectsand in Health Cloud custom objects. Elements are listed here in order of sequence number in the HL7 standard.

Storing HL7 Clinical Document Architecture (CDA) Data in Salesforce Objects

Clinical Document Architecture (CDA) is a document markup standard that specifies the structure and semantics of clinical documentsfor the purpose of exchange between health care providers and patients.

Storing HL7 Observation Results (ORU) Data in Salesforce Objects

The ORU message transmits observations and results from the producing system (such as an EKG or MRI system) to the orderingsystem (such as a physician's office).

SEE ALSO:

Electronic Health Records

682

Working With Electronic Health RecordsHealth Cloud Developer Guide

Page 687: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Storing HL7 Admission, Discharge, Transfer (ADT) Data in Salesforce ObjectsThe HL7 Admission, Discharge, Transfer (ADT) message handles information such as the identity of the patient, the patient’s next of kin,patient visits, payers, and allergies. Data elements in ADT messages are stored in the Salesforce Account and Contact objects and inHealth Cloud custom objects. Elements are listed here in order of sequence number in the HL7 standard.

ADT Patient Identification (PID)Patient Identification (PID) elements in ADT messages handle information needed for establishing the identity of the patient.

FieldSalesforce ObjectHL7 ElementSEQ

Set ID – Patient ID1

MedicalRecordNumberAccountPatient ID (External ID)2

SourceSystem; IDAccountPatient ID (Internal ID)3

NameAccountPatient Name5

NameContact

GivenName1; FamilyName1EhrPatient

DateOfBirthContactDate/Time of Birth7

BirthDateEhrPatient

GenderCode;GenderLabelEhrPatientSex8

GivenName2;Family Name2EhrPatientPatient Alias9

GivenName3;Family Name3EhrPatient

Given Name4; Family Name4EhrPatient

Address Information: MailingStreet, MailingCity,MailingState, MailingZip (PostalCode), MailingCountry

ContactPatient Address11

Address1Line1, Address1Line2, Address1City,Address1Country, Address1Postal Code, Address1StateDate, Address1EndDate

EhrPatient

HomePhoneContactPhone Number – Home13

PhoneContactPhone Number – Business14

PrimaryLanguageContactPrimary Language15

PrimaryLanguageAccount

Communication1Code (1 to 5)EhrPatient

MaritalStatusCode, MaritalStatusLabelCandidatePatientMarital Status16

MaritalStatusCode, MaritalStatusLabelEhrPatient

DeceasedCandidatePatientPatient Death Indicator30

683

Storing HL7 Admission, Discharge, Transfer (ADT) Data inSalesforce Objects

Health Cloud Developer Guide

Page 688: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectHL7 ElementSEQ

DeceasedEhrPatient

ADT Next of Kin (NK1)The NK1 segment contains information about the patient’s other related parties, and any associated parties.

When you build tooling to connect EHR data with Salesforce Health Cloud objects, use these mappings as a guide.

FieldSalesforce ObjectHL7 ElementSEQ

Set ID - NK1NK1.1

ContactNameContactNK NameNK1.2

AccountNameAccount

Given ame1 (up to 5); FamilyName1 (up to 3)EhrPatientEhrRelatedPerson

RelatedRole, ContactRelationshipContactRelationshipNK1.3

RelationshipEhrPatientEhrRelatedPerson

Address Information: MailingStreet, MailingCity,MailingState, MailingZip/MailingPostal Code,MailingCountry

ContactAddressNK1.4

Address Information: Address1Line1, Address1Line2,Address1City, Address1State, Address1Postal Code,Address1Country

EhrPatientEhrRelatedPerson

Phone, HomePhone, MobileContactPhone NumberNK1.5

Telecom1Value(up to 5)EhrPatientEhrRelatedPerson

Phone, OtherPhoneContactBusiness Phone NumberNK1.6

Telecom1Value(up to 5)EhrPatientEhrRelatedPerson

Role, Role255EhrPatientEhrRelatedPerson

Contact RoleNK1.7

TitleContactNext of Kin / Associated Parties Job TitleNK1.10

NK1.11

EmployeeNumberUserNext of Kin / Associated PartiesEmployee Number

NK1.12

GenderAccountSexNK1.15

GenderContact

684

Storing HL7 Admission, Discharge, Transfer (ADT) Data inSalesforce Objects

Health Cloud Developer Guide

Page 689: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectHL7 ElementSEQ

GenderEhrPatientEhrRelatedPerson

BirthDateAccountDate/Time Of BirthNK1.16

BirthDateContact

BirthDateEhrPatientEhrRelatedPerson

PrimaryLanguage__pcAccountPrimary LanguageNK1.20

PrimaryLanguageContact

Language1 (from 1 to 5)EhrPatientEhrRelatedPerson

GivenName1 (up to 5); FamilyName1 (up to 3)EhrPatient ContactContact Person’s NameNK1.30

Telecom1Value (up to 5)EhrPatient ContactContact Person’s Telephone NumberNK1.31

Address Information: Address1Line1, Address1Line2,Address1City, Address1State, Address1Postal Code,Address1Country

EhrPatient ContactContact Person’s AddressNK1.32

ADT Patient Visit (PV1)The PV1 segment contains information about inpatient or outpatient health care encounters.

FieldSalesforce ObjectHL7 ElementSEQ

ClassEhrEncounterPatient Class2

Location1Description, Location1Name, Location1TypeEhrEncounterAssigned Patient Location3

Indication, ReasonCode, ReasonLabelEhrEncounterAdmission Type4

HospitalizePreAdmissionId,HospitalizationPreAdmissionId,HospitalizeAdmitSourceCode

EhrEncounterPreadmit Number5

HospitalizeOrigin, HospitalizationOriginEhrEncounterPrior Patient Location6

PractitionerEhrEncounterParticipantAttending Doctor7

TypeCode, TypeLabelEhrEncounterParticipant

HospitalizeAdmitSourceCode,HospitalAdmitSourceLabel

EhrEncounterReferring Doctor8

PractitionerEhrEncounterParticipantConsulting Doctor9

TypeCode, TypeLabelEhrEncounterParticipant

TypeCode, TypeLabelEhrEncounterHospital Service10

685

Storing HL7 Admission, Discharge, Transfer (ADT) Data inSalesforce Objects

Health Cloud Developer Guide

Page 690: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectHL7 ElementSEQ

HospitalizeReadmissionEhrEncounterRe-admission Indicator13

PractitionerEhrEncounterParticipantAdmitting Doctor17

TypeCode, TypeLabelEhrEncounterParticipant

HospitalizeDischargeDispositionCodeEhrEncounterDischarge Disposition36

HospitalizeDestinationEhrEncounterDischarged to Location37

HospitalizeDietCode, HospitalizeDietLabelEhrEncounterDiet Type38

Location1Description, Location1Name, Location1TypeEhrEncounterPending Location42

Location1Description, Location1Name, Location1TypeEhrEncounterPrior Temporary Location43

HospitalizePeriodStartEhrEncounterAdmit Date/Time44

HospitalizePeriodEndEhrEncounterDischarge Date/Time45

ADT Guarantor (GT1)The GT1 segment contains data about the guarantor (e.g., the person or the organization with financial responsibility for payment of apatient account) for patient and insurance billing applications.

When you build tooling to connect EHR data with Salesforce Health Cloud objects, use these mappings as a guide.

FieldSalesforce ObjectHL7 ElementSEQ

IndividualIdContactGuarantor Number2

IndividualIdAccount

Contact NameContactGuarantor Name3

Address Information: Mailing Street, Mailing City,Mailing State, Mailing Zip/ Postal Code, MailingCountry

ContactGuarantor Address5

HomePhoneContactGuarantor Ph Num-Home6

PhoneContactGuarantor Ph Num-Business7

BirthDateContactGuarantor Date/Time Of Birth8

GenderContactGuarantor Sex9

IndividualTypeContactGuarantor Type10

Related RoleContactContactRelationGuarantor Relationship11

StartDateContactContactRelationGuarantor Date - Begin13

EndDateContactContactRelationGuarantor Date - End14

NameAccountGuarantor Organization Name21

686

Storing HL7 Admission, Discharge, Transfer (ADT) Data inSalesforce Objects

Health Cloud Developer Guide

Page 691: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectHL7 ElementSEQ

PrimaryLanguageContactPrimary Language36

ADT Allergies (AL1)The AL1 segment contains patient allergy information. Most of this information will be derived from user-defined tables. Each AL1segment describes a single patient allergy.

FieldSalesforce ObjectHL7 ElementSEQ

SensitivityTypeCode, SensitivityTypeLabel,SensitivityTypeSystem

EhrAllergyIntoleranceAllergen Type Code2

Substance255, SubstanceLongEhrAllergyIntoleranceAllergen Code/Mnemonic/Description3

CriticalityCode, CriticalityLabel, CriticalitySystemEhrAllergyIntoleranceAllergy Severity Code4

Reaction255, ReactionEhrAllergyIntoleranceAllergy Reaction Code5

RecordedDateEhrAllergyIntoleranceIdentification Date6

Storing HL7 Clinical Document Architecture (CDA) Data in Salesforce ObjectsClinical Document Architecture (CDA) is a document markup standard that specifies the structure and semantics of clinical documentsfor the purpose of exchange between health care providers and patients.

CDA Target Patient

FieldSalesforce ObjectExampleCDA Entry

GivenName1EhrPatientJaneName: Given Name

FamilyName1EhrPatientAppleseed-MonroeName: Family Name

Account NameAccount

Contact NameContact

123-456-7890SSN

Date of BirthAccount19770330Birth Time (date)

BirthDateEhrPatient

GenderCodeEhrPatientFGender: Code

GenderLabelEhrPatientFemaleGender: Display Name

GenderSystemEhrPatientAdministrativeGender(2.16.840.1.113883.5.1)

Gender: Code System

MaritalStatusCodeEhrPatientMMarital Status: Code

687

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 692: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectExampleCDA Entry

MaritalStatusLabelEhrPatientMarriedMarital Status: Display Name

Communication1Code (1 to 5)EhrPatientenLanguage: Code

Communication1Label (1 to 5)EhrPatientEnglishLanguage: Display Name

PrimaryLanguageContact

PrimaryLanguageAccount

Communication1System (1 to 5)EhrPatientLanguageCode(2.16.840.1.113883.1.11.11526)

Language: Code System

Address1Line1EhrPatient999 Huckleberry Ave, Apt #3Street Address: Line 1

Address Information: Mailing StreetContact

Address1Line2EhrPatientStreet Address: Line 2

Address1CityEhrPatientSpringfieldStreet Address: City

Mailing CityContact

Address1StateEhrPatientPAStreet Address: State

Mailing StateContact

Address1PostalCodeEhrPatient19604Street Address: Postal Code

Mailing Zip/ Postal CodeContact

Address1CountryEhrPatientUSStreet Address: Country

Mailing CountryContact

Telecom1Use, Telecom1ValueEhrPatient1(610)555-0000Home Telephone

HomePhoneContact

Telecom2Use, Telecom2ValueEhrPatient1(610)555-1111Mobile Telephone

PhoneContact

CDA Conditions

FieldSalesforce ObjectExampleCDA Entry

DateAssertedEhrCondition1/22/2011Effective Time: Low Value

1/31/2011Effective Time: High Value

NotesEhrConditionSleep Apnea; Patientexperiencing flu symptomsincluding chills and fever

Narrative Description

CategoryCodeEhrCondition6142004Condition: Code

688

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 693: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectExampleCDA Entry

CatergoryLabelEhrConditionInfluenzaCondition: Display Name

CategorySystemEhrConditionSNOMED CT(2.16.840.1.113883.6.96)

Condition: Code System

EvidenceCodeEhrCondition43724002Symptoms: Code

EvidenceDetail, EvidenceLabelEhrConditionChillSymptoms: Display Name

EvidenceSystemEhrConditionSNOMED CT(2.16.840.1.113883.6.96)

Symptoms: Code System

CDA Medications

Note: This section can repeat for multiple medications. EHR Dosage Instruction object is a child object to EHR MedicationPrescription, which contains Dose, Route and Frequency.

FieldSalesforce ObjectExampleCDA Entry

DateWrittenEhrMedicationPrescription20070312Effective Time: LowValue (Date)

StatusCode, StatusLabel, StatusSystemEhrMedicationPrescriptionactiveStatus Code

Instruction, SupplementalInstructionEhrDosageInstructionTake Acetaminophen 500 MGOral Tablet every 8 hours for 10

Narrative Text

days; Take Fluoxetine 15 MG OralTablet once a day at breakfast.

DispenseMedicationCode, MedicationCodeEhrMedicationPrescription198440MedicationInformation: Code

DispenseMedicationLabel,MedicationCodeLabel

EhrMedicationPrescriptionAcetaminophen 500 MG OralTablet

MedicationInformation: DisplayName

DispenseMedicationCodeSystem,MedicationCodeSystem

EhrMedicationPrescriptionRxNorm (2.16.840.1.113883.6.88)MedicationInformation: CodeSystem

RouteCodeEhrDosageInstructionC38288Route ofAdministration: Code

RouteLabelEhrDosageInstructionOralRoute ofAdministration:Display Name

RouteSystemEhrDosageInstructionNCI Thesaurus(2.16.840.1.113883.3.26.1.1)

Route ofAdministration: CodeSystem

DoseQuantityUnit, DoseQuantityValueEhrDosageInstructionDose Quantity

689

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 694: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectExampleCDA Entry

DispenseMedicationProductFormCodeEhrMedicationPrescriptionC42998Product Form: Code

DispenseMedicationProductFormLabelEhrMedicationPrescriptionTabletProduct Form:Display Name

DispenseMedicationProductFormSystemEhrMedicationPrescriptionNCI Thesaurus(2.16.840.1.113883.3.26.1.1)

Product Form: CodeSystem

CDA Allergies

FieldSalesforce ObjectExampleCDA Entry

RecordedDateEhrAllergyIntolerance20070312Effective Time: Low Value (Date)

StatusCode, StatusLabel, StatusSystemEhrAllergyIntolerancecompletedStatus Code

ReactionEhrAllergyIntolerancePatient relays that theyexperienced erythema of skin

Narrative Text

after taking sulfa drug and wastold to never take it again;Patient has allergy to soybean,Experienced swelling of thetongue as a child and has beeninstructed to avoid soybean.

SensitivityTypeCodeEhrAllergyIntolerance416098002Type of Allergy: Code

SensitivityTypeLabelEhrAllergyIntolerancedrug allergyType of Allergy: Display Name

SensitivityTypeSystemEhrAllergyIntoleranceSNOMED CT(2.16.840.1.113883.6.96)

Type of Allergy: Code: CodeSystem

SubstanceCodeEhrAllergyIntolerance10180Drug: Code

Substance255EhrAllergyIntoleranceSulfamethoxazoleDrug: Display Name

SubstanceCodeSystemEhrAllergyIntoleranceRxNorm (2.16.840.1.113883.6.88)Drug: Code System

No equivalent in Health Cloud444827008Reaction: Code

Reaction255EhrAllergyIntoleranceErythema of skinReaction: Display Name

No equivalent in Health CloudSNOMED CT(2.16.840.1.113883.6.96)

Reaction: Code System

CriticalityCodeEhrAllergyIntolerance6736007Severity: Code

CriticalityLabelEhrAllergyIntoleranceModerateSeverity: Display Name

CriticalitySystemEhrAllergyIntoleranceSNOMED CT(2.16.840.1.113883.6.96)

Severity: Code System

690

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 695: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CDA Immunizations

FieldSalesforce ObjectExampleCDA Entry

DateAdministeredEhrImmunization20070312Effective Time (VaccineDate)

VaccineTypeCodeEhrImmunization33Vaccine Code

VaccineTypeLabelEhrImmunizationPneumococcal (PCV, PPSV)Vaccine DisplayName

VaccineTypeSystemEhrImmunizationCVX (2.16.840.1.113883.12.292)Vaccine Code System

CompletedStatus Code

DoseQuantityUnitsEhrImmunizationmLDose Quantity: Unit

DoseQuantityValueEhrImmunization2Dose Quantity: Value

LotNumberEhrImmunization3422Lot Number

CDA Plan of Care

FieldSalesforce ObjectExampleCDA Entry

PeriodStartEHR Care Plan20070312Effective Time: Low Value (Date)

PeriodEndEHR Care PlanEffective Time: High Value (Date)

NotesEHR Care Plan"Patient is to schedule CT scan toexamine knee; Follow-up

Narrative Text

appointment in 2 weeks; Patientwas supplied with Malarone250/100 Oral Tablet and shouldtake one every 24 hours during theirvisit to Africa to prevent Malaria;Patient instructed to take thismedication by mouth with food ora milky drink (such as whole milk,milkshake) that contains fat. "

CodeEHR Procedure Request73700Procedure Code

CodeLabelEHR Procedure RequestCT lower Extremity (Leg) w/ocontrast

Procedure Display Name

OrderedOnEHR Procedure RequestRequested Date (Same as EffectiveTime: Low Value)

691

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 696: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

CDA Procedures and Practitioners

FieldSalesforce ObjectExampleCDA Entry

PerformedDateTimeEhrProcedure201209011200Effective Time: Low Value (Date)

NotesEhrProcedureCath showed significant CAD,best treated medically.

Narrative Text

CodeEhrProcedure93452Procedure: Code

CodeLabelEhrProcedureL HRT CATH W/NJX LVENTRICULOGRAPHY IMG S+I

Procedure: Display Name

PrefixName1 (EHR Procedure and EHRPractitioner objects are connected via theEHR Procedure Performer Object)

EhrPractitionerDrPractitioner: Prefix

GivenName1EhrPractitionerJeffereyPractitioner: Given

GivenName1EhrPractitionerQPractitioner: Given

FamilyName1EhrPractitionerSmithPractitioner: Family

SuffixName1EhrPractitionerMDPractitioner: Suffix

Address1Line1EhrPractitioner877 E St NWPractitioner: Street Address Line1

Address1Line2EhrPractitionerPractitioner: Street Address Line2

Address1CityEhrPractitionerSpringfieldPractitioner: City

Address1StateEhrPractitionerOHPractitioner: State

Address1PostalCodeEhrPractitioner45503Practitioner: Postal Code

Address1CountryEhrPractitionerUSPractitioner: Country

Telecom1System, Telecom1Use,Telecom1Value

EhrPractitioner1(937)555-0122Practitioner: Telephone Number

Location1NameEhrPractitionerHappy Heart AssociatesPractioner Organization:Name

Location1TelecomSystem,Location1TelecomUse,Location1TelecomValue

EhrPractitioner1(937)555-0199Practioner Organization:Telephone Number

Location1Line1EhrPractitioner100 Cardio LanePractioner Organization: StreetAddress Line 1

Location1Line2EhrPractitionerPractioner Organization: StreetAddress Line 2

Location1CityEhrPractitionerSpringfieldPractioner Organization: City

Location1StateEhrPractitionerOHPractioner Organization: State

692

Storing HL7 Clinical Document Architecture (CDA) Data inSalesforce Objects

Health Cloud Developer Guide

Page 697: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectExampleCDA Entry

Location1PostalCodeEhrPractitioner45503Practioner Organization: PostalCode

Location1CountryEhrPractitionerUSPractioner Organization: Country

1005-8Facility: Code

LocationEhrProcedureCardiac Catheterization LabFacility: Display Name

CDA Lab Results

FieldSalesforce ObjectExampleCDA Entry

AppliesDateTimeEhrObservation20110914Effective Time (Date)

StatusCodeEhrObservationCompletedStatus Code

ValueLabelEhrObservation"Cholesterol - 176 mg/dL(normal) Triglyceride - 100

Narrative Text

mg/dL (normal) HDL - 60 mg/dL(normal) LDL - 116 mg/dL(normal)"

MethodCodeEhrObservation2093-3Observation Code

MethodLabelEhrObservationCholesterol [Mass/volume] inSerum or Plasma

Observation Display Name

MethodSystemEhrObservationLOINC (2.16.840.1.113883.6.1)Observation Code System

ValueQuantityEhrObservation176Observed Value (Result): Value

ValueQuantityUnitEhrObservationmg/DLObserved Value (Result): Unit

InterpretationCodeEhrObservationNInterpretation Code: Code

InterpretationLabelEhrObservationNormalInterpretation Code: DisplayName

InterpretationSystemEhrObservationObservationInterpretation(2.16.840.1.113883.5.83)

Interpretation Code: CodeSystem

ReferenceRangeHighValue,ReferenceRangeHighUnit,

EhrObservationRecommended: 0-199; ModerateRisk: 200-239; High Risk: 240+

Reference Range

ReferenceRangeLowValue,ReferenceRangeLowUnit

Storing HL7 Observation Results (ORU) Data in Salesforce ObjectsThe ORU message transmits observations and results from the producing system (such as an EKG or MRI system) to the ordering system(such as a physician's office).

693

Storing HL7 Observation Results (ORU) Data in SalesforceObjects

Health Cloud Developer Guide

Page 698: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Note: These mappings build on the mappings specified in the ADT message for the common segments.

ORU Order (ORC)The Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that are requested).

FieldSalesforce ObjectORC ElementSeq

SourceSystem, SourceSystemIDEhrProcedurePlacer Order Number2

SourceSystem, SourceSystemIdEhrObservationFiller Order Number3

StatusEhrProcedureOrder Status5

StatusEhrProcedureRequest

PerformedDateTimeEhrProcedureDate/Time of Transaction9

ScheduledDateTimeEhrProcedureRequest

OrderedByEhrProcedureRequestOrdering Provider12

LocationEhrProcedureEnterer's Location13

LocationEhrProcedureOrdering Facility Name21

ORU Observation Request (OBR)In the reporting of clinical data, the OBR serves as the report header. It identifies the observation set represented by a series of atomicobservations.

FieldSalesforce ObjectHL7 ElementSeq

SourceSystem, SourceSystemIDEHRProcedurePlacer Order Number2

SourceSystem, SourceSystemIdEhrObservationFiller Order Number3

Code, odeLabelEhrProcedureUniversal Service Identifier4

OrderedOnEHRProcedureRequestRequested Date/Time6

PerformedDateTimeEhrProcedureObservation Date/Time7

AppliesDateTimeEhrObservation

No specific field, but can be mapped to EhrConditionEhrConditionRelevant ClinicalInformation

13

PerformedDateTimeEhrProcedureSpecimen ReceivedDate/Time

14

AppliesDateTimeEhrObservation

BodySiteCode, BodySiteLabel, BodySiteSystemEhrObservationSpecimen Source15

OrderedByEhrProcedureRequestOrdering Provider16

694

Storing HL7 Observation Results (ORU) Data in SalesforceObjects

Health Cloud Developer Guide

Page 699: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

FieldSalesforce ObjectHL7 ElementSeq

SourceSystemModifiedEhrProcedureResults Rpt/Status Chng -Date/Time

22

SourceSystemModifiedEhrObservation

Status, StatusCodeEhrObservationResult Status25

PractitionerEhrObservationPrincipal Result Interpreter32

CommentsEhrObservationCollector's Comment39

OBR Note

FieldSalesforce ObjectHL7 ElementSeq

NotesEHRProcedureComment3

ORU Observation (OBX)The OBX segment is used to transmit a single observation or observation fragment. It represents the smallest indivisible unit of a report.

FieldSalesforce ObjectHL7 ElementSeq

MethodCode, MethodLabel, MethodSystemEhrObservationObservation Identifier3

ValueLabel, ValueQuantityEhrObservationObservation Value5

ValueQuantityUnitEhrObservationUnits6

ReferenceRangeHighValue, ReferenceRangeHighUnit,EhrObservationReferences Range7

ReferenceRangeLowValue, ReferenceRangeLowUnitEhrObservation

InterpretationCode, InterpretationLabel,InterpretationSystem

EhrObservationAbnormal Flags8

Status, StatusCodeEhrObservationObservation Result Status11

AppliesDateTimeEhrObservationDate/Time of theObservation

14

PractitionerEhrObservationResponsible Observer16

MethodCode, MethodLabelEhrObservationObservation Method17

DeviceEhrObservationEquipment InstanceIdentifier

18

Potentially mapped through Performing Practitioner/address on EHR Practitioner

Performing OrganizationMedical Director

25

695

Storing HL7 Observation Results (ORU) Data in SalesforceObjects

Health Cloud Developer Guide

Page 700: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

OBX Note

FieldSalesforce ObjectHL7 ElementSeq

CommentsEhrObservationComment3

Health Cloud Business APIs

Use the Health Cloud Business APIs for building integrations with Health Cloud or for creating custom UI components. The APIs wrapcomplex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcareindustry, such as enrolling patients into a care program or creating requests for prior authorizations. To use these APIs, you are notrequired to understand the underlying healthcare data model. Most of the APIs are RESTful APIs, but a few are also available throughApex classes and methods.

Create Patient

Use this single Apex API to create a patient record rather than making separate calls to the Account and Contact objects. The PersonAccount object and the Individual record type (for Account and Contact objects) are both supported.

Care Program Enrollments

Use this API to enroll multiple patients in a care program.

Care Services Review and Response

These RESTful APIs support data elements required for ANSI X12 278 format Health Care Services Review and Response. Also referredto as ANSI 278 Authorization APIs, they enable payer organizations to electronically receive prior authorization requests and referralrequests from providers. Other users of these APIs can be healthcare providers, payers, plan sponsors, or other entities involved inhealth care services review, such as clearinghouses.

REST Reference

You can access Health Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs.

Create PatientUse this single Apex API to create a patient record rather than making separate calls to the Account and Contact objects. The PersonAccount object and the Individual record type (for Account and Contact objects) are both supported.

A single API call creates a patient record and populates all fields. If you’ve defined custom fields, it manages those as well.

If something goes wrong while inserting data, the API rolls back to prevent leaving orphan records behind.

UsageInstantiate a patient using the relevant record type:

HealthCloudGA.Patient patient = new HealthCloudGA.Patient();patient.PatientClass = 'Individual'; // record type// OR// patient.PatientClass = 'PersonAccount';

696

Health Cloud Business APIsHealth Cloud Developer Guide

Page 701: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Set standard fields:

patient.FirstName = 'Charles';patient.LastName = 'Green';//... similarly set additional standard fields for Individual record type

Set custom fields:

patient.customFields.put('customField','value');patient.customFields.put('DateTypeCustomField__c',Date.newInstance(2017,11,15));

Usage of PatientService:

public class HCBusinessAPIExample {public static void genSamplePatient(){

HealthCloudGA.Patient patient = new HealthCloudGA.Patient();patient.PatientClass = 'Individual';patient.FirstName = 'Charles';patient.LastName = 'Green';//... set additional standard fields and custom fields

HealthCloudGA.Result res = HealthCloudGA.PatientService.createPatient(patient);

System.debug(res);

}}

Care Program EnrollmentsUse this API to enroll multiple patients in a care program.

A single API call creates both patient enrollment cards, and enrollee products for all the patients. You can enroll up to 200 patients in asingle request.

Important: Ensure that you have configured required care system field-mapping records for provider, patient, care program, andthe product in Setup > Care System Field Mappings. For more information, see CareSystemFieldMapping.

SEE ALSO:

Life Sciences Program Management

Enrollments

CareSystemFieldMapping

Map External Fields to Health Cloud

697

Care Program EnrollmentsHealth Cloud Developer Guide

Page 702: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Services Review and Response

USER PERMISSIONS

To access care services APIs• Health Cloud Utilization

ManagementPermission Set

These RESTful APIs support data elements required for ANSI X12 278 format Health Care ServicesReview and Response. Also referred to as ANSI 278 Authorization APIs, they enable payerorganizations to electronically receive prior authorization requests and referral requests fromproviders. Other users of these APIs can be healthcare providers, payers, plan sponsors, or otherentities involved in health care services review, such as clearinghouses.

These APIs facilitate communication between two parties for the following cases:

• Appeals

• Drug Requests

• Admissions

• Healthcare Service Requests

• Referrals

• Complaints

• Grievances

Create or Update Care Services Review RequestsDepending on the type of care service review request (drug request, prior authorization, and so on), and the content of the requestbody, this API creates one or more records for Case, CareRequest, CareRequestExtension, CareRequestDrug,CareRequestItem, or CareRequestDiagnosis..

The following diagram shows what happens when you make a POST request to this API, to create a care services review request.

Get Care Services Review ResponsesYou can get Care Services Review Response for one or more care service review requests, by either using their Salesforce IDs orexternal source system IDs. Use section query parameter to have granular filters. Some examples of valid values in section

698

Care Services Review and ResponseHealth Cloud Developer Guide

Page 703: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

are, Subscriber, Patient, CareDiagnoses, CareRequestItems, CareRequestDrugs,TransportLocations, CareRequest, or CareRequestCase.

SEE ALSO:

Handle Care Requests with Utilization Management

What is a Care Request?

How Are Care Requests Reviewed?

ANSI X12 278 - Request for Review and Response Examples

Enable Person Accounts

REST ReferenceYou can access Health Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs.

To understand the architecture, authentication, rate limits, and how the requests and responses work, see Connect REST API DeveloperGuide

Resources

Use following resources of Health Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications.

Request Bodies

This section lists the request bodies for Health Cloud Business APIs. The query parameters for an endpoint are listed along with eachresource.

Response Bodies

A resource can return a response body in either JSON or XML format.

SEE ALSO:

Connect REST API Architecture

Connect REST API Rate Limits

Build a Resource URL

Status Codes and Error Responses

ResourcesUse following resources of Health Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications.

Enrollments

Enroll multiple patients into a care program.

Care Services Review Resources

Use these resources to create or update care services review requests, or get information about the status of existing requests.

EnrollmentsEnroll multiple patients into a care program.

699

REST ReferenceHealth Cloud Developer Guide

Page 704: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Resource

/services/data/vXX.X/connect/health/care-programs/enrollments

Available version46.0

AuthenticationUse OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. For more information, seeConnect to Connect REST API Using OAuth.

HTTP methodsPOST

Request body

Root XML tag<careProgramEnrollmentData>

JSON example

{"programId": "programId1","sourceSystem": "source-system-name","patientData": [{"patientId": "patient1","careProgramProductData": [{"providerId": "provider1","productId": "product1"

},{"providerId": "provider1","productId": "product2"

}]

},{"patientId": "patient2","careProgramProductData": [{"providerId": "provider3","productId": "product4"

}]

}]

}

700

REST ReferenceHealth Cloud Developer Guide

Page 705: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesList of all objects that contain patientsdata. You can have up to 200 items in thislist.

Patient Input []patientData

46.0YesID of the care program as configured inthe care system field mappings.

StringprogramId

46.0YesName of the source system as configuredin the care system field mappings.

StringsourceSystem

Response bodyProgram Enrollment Result

PrerequisitesEnsure that you have configured the following care system field mapping configured in Setup > Care System Field Mappings:

Target ObjectRoleName

CareProgramNot ApplicableCare_Program

AccountPatientPatient

Product2Not ApplicableProduct

AccountService ProviderProvider

Note: Ensure that you have configured appropriate external ID field and source system for each of these mappings.

For more information, see CareSystemFieldMapping.

SEE ALSO:

CareSystemFieldMapping

Care Program Enrollments

Care Services Review ResourcesUse these resources to create or update care services review requests, or get information about the status of existing requests.

Available resources:

DescriptionResource

Create care services review requests or update existing requests./services/data/vXX.X/connect/health/care-services

Get details of existing care services review requests./services/data/vXX.X/connect/health/care-services/{ids}

701

REST ReferenceHealth Cloud Developer Guide

Page 706: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Get Care Services Review Responses

Get details of existing care services review requests.

Resource/services/data/vXX.X/connect/health/care-services/{ids}

where ids is the semicolon separated list of IDs. The items in this list can be Salesforce ID, or a SourceSystemIdentifier.Use idName query parameter to specify the type of ids provided in the URI.

URI Example to retrieve care requests using Salesforce IDs:

/connect/health/care-services/0Uk7859783498540;0Uk6712899900;0Um4367564378788?idName=Id&sectionNames=Subscriber;CareRequest

Important: Ensure that semicolon character is not a part of any id, if using SourceSystemIdentifier to retrievecare requests.

Available version46.0

AuthenticationUse OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. For more information, seeConnect to Connect REST API Using OAuth.

HTTP methodsGET

Query parameters

AvailableVersion

RequiredDescriptionTypeParameterName

46.0YesIndicates the type of identifiers used in thepath parameter ids. The valid values are:

StringidName

• id: Salesforce object ID.

• SourceSystemIdentifier: IDof the external system.

46.0NoSemicolon separated list of section namesfor which data is requested. For example,

StringsectionNames

Subscriber, Patient,CareDiagnoses,CareRequestItems,CareRequestDrugs,TransportLocations,CareRequest, orCareRequestCase.

702

REST ReferenceHealth Cloud Developer Guide

Page 707: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Response body

AvailableVersion

Filter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0A list of care authorization requests.Care AuthorizationRequest[]

careAuthorizationRequests

46.0Small, 46.0If the parameters were invalid, thisproperty contains the error message.

StringerrorMessage

46.0Small, 46.0This flag indicates if the request wassuccessful or not.

BooleanisSuccess

Create or Update Care Services Review Requests

Create care services review requests or update existing requests.

• You must have Person Accounts enabled to use these APIs.

• After enabling person accounts, enable name suffixes.

1. Navigate to Setup > Customize > User Interface.

2. In Name Settings, select Enable Name Suffixes for Person Names and save.

• You can create or update up to 25 care services requests.

• For PATCH, if the request body contains IDs for CareRequestitem, CareRequestDrug, or CareDiagnosis, then thecorresponding records are updated, else the new child records are created.

Resource/services/data/vXX.X/connect/health/care-services

Available version46.0

AuthenticationUse OAuth to connect to Salesforce and get an access token. Pass the access token in your requests.

HTTP methodsPATCH, POST

Request body for POST and PATCH

Root XML tag<careRequestsList>

JSON Schema

{"careRequestsList": [{"careRequestsCase": {...},"patient": {...},"careRequestItems": [{...}],"careRequestDrugs": [{...}],"careRequest": {...},"careDiagnoses": [{...}],

703

REST ReferenceHealth Cloud Developer Guide

Page 708: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

"subscriber": {...},"transportLocations": {...}}]}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesList of Care Requests to be created orupdated. (Up to 25 items.)

Care AuthorizationRequest Input[]

careRequestsList

Response body for POST and PATCH

AvailableVersion

Filter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Care Authorization returned codeStringcode

46.0Small, 46.0Flag to indicate if the request wassuccessful.

BooleanisSuccess

46.0Small, 46.0If there is any error, this property containsthe error message.

Stringmessage

46.0Small, 46.0Care Authorization Request results outputCare AuthorizationRequest[]

outputResults

46.0Small, 46.0Care Authorization Request resultCare AuthorizationRequest Result[]

result

SEE ALSO:

Enable Person Accounts

Connect to Connect REST API Using OAuth

Request BodiesThis section lists the request bodies for Health Cloud Business APIs. The query parameters for an endpoint are listed along with eachresource.

To create a JSON request body, specify the properties of the request body in JSON format. If a request body is top-level, it has a root XMLtag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag.

Appointed Representative Input

Person who is the appointed representative for the member.

Care Request Case Input

Case related to the care request.

704

REST ReferenceHealth Cloud Developer Guide

Page 709: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Request Patient Input

The patient for whom the request is being raised.

Care Authorization Request Input

A complete care authorization request.

Care Diagnosis Input

Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.

Care Request Drug Input

Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associatedwith a care request.

Care Request Input

The general details of a care-related request including member information, admission date, decision reason, and so on. A singlerequest can contain multiple diagnoses or drugs. Care requests include prior authorizations for drugs and services, admissionnotifications, concurrent review of admissions, appeals, complaints, and grievances.

Care Request Item Input

The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can beassociated with a care request.

Care Requests List Input

A list of care authorization requests.

Dispenser Address Input

Address of the pharmacy.

Enrollee Product Input

Data for a single enrollee product.

First Reviewer Input

The name of the person who reviewed the request.

General Practitioner Input

Member's primary or general care practitioner.

Medical Director Input

Name of the medical director who reviewed the request.

Original Denial Medical Director Input

The name of the medical director who denied the original request.

Patient Input

Input containing data for a single patient.

Program Enrollment Input

Request body for care program enrollment.

Requesting Practitioner Input

Ordering or referring practitioner for the request.

Servicing Facility Input

Facility where the service is being provided.

Servicing Practitioner Input

Practitioner administering the service.

705

REST ReferenceHealth Cloud Developer Guide

Page 710: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Request Subscriber Input

The primary member on the plan.

Transport Location Input

Input representation for Transport Location

Appointed Representative InputPerson who is the appointed representative for the member.

Root XML tag<appointedRepresentative>

JSON example

{"firstName": "Jane","lastName": "Doe"

}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoFirst Name of the appointedrepresentative.

StringfirstName

46.0NoLast Name of the appointed representative.StringlastName

46.0NoName suffix of the appointedrepresentative.

Stringsuffix

46.0NoBirth date of the appointed representative.StringbirthDate

Tip: All the fields in this input are optional. However, it is advisable to provide as much information as possible to find a uniqueappointed representative record to associate with your care request.

Care Request Case InputCase related to the care request.

Root XML tag<case>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesThe source of the case, such as Email,Phone, or Web. Maps to: Case.Origin

StringcaseOrigin

706

REST ReferenceHealth Cloud Developer Guide

Page 711: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoThe reason why the case was created, suchas Instructions not clear, or User didn’tattend training. Maps to: Case.Reason

StringcaseReason

46.0NoA text description of the case. Limit: 32 KB.Maps to: Case.Description

Stringdescription

46.0NoThe ID of the parent case in the hierarchy.Maps to: Case.ParentId

StringparentCaseNumber

46.0NoThe importance or urgency of the case,such as High, Medium, or Low. Maps to:Case.Priority

Stringpriority

46.0NoThe status of the case. Maps to:Case.Status

Stringstatus

46.0YesThe subject of the case. Limit: 255characters. Maps to: Case.Subject

Stringsubject

46.0NoThe type of case, such as Feature Requestor Question. Maps to: Case.Type

Stringtype

46.0NoThe company name that was enteredwhen the case was created. This field can't

StringsuppliedCompany

be updated after the case has beencreated. Maps to:Case.SuppliedCompany

46.0NoThe email address that was entered whenthe case was created. This field can't be

StringsuppliedEmail

updated after the case has been created.Maps to: Case.SuppliedEmail

46.0NoThe name that was entered when the casewas created. This field can't be updated

StringsuppliedName

after the case has been created. Maps to:Case.SuppliedName

46.0NoThe phone number that was entered whenthe case was created. This field can't be

StringsuppliedPhone

updated after the case has been created.Maps to: Case.SuppliedPhone

Care Request Patient InputThe patient for whom the request is being raised.

Root XML tag<patient>

707

REST ReferenceHealth Cloud Developer Guide

Page 712: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoPatient’s address line 1.StringaddressLine1

46.0NoPatient’s Address Line 2.StringaddressLine2

46.0NoDate of birth of the patient. Maps to:CareRequest.MemberDateOfBirth

StringbirthDate

Note: Required if birth date isspecified in the member accountrecord. Must be in DateTimeformat; for example:1970-04-30T00:00:00.

46.0NoCity where the patient lives.Stringcity

46.0NoFirst name of the patient.StringfirstName

46.0NoGender of the patient. Maps to:CareRequest.MemberGender

Stringgender

46.0YesLast name of the patient.StringlastName

46.0NoIndicates whether the patient has Medicarecoverage. Maps to:CareRequestExtension.IsMedicareCoverage

BooleanmedicareCoverage

46.0NoFree-form description of the patient’scondition. Maps to:CareRequest.MemberCondition

StringmemberCondition

46.0YesLookup to MemberPlan.MemberNumber.StringmemberId

Note: Not the insurance identifierfor the member in Account.

46.0NoIndicator of the provider's prognosis forthe patient. Maps to:CareRequest.MemberPrognosis

StringmemberPrognosis

46.0NoThe patient’s status at admission, date ofoutpatient service, or start of care. Mapsto: CareRequest.MemberStatus

StringmemberStatus

46.0NoMiddle name of the patient.StringmiddleName

46.0NoState where the patient lives.Stringstate

46.0NoName suffix of the patient.Stringsuffix

46.0NoZIP code of the patient’s address.StringzipCode

708

REST ReferenceHealth Cloud Developer Guide

Page 713: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Authorization Request InputA complete care authorization request.

Root XML tag<careAuthorization>

JSON example

{"careRequestCase": {"caseOrigin": "Web","subject": "Case No 10"},"patient": {"lastName": "Fedex","firstName": "Roger"},"careRequestItems": [{"name": "95810","codeType": "CPT","sourceSystem": "source_system_name","codeDescription": "Dysuria","sourceSystemIdentifier": "0015cmi","quantity": "15"}],"careRequestDrugs": [{"sourceSystem": "source_system_name","daysSupply": "10","frequency": "16","name": "Metoprolol"}],"careRequest": {"requestingPractitionerSpecialty": "Neurologist","placeOfService": "InPatient","sourceSystemIdentifier": "0015","name": "Care Request 15","requestingPractitionerLicense": "M.D","sourceSystem": "source_system_name","servicingPractitionerLicense": "M.D","servicingPractitionerSpecialty": "Hospitalist","recordType": "Complaint"},"careDiagnoses": [{"sourceSystem": "ajSource","name": "G47.30","codeDescription": "Sleep apnea, unspecified","codeType": "ICD-10-CM"}]}

709

REST ReferenceHealth Cloud Developer Guide

Page 714: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoList of associated diagnosis including codetype, name, and description. One or more

Care DiagnosisInput[]

careDiagnoses

care diagnoses can be associated with acare request.

46.0NoThe general details of a care-relatedrequest including member information,

Care Request InputcareRequest

admission date, decision reason, and soon. A single request can contain multiplediagnoses, services, or drugs. Care requestsinclude prior authorizations for drugs andservices, admission notifications,concurrent review of admissions, appeals,complaints, and grievances.

46.0NoList of requested drug including name,strength, frequency, and instructions for

Care Request DrugInput[]

careRequestDrugs

administration. One or more drug requestscan be associated with a care request.

46.0NoThe details of a care service request,including name, modifiers, and the

Care Request ItemInput[]

careRequestItems

effective date. One or more care servicerequests can be associated with a carerequest.

46.0NoCase related to the care request.Care Request CaseInput

careRequestCase

46.0NoThe patient for whom the request is beingraised.

Care RequestPatient Input

patient

46.0NoThe primary member on the plan.Care RequestSubscriber Input

subscriber

46.0NoList of Transport Locations.Transport LocationInput[]

transportLocations

Care Diagnosis InputAssociated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.

Root XML tag<careDiagnosis>

JSON example

{"sourceSystem": "source_system_name",

710

REST ReferenceHealth Cloud Developer Guide

Page 715: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

"name": "G47.30","codeDescription": "Sleep apnea, unspecified","codeType": "ICD-10-CM"}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesName of the diagnosis code. Maps to:CareDiagnosis.Name

Stringname

46.0NoDiagnosis code description. Maps to:CareDiagnosis.CodeDescription

StringcodeDescription

46.0NoCode type for the diagnosis. Maps to:CareDiagnosis.CodeType

StringcodeType

46.0NoID of the code type for the diagnosis. Mapsto:CareDiagnosis.CodeTypeIdentifier

StringcodeTypeID

46.0NoDischarge diagnosis code. Maps to:CareDiagnosis.DischargeCode

StringdischargeCode

46.0NoDescription of the discharge diagnosiscode. Maps to:CareDiagnosis.DischargeCodeDescription

StringdischargeCodeDescription

46.0NoCode type for the discharge diagnosis.Maps to:CareDiagnosis.DischargeCodeType

StringdischargeCodeType

46.0NoID of the code type for the dischargediagnosis. Maps to:CareDiagnosis.DischargeCodeTypeIdentifier

StringdischargeCodeTypeId

46.0NoEffective date for the discharge diagnosis.Maps to:CareDiagnosis.DischargeDiagnosisEffectiveDate

StringdischargeDiagnosisEffectiveDate

46.0NoTermination date for the dischargediagnosis. Maps to:CareDiagnosis.DischargeDiagnosisEndDate

StringdischargeDiagnosisEndDate

46.0NoEffective date for the diagnosis. Maps to:CareDiagnosis.EffectiveDate

StringeffectiveDate

46.0NoTermination date for the diagnosis. Mapsto: CareDiagnosis.EndDate

StringendDate

46.0NoHealthcare Diagnosis CodeStringhealthcareDiagnosisCode

46.0Required for PATCH.ID of the Care Diagnosis.Stringid

711

REST ReferenceHealth Cloud Developer Guide

Page 716: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoModified diagnosis code. Maps to:CareDiagnosis.ModifiedCode

StringmodifiedCode

46.0NoModified diagnosis code description. Mapsto:CareDiagnosis.ModifiedCodeDescription

StringmodifiedCodeDescription

46.0NoCode type for the modified diagnosis.Maps to:CareDiagnosis.ModifiedCodeType

StringmodifiedCodeType

46.0NoID of the code type for the modifieddiagnosis. Maps to:CareDiagnosis.ModifiedCodeTypeIdentifier

StringmodifiedCodeTypeId

46.0NoModified effective date for the diagnosis.Maps to:CareDiagnosis.ModifiedEffectiveDate

StringmodifiedEffectiveDate

46.0NoModified termination date for thediagnosis. Maps to:CareDiagnosis.ModifiedEndDate

StringmodifiedEndDate

46.0NoModified Primary DiagnosisBooleanmodifiedPrimaryDiagnosis

46.0NoIndicates if it is a primary diagnosis.Booleanprimary

46.0NoIndicates if it is a primary DischargeDiagnosis.

BooleanprimaryDischargeDiagnosis

46.0NoSystem from which this request wassourced. Maps to:CareDiagnosis.SourceSystem

StringsourceSystem

46.0NoID of the system from which the requestwas sourced. Maps to:CareDiagnosis.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0NoTimestamp of the most recent update fromthe source system. Maps to:CareDiagnosis.SourceSystemModified

StringsourceSystemModified

SEE ALSO:

CareDiagnosis

Care Request Drug InputRequested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associatedwith a care request.

712

REST ReferenceHealth Cloud Developer Guide

Page 717: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Root XML tag<careRequestDrug>

JSON example

{"sourceSystem": "source_system_name","daysSupply": "10","frequency": "16","name": "Metoprolol"}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoApproved quantity of the drug. Maps to:CareRequestDrug.ApprovedUnits

IntegerapprovedUnits

46.0NoCode for the drug. Maps to:CareRequestDrug.Code

Stringcode

46.0NoID code type for the drug. Maps to:CareRequestDrug.CodeType

StringcodeType

46.0NoNumber of days to supply the drug. Mapsto:CareRequestDrug.DaysSupply

IntegerdaysSupply

46.0NoDenied quantity of the drug. Maps to:CareRequestDrug.DeniedUnits

IntegerdeniedUnits

46.0NoPharmacy address.Dispenser AddressInput

dispenserAddress

46.0NoPharmacy fax number. Maps to:CareRequestDrug.DispenserFaxNumber

StringdispenserFaxNumber

46.0NoID for the pharmacy. Maps to:CareRequestDrug.DispenserIdentifier

StringdispenserId

46.0NoName of the pharmacy. Maps to:CareRequestDrug.DispenserName

StringdispenserName

46.0NoPharmacy phone number. Maps to:CareRequestDrug.DispenserPhoneNumber

StringdispenserPhoneNumber

46.0NoPharmacy tax identification number. Mapsto:CareRequestDrug.DispenserTaxIdentifier

StringdispenserTaxId

46.0NoDose of the drug. Maps to:CareRequestDrug.Dose

Stringdose

713

REST ReferenceHealth Cloud Developer Guide

Page 718: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoFrequency of the drug. Maps to:CareRequestDrug.Frequency

Stringfrequency

46.0Required for PATCH.ID of the Care Request Drug.Stringid

46.0NoCode for the modified drug. Maps to:CareRequestDrug.ModifiedCode

StringmodifiedCode

46.0NoID code type for the modified drug. Mapsto:CareRequestDrug.ModifiedCodeType

StringmodifiedCodeType

46.0NoNumber of days of supply for the modifieddrug. Maps to:CareRequestDrug.ModifiedDaysSupply

IntegermodifiedDaysSupply

46.0NoDose of the modified drug. Maps to:CareRequestDrug.ModifiedDose

StringmodifiedDose

46.0NoFrequency of the modified drug. Maps to:CareRequestDrug.ModifiedFrequency

StringmodifiedFrequency

46.0NoName of the modified drug. Maps to:CareRequestDrug.ModifiedName

StringmodifiedName

46.0NoDirections for use of the modified drug.Maps to:CareRequestDrug.ModifiedSig

StringmodifiedSig

46.0NoStrength of the modified drug. Maps to:CareRequestDrug.ModifiedStrength

StringmodifiedStrength

46.0NoDuration of therapy for the modified drug.Maps to:CareRequestDrug.ModifiedTherapyDuration

IntegermodifiedTherapyDuration

46.0NoModified quantity of the drug. Maps to:CareRequestDrug.ModifiedUnits

IntegermodifiedUnits

46.0NoName of the drug. Maps to:CareRequestDrug.Name

Stringname

46.0NoDate for the prescription. Maps to:CareRequestDrug.PrescriptionDate

StringprescriptionDate

46.0NoNumber of fills for the prescription. Mapsto:CareRequestDrug.PrescriptionFills

IntegerprescriptionFills

46.0NoName of the service type such as medicalcare, diagnostic radiology, pharmacy, or

StringserviceCategory

diagnostic laboratory. Maps to:CareRequestDrug.ServiceCategory

714

REST ReferenceHealth Cloud Developer Guide

Page 719: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoAlphanumeric code that uniquely identifiesa service type. Maps to:CareRequestDrug.ServiceCategoryCode

StringserviceCategoryCode

46.0NoDirections for use of the drug. Maps to:CareRequestDrug.Sig

Stringsig

46.0NoSystem from which this request wassourced. Maps to:CareRequestDrug.SourceSystem

StringsourceSystem

46.0NoID of the system from which the requestwas sourced. Maps to:CareRequestDrug.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0NoTimestamp of the most recent update fromthe source system. Maps to:CareRequestDrug.SourceSystemModified

StringsourceSystemModified

46.0NoStrength of the drug. Maps to:CareRequestDrug.Strength

Stringstrength

46.0NoDuration of therapy for the drug. Maps to:CareRequestDrug.TherapyDuration

IntegertherapyDuration

46.0NoQuantity of the drug. Maps to:CareRequestDrug.Units

Integerunits

SEE ALSO:

CareRequestDrug

Care Request InputThe general details of a care-related request including member information, admission date, decision reason, and so on. A single requestcan contain multiple diagnoses or drugs. Care requests include prior authorizations for drugs and services, admission notifications,concurrent review of admissions, appeals, complaints, and grievances.

Root XML tag<careRequest>

JSON example

{"requestingPractitionerSpecialty": "Neurologist","placeOfService": "InPatient","sourceSystemIdentifier": "0015","name": "Care Request 15","requestingPractitionerLicense": "M.D","sourceSystem": "source_system_name","servicingPractitionerLicense": "M.D","servicingPractitionerSpecialty": "Hospitalist",

715

REST ReferenceHealth Cloud Developer Guide

Page 720: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

"recordType": "Complaint"}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoDate and time when an acknowledgmentletter was sent to the requester. Maps to:CareRequest.AcknowledgementLetterSentDate

StringacknowledgementLetterSentDate

46.0NoActual admission date for the patient.Maps to:CareRequest.ActualAdmissionDate

StringactualAdmissionDate

46.0NoActual discharge date for the patient. Mapsto:CareRequest.ActualDischargeDate

StringactualDischargeDate

46.0NoNotes related to the admission. Maps to:CareRequest.AdmissionNotes

StringadmissionNotes

46.0NoWhere the patient was admitted from, forexample, a clinic or an emergency room.

StringadmissionSource

Maps to:CareRequest.AdmissionSource

46.0NoType of admission, for example,emergency or elective. Maps to:CareRequest.AdmissionType

StringadmissionType

46.0NoAmbulance Transport DistanceIntegerambulanceTransportDistance

46.0NoReason for ambulance transport. Maps to:CareRequestExtention.AmbulanceTransportReason

StringambulanceTransportReason

46.0NoType of ambulance transport. Maps to:CareRequestExtention.AmbulanceTransportType

StringambulanceTransportType

46.0NoDate and time when the Appointment ofRepresentative (AOR) form was received.

StringaorReceivedDate

Maps to:CareRequest.AorReceivedDate

46.0NoDate and time when the AOR form wasrequested. Maps to:CareRequest.AorRequestedDate

StringaorRequestedDate

46.0NoDate and time of verbal contact with themember's appointed representative. Maps

StringappointedRepVerbalContactDate

to:CareRequest.AppointedRepVerbalContactDate

716

REST ReferenceHealth Cloud Developer Guide

Page 721: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoDate and time correspondence was sentto the member's appointed representative.

StringappointedRepWrittenContactDate

Maps to:CareRequest.AppointedRepWrittenContactDate

46.0NoAppointed representative for the member.If provided, the first name, last name,

AppointedRepresentativeInput

appointedRepresentative

birthdate, and suffix fields are used to findat a unique Id, which is used to updateCareRequest.AppointedRepresentativeIdfield.

46.0NoApproved number of days for theadmission. Maps to:CareRequest.ApprovedLengthOfStay

IntegerapprovedLengthOfStay

46.0NoApproved level of care for the patient, forexample, Hospital-Observaton or

StringapprovedLevelOfCare

SNF-Rehabilitation. Screen reader supportenabled. Maps to:CareRequest.ApprovedLevelOfCare

46.0NoClaim number for the medical service ormedication, if one exists. Maps to:CareRequest.ClaimNumber

StringclaimNumber

46.0NoClinical case type for the patient, forexample, High Risk Fall or Adult Diabetes.

StringclinicalCaseType

Maps to:CareRequest.ClinicalCaseType

46.0NoIndicates whether criteria for care was met.Maps to:CareRequest.CriteriaMet

StringcriteriaMet

46.0NoTotal number of days for the admission.Maps to:CareRequest.CumulativeLengthOfStay

IntegercumulativeLengthOfStay

46.0NoLevel of care that the patient is receiving.Maps to:CareRequest.CurrentLevelOfCare

StringcurrentLevelOfCare

46.0NoDate by which the decision must be madefor the request. Maps to:CareRequest.DecisionDate

StringdecisionDate

46.0NoThe text of the determination letter sentto the member and provider. Maps to:CareRequest.DecisionLetter

StringdecisionLetter

717

REST ReferenceHealth Cloud Developer Guide

Page 722: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoNotes related to the decision. Maps to:CareRequest.DecisionNotes

StringdecisionNotes

46.0NoReason for the decision. Maps to:CareRequest.DecisionReason

StringdecisionReason

46.0NoText describing the reason for the decision.Maps to:CareRequest.DecisionReasonDescription

StringdecisionReasonDescription

46.0NoNumber of days denied for the admission.Maps to:CareRequest.DeniedLengthOfStay

IntegerdeniedLengthOfStay

46.0NoLevel of care denied for the patient. Mapsto:CareRequest.DeniedLevelOfCare

StringdeniedLevelOfCare

46.0NoNotes related to the disposition of therequest. Maps to:CareRequest.DispositionNotes

StringdispositionNotes

46.0NoDate the request is due for completion.Maps to: CareRequest.DueDate

StringdueDate

46.0NoThe start date for an effective-date range.Maps to:CareRequest.EffectiveFrom

StringeffectiveFrom

46.0NoThe end date for an effective-date range.Maps to:CareRequest.EffectiveTo

StringeffectiveTo

46.0NoExpiration date for the request. Maps to:CareRequest.ExpirationDate

StringexpirationDate

46.0NoIndicates whether a request was extended.Maps to:CareRequest.IsExtendedRequest

BooleanextendedRequest

46.0NoDate and time an extension was requested.Maps to:CareRequest.ExtensionRequestReceivedDate

StringextensionRequestReceivedDate

46.0NoComplaint ID number. Maps to:CareRequest.ExternalComplaintIdentifier

StringexternalComplaintId

46.0NoThe medical record number used toidentify a patient. Maps to:CareRequest.FacilityRecordNumber

StringfacilityRecordNumber

718

REST ReferenceHealth Cloud Developer Guide

Page 723: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoType of facility bed for the patient. Mapsto:CareRequest.FacilityRoomBedType

StringfacilityRoomBedType

46.0NoThe facility room number for the patient.Maps to:CareRequest.FacilityRoomNumber

StringfacilityRoomNumber

46.0NoFinal level of care the patient. Maps to:CareRequest.FinalLevelOfCare

StringfinalLevelOfCare

46.0NoThe person who reviewed the request.First Reviewer InputfirstReviewer

46.0NoNotes from the first reviewer related to thecase. Maps to:CareRequest.FirstReviewerNotes

StringfirstReviewerNotes

46.0NoMember's primary or general carepractitioner. Maps toCareRequest.generalPractitioner

General PractitionerInput

generalPractitioner

46.0NoDate when the primary care practitionerwas verbally notified of the decision. Maps

StringgeneralPractitionerVerbalNotificationDate

to:CareRequest.GeneralPractitionerVerbalNotifiedDate

46.0NoDate when the primary care practitionerwas notified of the decision by written

StringgeneralPractitionerWrittenNotificationDate

correspondence. Maps to:CareRequest.GeneralPractitionerWrittenNotifiedDate

46.0NoCertification end date for home healthcare. Maps to:CareRequestExtension.HomeHealthCertificationEndDate

StringhomeHealthCertificationEndDate

46.0NoCertification start date for home healthcare. Maps to:CareRequestExtension.HomeHealthCertificationStartDate

StringhomeHealthCertificationStartDate

46.0NoDate that home health services arescheduled or anticipated to start. Maps to:CareRequestExtension.HomeHealthStartDate

StringhomeHealthStartDate

46.0Required for PATCH.ID of the Care Request.Stringid

46.0NoDate and time when additionalinformation was received from the

StringinfoReceievedDate

provider or member. Maps to:CareRequest.InfoReceivedDate

46.0NoDate and time when additionalinformation was requested from the

StringinfoRequestedDate

719

REST ReferenceHealth Cloud Developer Guide

Page 724: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

provider or member. Maps to:CareRequest.InfoRequestedDate

46.0NoDate of initial denial notification. Maps to:CareRequest.InitialDenialNotificationDate

StringinitialDenialNotificationDate

46.0NoThe medical director who reviewed therequest.

Medical DirectorInput

medicalDirector

46.0NoNotes from the medical director related tothe request. Maps to:CareRequest.MedicalDirectorNotes

StringmedicalDirectorNotes

46.0NoDate and time when the member wascontacted. Maps to:CareRequest.MemberContactDateTime

StringmemberContactDate

46.0NoInsurance group number for the member.Maps to:CareRequest.MemberGroupNumber

StringmemberGroupNumber

46.0NoDate when the member was verballynotified of the decision. Maps to:CareRequest.MemberVerbalNotificationDate

StringmemberVerbalNotificationDate

46.0NoDate when the member was notified ofthe decision by written correspondence.

StringmemberWrittenNotificationDate

Maps to:CareRequest.MemberWrittenNotificationDate

46.0NoDate the case was modified. Maps to:CareRequest.ModificationDate

StringmodificationDate

46.0NoModified number of days for theadmission. Maps to:CareRequest.ModifiedLengthOfStay

IntegermodifiedLengthOfStay

46.0NoModified level of care for the patient. Mapsto:CareRequest.ModifiedLevelOfCare

StringmodifiedLevelOfCare

46.0YesName of the Care Request. Maps to:CareRequest.Name

Stringname

46.0NoDate the next review is scheduled forcompletion. Maps to:CareRequest.NextReviewDate

StringnextReviewDate

46.0NoNursing home-resident status at the timeof service. Maps to:CareRequestExtension.NursingHomeResidentialStatus

StringnursingHomeResidentialStatus

720

REST ReferenceHealth Cloud Developer Guide

Page 725: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoThe medical director who denied theoriginal request.

Original DenialMedical DirectorInput

originalDenialMedicalDirector

46.0NoIndicator of whether this provider hasentered into an agreement with the

StringparProvider

insurance carrier. Maps to:CareRequest.ParProvider

46.0NoPlace of service for the member's care suchas an inpatient hospital or an ambulatory

StringplaceOfService

surgery center. Maps to:CareRequest.PlaceOfService

46.0NoDate and time when the provider wascontacted. Maps to:CareRequest.PractitionerContactDateTime

StringpractitionerContactDate

46.0NoQuantity of the request.Integerquantity

46.0NoQuantity type for the request such as days,units, or visits. Maps to:CareRequest.QuantityType

StringquantityType

46.0NoDate the request was received. Maps to:CareRequest.ReceivedDate

StringreceivedDate

46.0NoDate of reconsideration denial notification.Maps to:CareRequest.ReconsiderationDenialNotificationDate

StringreconsiderationDenialNotificationDate

46.0NoRecord type of the care request object.StringrecordType

46.0NoID of the record type of the care requestobject.

StringrecordTypeId

46.0NoReference authorization number for anappeal, complaint, or grievance. Maps to:CareRequest.ReferenceCaseNumber

StringreferenceCaseNumber

46.0NoReason the request was reopened. Mapsto: CareRequest.ReopenReason

StringreopenReason

46.0NoDescription of why the request wasreopened. Maps to:CareRequest.ReopenReasonDescription

StringreopenReasonDescription

46.0NoDate the request was reopened. Maps to:CareRequest.ReopenedDate

StringreopenedDate

46.0NoCategory type of the request. Maps to:CareRequestExtension.RequestType

StringrequestType

721

REST ReferenceHealth Cloud Developer Guide

Page 726: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoDate the request was originally requested.Maps to:CareRequest.RequestedDate

StringrequestedDate

46.0NoRequested level of care for the patient.Maps to:CareRequest.RequestedLevelOfCare

StringrequestedLevelOfCare

46.0NoIndicates the role of the individualinitiating the request. Maps to:CareRequest.RequesterType

StringrequesterType

46.0NoOrdering or referring practitioner for therequest.

RequestingPractitioner Input

requestingPractitioner

46.0NoRequesting Practitioner License Maps to:CareRequest.RequestingPractitionerLicense

StringrequestingPractitionerLicense

46.0NoSpecialty of the practitioner, for example,Family Practice or General Surgery. Maps

StringrequestingPractitionerSpecialty

to:CareRequest.RequestingPractitionerSpecialty

46.0NoDate when the practitioner was verballynotified of the decision. Maps to:CareRequest.RequestingPractitionerVerbalNotifiedDate

StringrequestingPractitionerVerbalNotificationDate

46.0NoDate when the practitioner was notifiedof the decision by written correspondence.

StringrequestingPractitionerWrittenNotificationDate

Maps to:CareRequest.RequestingPractitionerWrittenNotifiedDate

46.0NoDate when the complaint, appeal, orgrievance was resolved. Maps to:CareRequest.ResolutionDate

StringresolutionDate

46.0NoDate and time when a resolution letter wassent to the requester. Maps to:CareRequest.ResolutionLetterSentDate

StringresolutionLetterSentDate

46.0NoResolution notes for the request. Maps to:CareRequest.ResolutionNotes

StringresolutionNotes

46.0NoDate the review was completed. Maps to:CareRequest.ReviewDate

StringreviewDate

46.0NoField for notes related to the root cause forthe request. Maps to:CareRequest.RootCauseNotes

StringrootCauseNotes

722

REST ReferenceHealth Cloud Developer Guide

Page 727: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoAnticipated admission date for the patient.Maps to:CareRequest.ScheduledAdmissionDate

StringscheduledAdmissionDate

46.0NoScheduled discharge date for the patient.Maps to:CareRequest.ScheduledDischargeDate

StringscheduledDischargeDate

46.0NoDate when patient received the service.Maps to:CareRequest.ServiceDate

StringserviceDate

46.0NoThe level of service rendered. Maps to:CareRequestExtension.ServiceLevel

StringserviceLevel

46.0NoClassification of the type of service. Mapsto:CareRequestExtention.ServiceType

StringserviceType

46.0NoIndicates whether the member has alreadyreceived the medial service or medication.

BooleanserviceorMedicationReceived

Maps to:CareRequest.IsServiceOrMedicationReceived

46.0NoFacility where the service is beingprovided.

Servicing FacilityInput

servicingFacility

46.0NoPractitioner administering the service.ServicingPractitioner Input

servicingPractitioner

46.0NoLicense type of the practitioner. Maps to:CareRequest.ServicingPractitionerLicense

StringservicingPractitionerLicense

46.0NoSpecialty of the practitioner. Maps to:CareRequest.ServicingPractitionerSpecialty

StringservicingPractitionerSpecialty

46.0NoSystem from which this request wassourced. Maps to:CareRequest.SourceSystem

StringsourceSystem

46.0NoID of the system from which the requestwas sourced. Maps to:CareRequest.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0NoThe timestamp of the most recent updatefrom the source system. Maps to:CareRequest.SourceSystemModified

StringsourceSystemModified

SEE ALSO:

CareRequest

723

REST ReferenceHealth Cloud Developer Guide

Page 728: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Request Item InputThe details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associatedwith a care request.

Root XML tag<careRequestItem>

JSON example

{"name": "95810","codeType": "CPT","sourceSystem": "source_system_name","codeDescription": "Dysuria","sourceSystemIdentifier": "0015cmi","quantity": "15"}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoThe approved quantity of the care item.Maps to:CareRequestItem.ApprovedQuantity

IntegerapprovedQuantity

46.0NoID of the service code. Maps to:CareRequestItem.Name

Stringcode

46.0NoDescription of the denied service code.Maps to:CareRequestItem.CodeDescription

StringcodeDescription

46.0NoCode type for the service. Maps to:CareRequestItem.CodeType

StringcodeType

46.0NoID of the code type for the service. Mapsto:CareRequestItem.CodeTypeIdentifier

StringcodeTypeId

46.0NoThe quantity of the denied service. Mapsto:CareRequestItem.DeniedQuantity

IntegerdeniedQuantity

46.0NoEffective date for the diagnosis Maps to:CareRequestItem.EffectiveDate

StringeffectiveDate

46.0NoTermination date for the service. Maps to:CareRequestItem.EndDate

StringendDate

46.0NoFree-form description of the procedure.Maps to:CareRequestItem.FreeFormProcedureDescription

StringfreeFormProcedureDescription

46.0NoHealthcare Procedure CodeStringhealthcareProcedureCode

724

REST ReferenceHealth Cloud Developer Guide

Page 729: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0Required for PATCH.Id of the CareRequestItemStringid

46.0NoModified Care End DateStringmodifiedCareEndDate

46.0NoModified CodeStringmodifiedCode

46.0NoDescription of the modified service code.Maps to:CareRequestItem.ModifiedCodeDescription

StringmodifiedCodeDescription

46.0NoCode type for the modified service. Mapsto:CareRequestItem.ModifiedCodeType

StringmodifiedCodeType

46.0NoID of the code type for the modifiedservice. Maps to:CareRequestItem.ModifiedCodeTypeIdentifier

StringmodifiedCodeTypeId

46.0NoEffective date for the modified service.Maps to:CareRequestItem.ModifiedEffectiveDate

StringmodifiedEffectiveDate

46.0NoModifier for modified service code. Mapsto:CareRequestItem.ModifiedModifier

StringmodifiedModifier

46.0NoModifier description for modified servicecode. Maps to:CareRequestItem.ModifiedModifierDescription

StringmodifiedModifierDescription

46.0NoThe modified quantity of requested care.Maps to:CareRequestItem.ModifiedQuantity

IntegermodifiedQuantity

46.0NoFirst modifier for the service code. Mapsto: CareRequestItem.Modifier

Stringmodifier1

46.0NoDescription for the first modifier for theservice code. Maps to:CareRequestItem.ModifierDescription

Stringmodifier1Description

46.0NoSecond modifier for service code. Maps to:CareRequestItem.Modifier2

Stringmodifier2

46.0NoDescription of the second modifier for theservice code. Maps to:CareRequestItem.Modifier2Description

Stringmodifier2Description

46.0NoThird modifier for service code. Maps to:CareRequestItem.Modifier3

Stringmodifier3

725

REST ReferenceHealth Cloud Developer Guide

Page 730: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoDescription of the third modifier for theservice code. Maps to:CareRequestItem.Modifier3Description

Stringmodifier3Description

46.0NoFourth modifier for service code. Maps to:CareRequestItem.Modifier4

Stringmodifier4

46.0NoDescription of the fourth modifier for theservice code. Maps to:CareRequestItem.Modifier4Description

Stringmodifier4Description

46.0NoThe quantity of the item that is requested.Maps to:CareRequestItem.Quantity

Integerquantity

46.0NoQuantity type for the request such as days,units, or visits. Maps to:CareRequestItem.QualityType

StringquantityType

46.0NoName of the service type such as medicalcare, diagnostic radiology, pharmacy, or

StringserviceCategory

diagnostic laboratory. Maps to:CareRequestItem.ServiceCategory

46.0NoAlphanumeric code that uniquely identifiesa service type. Maps to:CareRequestItem.ServiceCategoryCode

StringserviceCategoryCode

46.0NoSystem from which the request wassourced. Maps to:CareRequestItem.SourceSystem

StringsourceSystem

46.0NoID of the system from which the requestwas sourced. Maps to:CareRequestItem.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0NoTimestamp of the most recent update fromthe source system. Maps to:CareRequestItem.SourceSystemModified

StringsourceSystemModified

46.0NoThe authorization status of this service.Maps to:CareRequestItem.Status

Stringstatus

46.0NoReason for the authorization status of thisservice. Maps to:CareRequestItem.StatusReason

StringstatusReason

SEE ALSO:

CareRequestItem

726

REST ReferenceHealth Cloud Developer Guide

Page 731: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Requests List InputA list of care authorization requests.

Root XML tag<careRequestsList>

JSON Schema

{"careRequestsList": [{"careRequestsCase": {...},"patient": {...},"careRequestItems": [{...}],"careRequestDrugs": [{...}],"careRequest": {...},"careDiagnoses": [{...}],"subscriber": {...},"transportLocations": {...}}]}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesList of Care Requests to be created orupdated. (Up to 25 items.)

Care AuthorizationRequest Input[]

careRequestsList

Dispenser Address InputAddress of the pharmacy.

Root XML tag<dispenserAddress>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoCity of the pharmacy.StringdispenserCity

46.0NoCountry of the pharmacy.StringdispenserCountry

46.0NoPostal code of the pharmacy.StringdispenserPostalCode

46.0NoState of the pharmacy.StringdispenserState

46.0NoStreet of the pharmacy.StringdispenserStreet

Enrollee Product InputData for a single enrollee product.

727

REST ReferenceHealth Cloud Developer Guide

Page 732: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Root XML tag<careProgramProductData>

JSON example

{"providerId": "provider3","productId": "product4"

}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesID of the Product2 object as configuredin the Care System Field Mapping.

StringproductId

46.0NoID of the provider’s account as configuredin the Care System Field Mapping.

StringproviderId

First Reviewer InputThe name of the person who reviewed the request.

Root XML tag<firstReviewer>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesUser name of the first reviewer.Stringusername

General Practitioner InputMember's primary or general care practitioner.

Root XML tag<generalPractitioner>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesGeneral Practitioner NPI number.Stringnpi

Medical Director InputName of the medical director who reviewed the request.

728

REST ReferenceHealth Cloud Developer Guide

Page 733: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Root XML tag<medicalDirector>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesMedical Director’s username.Stringusername

Original Denial Medical Director InputThe name of the medical director who denied the original request.

Root XML tag<originalDenialMedicalDirector>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesOriginal Denial Medical Director’susername.

Stringusername

Patient InputInput containing data for a single patient.

Root XML tag<patientData>

JSON example

{"patientId": "patient2","careProgramProductData": [{"providerId": "provider3","productId": "product4"

}]

}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoList of all objects that contain data relatedto the enrollee’s care program product.

Enrollee ProductInput[]

careProgramProductData

46.0YesID of the patient as configured in the caresystem field mappings.

StringpatientId

729

REST ReferenceHealth Cloud Developer Guide

Page 734: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Program Enrollment InputRequest body for care program enrollment.

Root XML tag<careProgramEnrollmentData>

JSON example

{"programId": "programId1","sourceSystem": "source-system-name","patientData": [{"patientId": "patient1","careProgramProductData": [{"providerId": "provider1","productId": "product1"

},{"providerId": "provider1","productId": "product2"

}]

},{"patientId": "patient2","careProgramProductData": [{"providerId": "provider3","productId": "product4"

}]

}]

}

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesList of all objects that contain patients data.You can have up to 200 items in this list.

Patient Input []patientData

46.0YesID of the care program as configured inthe care system field mappings.

StringprogramId

46.0YesName of the source system as configuredin the care system field mappings.

StringsourceSystem

Requesting Practitioner InputOrdering or referring practitioner for the request.

730

REST ReferenceHealth Cloud Developer Guide

Page 735: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Root XML tag<requestingPractitioner>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesRequesting Practitioner‘s NPI number.Stringnpi

Servicing Facility InputFacility where the service is being provided.

Root XML tag<servicingFacility>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesServicing facility’s NPI number.Stringnpi

Servicing Practitioner InputPractitioner administering the service.

Root XML tag<servicingPractitioner>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0YesServicing practitioner’s NPI number.Stringnpi

Care Request Subscriber InputThe primary member on the plan.

Root XML tag<subscriber>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoSubscriber’s address line 1.StringaddressLine1

46.0NoSubscriber’s address line 2.StringaddressLine2

731

REST ReferenceHealth Cloud Developer Guide

Page 736: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

RequiredDescriptionTypeName

46.0NoSubscriber’s city.Stringcity

46.0NoFirst name of the subscriber. Maps to:Account.FirstName

StringfirstName

46.0YesLast name of the subscriber. Maps to:Account.LastName

StringlastName

46.0YesSubscriber Member ID.StringmemberId

46.0NoMiddle name of the subscriber. Maps to:Account.MiddleName

StringmiddleName

46.0NoSubscriber’s state.Stringstate

46.0NoName suffix of the subscriber for a personaccount. Maximum size is 40 characters.Maps to: Account.Suffix

Stringsuffix

46.0NoSubscriber’s zip code.StringzipCode

Transport Location InputInput representation for Transport Location

Root XML tag<transportLocation>

Properties

AvailableVersion

RequiredDescriptionTypeName

46.0NoDistance traveled during ambulancetransport. Maps to:CareRequestItem.AmbulanceTransportDistance

DoubleambulanceTransportDistance

46.0NoReason for ambulance transport. Maps to:CareRequestItem.AmbulanceTransportReason

StringambulanceTransportReason

46.0NoType of ambulance transport. Maps to:CareRequestItem.AmbulanceTransportType

StringambulanceTransportType

46.0YesName of the transport location.Stringname

Response BodiesA resource can return a response body in either JSON or XML format.

Refer to HTTP response code to find out whether the request was successful or not, as well as the error messages for the failed requests.

732

REST ReferenceHealth Cloud Developer Guide

Page 737: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Appointed Representative

Person who is an appointed representative for the member.

Care Request Case

Case related to the care request.

Care Request Patient

The patient for whom the request is being raised.

Care Authorization Request

Output of create or update request for care services review.

Care Authorization Request Related Record

Care Authorization request related record output representation

Care Authorization Request Result

Result of POST or PATCH request.

Create or Update Care Authorization Request Response

Response to create or update care services review request.

Care Diagnosis

Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.

Care Program Enrollment Result

Result containing details about a single patient enrollment.

Care Request Drug

Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associatedwith a care request.

Care Request Item

The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can beassociated with a care request.

Care Request

The general details of a care-related request including member information, admission date, decision reason, and so on. A singlerequest can contain multiple diagnoses, services, or drugs. Care requests include prior authorizations for drugs and services, admissionnotifications, concurrent review of admissions, appeals, complaints, and grievances.

Care Authorization Request Response

The response body for the Care Services Review GET request.

Dispenser Address

Pharmacy address.

Enrollee Product Result

Details about the enrollee’s products.

Enrollment Card Result

Details of the enrollment care for a single enrollee.

Error Message

A generic error message containing error code and the message text.

First Reviewer

The name of the person who reviewed the request first.

733

REST ReferenceHealth Cloud Developer Guide

Page 738: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

General Practitioner

Member's primary or general care practitioner.

Medical Director

Name of the medical director who reviewed the request.

Original Denial Medical Director

The name of the medical director who denied the original request.

Program Enrollment Result

Result containing details of all patient enrollment status. If there is success, it contains id of new records created for each patient.

Requesting Practitioner

Ordering or referring practitioner for the request.

Servicing Facility

Facility where the service is being provided.

Servicing Practitioner

Practitioner administering the service.

Subscriber

The primary member on the plan.

Transport Location

Transport Location output representation

Appointed RepresentativePerson who is an appointed representative for the member.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0First Name of the appointed representative.Maps to: Account.FirstName

StringfirstName

46.0Big, 46.0Last Name of the appointed representative.Maps to: Account.LastName

StringlastName

Care Request CaseCase related to the care request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Name of the account.StringaccountName

46.0Big, 46.0Case number.StringcaseNumber

46.0Big, 46.0The source of the case, such as Email, Phone,or Web. Maps to: Case.Origin

StringcaseOrigin

46.0Big, 46.0Case owner.StringcaseOwner

734

REST ReferenceHealth Cloud Developer Guide

Page 739: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0The reason why the case was created, suchas Instructions not clear, or User didn’tattend training. Maps to: Case.Reason

StringcaseReason

46.0Big, 46.0Indicates if the case is closed.Booleanclosed

46.0Big, 46.0Contact Name.StringcontactName

46.0Big, 46.0Case created by.StringcreatedBy

46.0Big, 46.0Date and time when the case was closed.StringdateClosed

46.0Big, 46.0Date and time when the case was opened.StringdateOpened

46.0Big, 46.0A text description of the case.Stringdescription

46.0Big, 46.0Indicates if the case is escalated.Booleanescalated

46.0Big, 46.0Last modified by.StringlastModifiedBy

46.0Big, 46.0Last modified date of the case.StringlastModifiedDate

46.0Big, 46.0Last referenced date of the case.StringlastReferencedDate

46.0Big, 46.0Last viewed date of the case.StringlastViewedDate

46.0Big, 46.0Parent Case.StringparentCase

46.0Big, 46.0The importance or urgency of the case, suchas High, Medium, or Low. Maps to:Case.Priority

Stringpriority

46.0Big, 46.0The status of the case. Maps to:Case.Status

Stringstatus

46.0Big, 46.0The subject of the case. Maps to:Case.Subject

Stringsubject

46.0Big, 46.0The type of case, such as Feature Requestor Question. Maps to: Case.Type

Stringtype

46.0Big, 46.0The company name that was entered whenthe case was created. This field can't be

StringwebCompany

updated after the case has been created.Maps to: Case.SuppliedCompany

46.0Big, 46.0The email address that was entered whenthe case was created. This field can't be

StringwebEmail

updated after the case has been created.Maps to: Case.SuppliedEmail

46.0Big, 46.0The name that was entered when the casewas created. This field can't be updated after

StringwebName

735

REST ReferenceHealth Cloud Developer Guide

Page 740: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

the case has been created. Maps to:Case.SuppliedName

46.0Big, 46.0The phone number that was entered whenthe case was created. This field can't be

StringwebPhone

updated after the case has been created.Maps to: Case.SuppliedPhone

Care Request PatientThe patient for whom the request is being raised.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Date of birth of the patient.StringbirthDate

46.0Big, 46.0First name of the patient.StringfirstName

46.0Big, 46.0Last name of the patient.StringlastName

46.0Big, 46.0Insurance identifier for the member.StringmemberId

Care Authorization RequestOutput of create or update request for care services review.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0The patient for whom the request is raised.Care Request PatientcareAuthorizationPatient

46.0Big, 46.0A list of associated diagnoses including codetype, name, and description. One or more

Care Diagnosis[]careDiagnoses

care diagnoses can be associated with a carerequest.

46.0Big, 46.0A list of requested drugs including name,strength, frequency, and instructions for

Care Request Drug[]careRequestDrugs

administration. One or more drug requestscan be associated with a care request.

46.0Big, 46.0A list of care request items containing name,modifiers, and the effective date. One or

Care Request Item[]careRequestItems

more care service requests can beassociated with a care request.

46.0Big, 46.0The general details of a care-related requestincluding member information, admission

Care RequestcareRequest

date, decision reason, and so on. A single

736

REST ReferenceHealth Cloud Developer Guide

Page 741: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

request can contain multiple diagnoses,services, or drugs. Care requests includeprior authorizations for drugs and services,admission notifications, concurrent reviewof admissions, appeals, complaints, andgrievances.

46.0Big, 46.0Case related to the care request.Care Request CasecareRequestCase

46.0Big, 46.0The primary member on the plan.Subscribersubscriber

46.0Big, 46.0Transport Location OutputTransport Location[]transportLocations

Care Authorization Request Related RecordCare Authorization request related record output representation

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Indicates if the operation was a success.BooleanisSuccess

46.0Big, 46.0Indicate if the record was created.Booleancreated

46.0Big, 46.0Id for the newly created record.Stringid

46.0Big, 46.0The type of the object created.StringobjectType

46.0Big, 46.0Indicates the status of the record creation.Stringstatus

Care Authorization Request ResultResult of POST or PATCH request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0List of related recordsCare AuthorizationRequest RelatedRecord[]

relatedRecords

Create or Update Care Authorization Request ResponseResponse to create or update care services review request.

AvailableVersion

Filter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Care Authorization returned codeStringcode

737

REST ReferenceHealth Cloud Developer Guide

Page 742: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

AvailableVersion

Filter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Flag to indicate if the request wassuccessful.

BooleanisSuccess

46.0Small, 46.0If there is any error, this property containsthe error message.

Stringmessage

46.0Small, 46.0Care Authorization Request results outputCare AuthorizationRequest[]

outputResults

46.0Small, 46.0Care Authorization Request resultCare AuthorizationRequest Result[]

result

Care DiagnosisAssociated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Name of the diagnosis code. Maps to:CareDiagnosis.Name

Stringcode

46.0Big, 46.0Diagnosis code description. Maps to:CareDiagnosis.CodeDescription

StringcodeDescription

46.0Big, 46.0Code type for the diagnosis. Maps to:CareDiagnosis.CodeType

StringcodeType

46.0Big, 46.0ID of the code type for the diagnosis. Mapsto:CareDiagnosis.CodeTypeIdentifier

StringcodeTypeID

46.0Big, 46.0Discharge diagnosis code. Maps to:CareDiagnosis.DischargeCode

StringdischargeCode

46.0Big, 46.0Description of the discharge diagnosis code.Maps to:CareDiagnosis.DischargeCodeDescription

StringdischargeCodeDescription

46.0Big, 46.0Code type for the discharge diagnosis. Mapsto:CareDiagnosis.DischargeCodeType

StringdischargeCodeType

46.0Big, 46.0ID of the code type for the dischargediagnosis. Maps to:CareDiagnosis.DischargeCodeTypeIdentifier

StringdischargeCodeTypeId

46.0Big, 46.0Effective date for the discharge diagnosis.Maps to:CareDiagnosis.DischargeDiagnosisEffectiveDate

StringdischargeDiagnosisEffectiveDate

738

REST ReferenceHealth Cloud Developer Guide

Page 743: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Termination date for the dischargediagnosis. Maps to:CareDiagnosis.DischargeDiagnosisEndDate

StringdischargeDiagnosisEndDate

46.0Big, 46.0Effective date for the diagnosis. Maps to:CareDiagnosis.EffectiveDate

StringeffectiveDate

46.0Big, 46.0Termination date for the diagnosis. Mapsto: CareDiagnosis.EndDate

StringendDate

46.0Big, 46.0Healthcare Diagnosis CodeStringhealthcareDiagnosisCode

46.0Big, 46.0IdStringid

46.0Big, 46.0Modified diagnosis code. Maps to:CareDiagnosis.ModifiedCode

StringmodifiedCode

46.0Big, 46.0Modified diagnosis code description. Mapsto:CareDiagnosis.ModifiedCodeDescription

StringmodifiedCodeDescription

46.0Big, 46.0Code type for the modified diagnosis. Mapsto:CareDiagnosis.ModifiedCodeType

StringmodifiedCodeType

46.0Big, 46.0ID of the code type for the modifieddiagnosis. Maps to:CareDiagnosis.ModifiedCodeTypeIdentifier

StringmodifiedCodeTypeId

46.0Big, 46.0Modified effective date for the diagnosis.Maps to:CareDiagnosis.ModifiedEffectiveDate

StringmodifiedEffectiveDate

46.0Big, 46.0Modified termination date for the diagnosis.Maps to:CareDiagnosis.ModifiedEndDate

StringmodifiedEndDate

46.0Big, 46.0Modified Primary DiagnosisBooleanmodifiedPrimaryDiagnosis

46.0Big, 46.0PrimaryBooleanprimary

46.0Big, 46.0Primary Discharge DiagnosisBooleanprimaryDischargeDiagnosis

46.0Big, 46.0System from which this request wassourced. Maps to:CareDiagnosis.SourceSystem

StringsourceSystem

46.0Big, 46.0ID of the system from which the requestwas sourced. Maps to:CareDiagnosis.SourceSystemIdentifier

StringsourceSystemIdentifier

739

REST ReferenceHealth Cloud Developer Guide

Page 744: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Timestamp of the most recent update fromthe source system. Maps to:CareDiagnosis.SourceSystemModified

StringsourceSystemModified

Care Program Enrollment ResultResult containing details about a single patient enrollment.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0A list containing results of care programenrollee products creation for each enrollee.

Enrollee ProductResult[]

enrolleeProducts

46.0Small, 46.0Results of care program enrollment cardcreation for the enrollee.

Enrollment CardResult

enrollmentCard

46.0Small, 46.0Error code and message.Error Messageerror

46.0Small, 46.0Indicates if the operation was a success.BooleanisSuccess

46.0Big, 46.0Indicate if the record was created.Booleancreated

46.0Big, 46.0Id for the newly createdCareProgramEnrollee record.

Stringid

46.0Big, 46.0The type of the object created. In this case,it is CareProgramEnrollee.

StringobjectType

46.0Big, 46.0Indicates the status of the record creation.Stringstatus

Care Request DrugRequested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associatedwith a care request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Approved quantity of the drug. Maps to:CareRequestDrug.ApprovedUnits

IntegerapprovedUnits

46.0Big, 46.0Code for the drug. Maps to:CareRequestDrug.Code

Stringcode

46.0Big, 46.0ID code type for the drug. Maps to:CareRequestDrug.CodeType

StringcodeType

46.0Big, 46.0Number of days to supply the drug. Mapsto: CareRequestDrug.DaysSupply

IntegerdaysSupply

740

REST ReferenceHealth Cloud Developer Guide

Page 745: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Denied quantity of the drug. Maps to:CareRequestDrug.DeniedUnits

IntegerdeniedUnits

46.0Big, 46.0Pharmacy address.Dispenser AddressdispenserAddress

46.0Big, 46.0Pharmacy fax number. Maps to:CareRequestDrug.DispenserFaxNumber

StringdispenserFaxNumber

46.0Big, 46.0ID for the pharmacy. Maps to:CareRequestDrug.DispenserIdentifier

StringdispenserId

46.0Big, 46.0Name of the pharmacy. Maps to:CareRequestDrug.DispenserName

StringdispenserName

46.0Big, 46.0Pharmacy phone number. Maps to:CareRequestDrug.DispenserPhoneNumber

StringdispenserPhoneNumber

46.0Big, 46.0Pharmacy tax identification number. Mapsto:CareRequestDrug.DispenserTaxIdentifier

StringdispenserTaxId

46.0Big, 46.0Dose of the drug. Maps to:CareRequestDrug.Dose

Stringdose

46.0Big, 46.0Frequency of the drug. Maps to:CareRequestDrug.Frequency

Stringfrequency

46.0Big, 46.0IdStringid

46.0Big, 46.0Code for the modified drug. Maps to:CareRequestDrug.ModifiedCode

StringmodifiedCode

46.0Big, 46.0ID code type for the modified drug. Mapsto:CareRequestDrug.ModifiedCodeType

StringmodifiedCodeType

46.0Big, 46.0Number of days of supply for the modifieddrug. Maps to:CareRequestDrug.ModifiedDaysSupply

IntegermodifiedDaysSupply

46.0Big, 46.0Dose of the modified drug. Maps to:CareRequestDrug.ModifiedDose

StringmodifiedDose

46.0Big, 46.0Frequency of the modified drug. Maps to:CareRequestDrug.ModifiedFrequency

StringmodifiedFrequency

46.0Big, 46.0Name of the modified drug. Maps to:CareRequestDrug.ModifiedName

StringmodifiedName

46.0Big, 46.0Directions for use of the modified drug.Maps to:CareRequestDrug.ModifiedSig

StringmodifiedSig

741

REST ReferenceHealth Cloud Developer Guide

Page 746: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Strength of the modified drug. Maps to:CareRequestDrug.ModifiedStrength

StringmodifiedStrength

46.0Big, 46.0Duration of therapy for the modified drug.Maps to:CareRequestDrug.ModifiedTherapyDuration

IntegermodifiedTherapyDuration

46.0Big, 46.0Modified quantity of the drug. Maps to:CareRequestDrug.ModifiedUnits

IntegermodifiedUnits

46.0Big, 46.0Name of the drug. Maps to:CareRequestDrug.Name

Stringname

46.0Big, 46.0Date for the prescription. Maps to:CareRequestDrug.PrescriptionDate

StringprescriptionDate

46.0Big, 46.0Number of fills for the prescription. Maps to:CareRequestDrug.PrescriptionFills

IntegerprescriptionFills

46.0Big, 46.0Name of the service type such as medicalcare, diagnostic radiology, pharmacy, or

StringserviceCategory

diagnostic laboratory. Maps to:CareRequestDrug.ServiceCategory

46.0Big, 46.0Alphanumeric code that uniquely identifiesa service type. Maps to:CareRequestDrug.ServiceCategoryCode

StringserviceCategoryCode

46.0Big, 46.0Directions for use of the drug. Maps to:CareRequestDrug.Sig

Stringsig

46.0Big, 46.0System from which this request wassourced. Maps to:CareRequestDrug.SourceSystem

StringsourceSystem

46.0Big, 46.0ID of the system from which the requestwas sourced. Maps to:CareRequestDrug.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0Big, 46.0Timestamp of the most recent update fromthe source system. Maps to:CareRequestDrug.SourceSystemModified

StringsourceSystemModified

46.0Big, 46.0Strength of the drug. Maps to:CareRequestDrug.Strength

Stringstrength

46.0Big, 46.0Duration of therapy for the drug. Maps to:CareRequestDrug.TherapyDuration

IntegertherapyDuration

46.0Big, 46.0Quantity of the drug. Maps to:CareRequestDrug.Units

Integerunits

742

REST ReferenceHealth Cloud Developer Guide

Page 747: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Request ItemThe details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associatedwith a care request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0The approved quantity of the care item.Maps to:CareRequestItem.ApprovedQuantity

IntegerapprovedQuantity

46.0Big, 46.0ID of the service code. Maps to:CareRequestItem.Name

Stringcode

46.0Big, 46.0Description of the denied service code.Maps to:CareRequestItem.CodeDescription

StringcodeDescription

46.0Big, 46.0Code type for the service. Maps to:CareRequestItem.CodeType

StringcodeType

46.0Big, 46.0ID of the code type for the service. Maps to:CareRequestItem.CodeTypeIdentifier

StringcodeTypeId

46.0Big, 46.0The quantity of the denied service. Maps to:CareRequestItem.DeniedQuantity

IntegerdeniedQuantity

46.0Big, 46.0Effective date for the diagnosis Maps to:CareRequestItem.EffectiveDate

StringeffectiveDate

46.0Big, 46.0Termination date for the service. Maps to:CareRequestItem.EndDate

StringendDate

46.0Big, 46.0Free-form description of the procedure.Maps to:CareRequestItem.FreeFormProcedureDescription

StringfreeFormProcedureDescription

46.0Big, 46.0Healthcare Procedure CodeStringhealthcareProcedureCode

46.0Big, 46.0IdStringid

46.0Big, 46.0Modified Care End DateStringmodifiedCareEndDate

46.0Big, 46.0Modified CodeStringmodifiedCode

46.0Big, 46.0Description of the modified service code.Maps to:CareRequestItem.ModifiedCodeDescription

StringmodifiedCodeDescription

46.0Big, 46.0Code type for the modified service. Mapsto:CareRequestItem.ModifiedCodeType

StringmodifiedCodeType

743

REST ReferenceHealth Cloud Developer Guide

Page 748: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0ID of the code type for the modified service.Maps to:CareRequestItem.ModifiedCodeTypeIdentifier

StringmodifiedCodeTypeId

46.0Big, 46.0Effective date for the modified service. Mapsto:CareRequestItem.ModifiedEffectiveDate

StringmodifiedEffectiveDate

46.0Big, 46.0Modifier for modified service code. Maps to:CareRequestItem.ModifiedModifier

StringmodifiedModifier

46.0Big, 46.0Modifier description for modified servicecode. Maps to:CareRequestItem.ModifiedModifierDescription

StringmodifiedModifierDescription

46.0Big, 46.0The modified quantity of requested care.Maps to:CareRequestItem.ModifiedQuantity

IntegermodifiedQuantity

46.0Big, 46.0Modifier 1Stringmodifier1

46.0Big, 46.0Modifier 1 DescriptionStringmodifier1Description

46.0Big, 46.0Second modifier for service code. Maps to:CareRequestItem.Modifier2

Stringmodifier2

46.0Big, 46.0Description of the second modifier for theservice code. Maps to:CareRequestItem.Modifier2Description

Stringmodifier2Description

46.0Big, 46.0Third modifier for service code. Maps to:CareRequestItem.Modifier3

Stringmodifier3

46.0Big, 46.0Description of the third modifier for theservice code. Maps to:CareRequestItem.Modifier3Description

Stringmodifier3Description

46.0Big, 46.0Fourth modifier for service code. Maps to:CareRequestItem.Modifier4

Stringmodifier4

46.0Big, 46.0Description of the fourth modifier for theservice code. Maps to:CareRequestItem.Modifier4Description

Stringmodifier4Description

46.0Big, 46.0The quantity of the item that is requested.Maps to:CareRequestItem.Quantity

Integerquantity

46.0Big, 46.0Quantity type for the request such as days,units, or visits. Maps to:CareRequestItem.QualityType

StringquantityType

744

REST ReferenceHealth Cloud Developer Guide

Page 749: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Name of the service type such as medicalcare, diagnostic radiology, pharmacy, or

StringserviceCategory

diagnostic laboratory. Maps to:CareRequestItem.ServiceCategory

46.0Big, 46.0Alphanumeric code that uniquely identifiesa service type. Maps to:CareRequestItem.ServiceCategoryCode

StringserviceCategoryCode

46.0Big, 46.0System from which the request wassourced. Maps to:CareRequestItem.SourceSystem

StringsourceSystem

46.0Big, 46.0ID of the system from which the requestwas sourced. Maps to:CareRequestItem.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0Big, 46.0Timestamp of the most recent update fromthe source system. Maps to:CareRequestItem.SourceSystemModified

StringsourceSystemModified

46.0Big, 46.0The authorization status of this service. Mapsto: CareRequestItem.Status

Stringstatus

46.0Big, 46.0Reason for the authorization status of thisservice. Maps to:CareRequestItem.StatusReason

StringstatusReason

Care RequestThe general details of a care-related request including member information, admission date, decision reason, and so on. A single requestcan contain multiple diagnoses, services, or drugs. Care requests include prior authorizations for drugs and services, admission notifications,concurrent review of admissions, appeals, complaints, and grievances.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Date and time when an acknowledgmentletter was sent to the requester. Maps to:CareRequest.AcknowledgementLetterSentDate

StringacknowledgementLetterSentDate

46.0Big, 46.0Actual admission date for the patient. Mapsto:CareRequest.ActualAdmissionDate

StringactualAdmissionDate

46.0Big, 46.0Actual discharge date for the patient. Mapsto:CareRequest.ActualDischargeDate

StringactualDischargeDate

745

REST ReferenceHealth Cloud Developer Guide

Page 750: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Notes related to the admission. Maps to:CareRequest.AdmissionNotes

StringadmissionNotes

46.0Big, 46.0Where the patient was admitted from, forexample, a clinic or an emergency room.

StringadmissionSource

Maps to:CareRequest.AdmissionSource

46.0Big, 46.0Type of admission, for example, emergencyor elective. Maps to:CareRequest.AdmissionType

StringadmissionType

46.0Big, 46.0Ambulance Transport DistanceIntegerambulanceTransportDistance

46.0Big, 46.0Reason for ambulance transport. Maps to:CareRequestExtention.AmbulanceTransportReason

StringambulanceTransportReason

46.0Big, 46.0Type of ambulance transport. Maps to:CareRequestExtention.AmbulanceTransportType

StringambulanceTransportType

46.0Big, 46.0Date and time when the Appointment ofRepresentative (AOR) form was received.

StringaorReceivedDate

Maps to:CareRequest.AorReceivedDate

46.0Big, 46.0Date and time when the AOR form wasrequested. Maps to:CareRequest.AorRequestedDate

StringaorRequestedDate

46.0Big, 46.0Date and time of verbal contact with themember's appointed representative. Maps

StringappointedRepVerbalContactDate

to:CareRequest.AppointedRepVerbalContactDate

46.0Big, 46.0Date and time correspondence was sent tothe member's appointed representative.

StringappointedRepWrittenContactDate

Maps to:CareRequest.AppointedRepWrittenContactDate

46.0Big, 46.0Appointed representative for the member.AppointedRepresentative

appointedRepresentative

46.0Big, 46.0Approved number of days for the admission.Maps to:CareRequest.ApprovedLengthOfStay

IntegerapprovedLengthofStay

46.0Big, 46.0Approved level of care for the patient, forexample, Hospital-Observaton or

StringapprovedLevelofCare

SNF-Rehabilitation. Maps to:CareRequest.ApprovedLevelOfCare

746

REST ReferenceHealth Cloud Developer Guide

Page 751: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Claim number for the medical service ormedication, if one exists. Maps to:CareRequest.ClaimNumber

StringclaimNumber

46.0Big, 46.0Clinical case type for the patient, forexample, High Risk Fall or Adult Diabetes.

StringclinicalCaseType

Maps to:CareRequest.ClinicalCaseType

46.0Big, 46.0Indicates whether criteria for care was met.Maps to:CareRequest.CriteriaMet

StringcriteriaMet

46.0Big, 46.0Total number of days for the admission.Maps to:CareRequest.CumulativeLengthOfStay

IntegercumulativeLengthofStay

46.0Big, 46.0Level of care that the patient is receiving.Maps to:CareRequest.CurrentLevelOfCare

StringcurrentLevelofCare

46.0Big, 46.0Date by which the decision must be madefor the request. Maps to:CareRequest.DecisionDate

StringdecisionDate

46.0Big, 46.0Number of days remaining for a decision orresolution. Maps to:CareRequest.DecisionDaysRemaining

IntegerdecisionDaysRemaining

46.0Big, 46.0The text of the determination letter sent tothe member and provider. Maps to:CareRequest.DecisionLetter

StringdecisionLetter

46.0Big, 46.0Notes related to the decision. Maps to:CareRequest.DecisionNotes

StringdecisionNotes

46.0Big, 46.0Reason for the decision. Maps to:CareRequest.DecisionReason

StringdecisionReason

46.0Big, 46.0Text describing the reason for the decision.Maps to:CareRequest.DecisionReasonDescription

StringdecisionReasonDescription

46.0Big, 46.0Number of days denied for the admission.Maps to:CareRequest.DeniedLengthOfStay

IntegerdeniedLengthofStay

46.0Big, 46.0Level of care denied for the patient. Mapsto:CareRequest.DeniedLevelOfCare

StringdeniedLevelofCare

747

REST ReferenceHealth Cloud Developer Guide

Page 752: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Notes related to the disposition of therequest. Maps to:CareRequest.DispositionNotes

StringdispositionNotes

46.0Big, 46.0Date the request is due for completion.Maps to: CareRequest.DueDate

StringdueDate

46.0Big, 46.0The start date for an effective-date range.Maps to:CareRequest.EffectiveFrom

StringeffectiveFrom

46.0Big, 46.0The end date for an effective-date range.Maps to:CareRequest.EffectiveTo

StringeffectiveTo

46.0Big, 46.0Expiration date for the request. Maps to:CareRequest.ExpirationDate

StringexpirationDate

46.0Big, 46.0Extended Request Maps to:CareRequest.

BooleanextendedRequest

46.0Big, 46.0Date and time an extension was requested.Maps to:CareRequest.ExtensionRequestReceivedDate

StringextensionRequestReceivedDate

46.0Big, 46.0Complaint ID number. Maps to:CareRequest.ExternalComplaintIdentifier

StringexternalComplaintID

46.0Big, 46.0The medical record number used to identifya patient. Maps to:CareRequest.FacilityRecordNumber

StringfacilityRecordNumber

46.0Big, 46.0Type of facility bed for the patient. Maps to:CareRequest.FacilityRoomBedType

StringfacilityRoomBedType

46.0Big, 46.0The facility room number for the patient.Maps to:CareRequest.FacilityRoomNumber

StringfacilityRoomNumber

46.0Big, 46.0Final level of care the patient. Maps to:CareRequest.FinalLevelOfCare

StringfinalLevelofCare

46.0Big, 46.0The person who reviewed the request.First ReviewerfirstReviewer

46.0Big, 46.0Notes from the first reviewer related to thecase. Maps to:CareRequest.FirstReviewerNotes

StringfirstReviewerNotes

46.0Big, 46.0Member's primary or general carepractitioner.

General PractitionergeneralPractitioner

748

REST ReferenceHealth Cloud Developer Guide

Page 753: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Date when the primary care practitioner wasverbally notified of the decision. Maps to:CareRequest.GeneralPractitionerVerbalNotifiedDate

StringgeneralPractitionerVerbalNotificationDate

46.0Big, 46.0Date when the primary care practitioner wasnotified of the decision by written

StringgeneralPractitionerWrittenNotificationDate

correspondence. Maps to:CareRequest.GeneralPractitionerWrittenNotifiedDate

46.0Big, 46.0Certification end date for home health care.Maps to:CareRequestExtension.HomeHealthCertificationEndDate

StringhomeHealthCertificationEndDate

46.0Big, 46.0Certification start date for home health care.Maps to:CareRequestExtension.HomeHealthCertificationStartDate

StringhomeHealthCertificationStartDate

46.0Big, 46.0Date that home health services arescheduled or anticipated to start. Maps to:CareRequestExtension.HomeHealthStartDate

StringhomeHealthStartDate

46.0Big, 46.0IdStringid

46.0Big, 46.0Date and time when additional informationwas received from the provider or member.

StringinfoReceievedDate

Maps to:CareRequest.InfoReceivedDate

46.0Big, 46.0Date and time when additional informationwas requested from the provider or

StringinfoRequestedDate

member. Maps to:CareRequest.InfoRequestedDate

46.0Big, 46.0Date of initial denial notification. Maps to:CareRequest.InitialDenialNotificationDate

StringinitialDenialNotificationDate

46.0Big, 46.0Last Modified DateStringlastModifiedDate

46.0Big, 46.0The medical director who reviewed therequest.

Medical DirectormedicalDirector

46.0Big, 46.0Notes from the medical director related tothe request. Maps to:CareRequest.MedicalDirectorNotes

StringmedicalDirectorNotes

46.0Big, 46.0Insurance identifier for the member. Mapsto: CareRequest.MemberId

Stringmember

46.0Big, 46.0Member Contact Date Maps to:CareRequest.

StringmemberContactDate

749

REST ReferenceHealth Cloud Developer Guide

Page 754: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Insurance group number for the member.Maps to:CareRequest.MemberGroupNumber

StringmemberGroupNumber

46.0Big, 46.0Date when the member was verballynotified of the decision. Maps to:CareRequest.MemberVerbalNotificationDate

StringmemberVerbalNotificationDate

46.0Big, 46.0Date when the member was notified of thedecision by written correspondence. Maps

StringmemberWrittenNotificationDate

to:CareRequest.MemberWrittenNotificationDate

46.0Big, 46.0Date the case was modified. Maps to:CareRequest.ModificationDate

StringmodificationDate

46.0Big, 46.0Modified number of days for the admission.Maps to:CareRequest.ModifiedLengthOfStay

IntegermodifiedLengthofStay

46.0Big, 46.0Modified level of care for the patient. Mapsto:CareRequest.ModifiedLevelOfCare

StringmodifiedLevelofCare

46.0Big, 46.0Date the next review is scheduled forcompletion. Maps to:CareRequest.NextReviewDate

StringnextReviewDate

46.0Big, 46.0Nursing home resident status at the time ofservice. Maps to:CareRequestExtension.NursingHomeResidentialStatus

StringnursingHomeResidentialStatus

46.0Big, 46.0The medical director who denied theoriginal request.

Original DenialMedical Director

originalDenialMedicalDirector

46.0Big, 46.0Indicator of whether this provider hasentered into an agreement with the

StringparProvider

insurance carrier. Maps to:CareRequest.ParProvider

46.0Big, 46.0Place of service for the member's care suchas an inpatient hospital or an ambulatory

StringplaceofService

surgery center. Maps to:CareRequest.PlaceOfService

46.0Big, 46.0Practitioner Contact DateStringpractitionerContactDate

46.0Big, 46.0QuantityIntegerquantity

46.0Big, 46.0Quantity type for the request such as days,units, or visits. Maps to:CareRequest.QuantityType

StringquantityType

750

REST ReferenceHealth Cloud Developer Guide

Page 755: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Date the request was received. Maps to:CareRequest.ReceivedDate

StringreceivedDate

46.0Big, 46.0Date of reconsideration denial notification.Maps to:CareRequest.ReconsiderationDenialNotificationDate

StringreconsiderationDenialNotificationDate

46.0Big, 46.0Record TypeStringrecordType

46.0Big, 46.0Reference authorization number for anappeal, complaint, or grievance. Maps to:CareRequest.ReferenceCaseNumber

StringreferenceCaseNumber

46.0Big, 46.0Reason the request was reopened. Maps to:CareRequest.ReopenReason

StringreopenReason

46.0Big, 46.0Description of why the request wasreopened. Maps to:CareRequest.ReopenReasonDescription

StringreopenReasonDescription

46.0Big, 46.0Date the request was reopened. Maps to:CareRequest.ReopenedDate

StringreopenedDate

46.0Big, 46.0Category type of the request. Maps to:CareRequestExtension.RequestType

StringrequestType

46.0Big, 46.0Date the request was originally requested.Maps to:CareRequest.RequestedDate

StringrequestedDate

46.0Big, 46.0Requested level of care for the patient. Mapsto:CareRequest.RequestedLevelOfCare

StringrequestedLevelofCare

46.0Big, 46.0Indicates the role of the individual initiatingthe request. Maps to:CareRequest.RequesterType

StringrequesterType

46.0Big, 46.0Ordering or referring practitioner for therequest.

RequestingPractitioner

requestingPractitioner

46.0Big, 46.0Requesting Practitioner License Maps to:CareRequest.RequestingPractitionerLicense

StringrequestingPractitionerLicense

46.0Big, 46.0Specialty of the practitioner, for example,Family Practice or General Surgery. Maps to:CareRequest.RequestingPractitionerSpecialty

StringrequestingPractitionerSpecialty

46.0Big, 46.0Date when the practitioner was verballynotified of the decision. Maps to:CareRequest.RequestingPractitionerVerbalNotifiedDate

StringrequestingPractitionerVerbalNotificationDate

751

REST ReferenceHealth Cloud Developer Guide

Page 756: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Date when the practitioner was notified ofthe decision by written correspondence.

StringrequestingPractitionerWrittenNotificationDate

Maps to:CareRequest.RequestingPractitionerWrittenNotifiedDate

46.0Big, 46.0Date when the complaint, appeal, orgrievance was resolved. Maps to:CareRequest.ResolutionDate

StringresolutionDate

46.0Big, 46.0Date and time when a resolution letter wassent to the requester. Maps to:CareRequest.ResolutionLetterSentDate

StringresolutionLetterSentDate

46.0Big, 46.0Resolution notes for the request. Maps to:CareRequest.ResolutionNotes

StringresolutionNotes

46.0Big, 46.0Date the review was completed. Maps to:CareRequest.ReviewDate

StringreviewDate

46.0Big, 46.0Field for notes related to the root cause forthe request. Maps to:CareRequest.RootCauseNotes

StringrootCauseNotes

46.0Big, 46.0Anticipated admission date for the patient.Maps to:CareRequest.ScheduledAdmissionDate

StringscheduledAdmissionDate

46.0Big, 46.0Scheduled discharge date for the patient.Maps to:CareRequest.ScheduledDischargeDate

StringscheduledDischargeDate

46.0Big, 46.0Date when patient received the service.Maps to:CareRequest.ServiceDate

StringserviceDate

46.0Big, 46.0The level of service rendered. Maps to:CareRequestExtension.ServiceLevel

StringserviceLevel

46.0Big, 46.0Classification of the type of service. Maps to:CareRequestExtention.ServiceType

StringserviceType

46.0Big, 46.0Service or Medication Received.BooleanserviceorMedicationReceived

46.0Big, 46.0Facility where the service is being provided.Servicing FacilityservicingFacility

46.0Big, 46.0Practitioner administering the service.Servicing PractitionerservicingPractitioner

46.0Big, 46.0License type of the practitioner. Maps to:CareRequest.ServicingPractitionerLicense

StringservicingPractitionerLicense

46.0Big, 46.0Specialty of the practitioner. Maps to:CareRequest.ServicingPractitionerSpecialty

StringservicingPractitionerSpecialty

752

REST ReferenceHealth Cloud Developer Guide

Page 757: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0System from which this request wassourced. Maps to:CareRequest.SourceSystem

StringsourceSystem

46.0Big, 46.0ID of the system from which the requestwas sourced. Maps to:CareRequest.SourceSystemIdentifier

StringsourceSystemIdentifier

46.0Big, 46.0Timestamp of the most recent update fromthe source system. Maps to:CareRequest.SourceSystemModified

StringsourceSystemModified

Care Authorization Request ResponseThe response body for the Care Services Review GET request.

AvailableVersion

Filter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0A list of care authorization requests.Care AuthorizationRequest[]

careAuthorizationRequests

46.0Small, 46.0If the parameters were invalid, thisproperty contains the error message.

StringerrorMessage

46.0Small, 46.0This flag indicates if the request wassuccessful or not.

BooleanisSuccess

Dispenser AddressPharmacy address.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Dispenser CityStringdispenserCity

46.0Big, 46.0Dispenser CountryStringdispenserCountry

46.0Big, 46.0Dispenser Postal CodeStringdispenserPostalCode

46.0Big, 46.0Dispenser StateStringdispenserState

46.0Big, 46.0Dispenser StreetStringdispenserStreet

Enrollee Product ResultDetails about the enrollee’s products.

753

REST ReferenceHealth Cloud Developer Guide

Page 758: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Error code and message.Error Messageerror

46.0Small, 46.0Indicates if the operation was a success.BooleanisSuccess

46.0Small, 46.0Id of the care program product.StringproductId

46.0Small, 46.0Id of the care program provider.StringproviderId

46.0Big, 46.0Indicate if the record was created.Booleancreated

46.0Big, 46.0Id for the newly createdCareProgramEnrolleeProductrecord.

Stringid

46.0Big, 46.0The type of the object created. In this case,it isCareProgramEnrolleeProduct.

StringobjectType

46.0Big, 46.0Indicates the status of the record creation.Stringstatus

Enrollment Card ResultDetails of the enrollment care for a single enrollee.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Error code and message.Error Messageerror

46.0Small, 46.0Indicates if the operation was a success.BooleanisSuccess

46.0Big, 46.0Indicate if the record was created.Booleancreated

46.0Big, 46.0Id for the newly createdCareProgramEnrollmentCardrecord.

Stringid

46.0Big, 46.0The type of the object created. In this case,it is CareProgramEnrollmentCard.

StringobjectType

46.0Big, 46.0Indicates the status of the record creation.Stringstatus

Error MessageA generic error message containing error code and the message text.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0Error code.Stringcode

46.0Small, 46.0Error message text.Stringmessage

754

REST ReferenceHealth Cloud Developer Guide

Page 759: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

First ReviewerThe name of the person who reviewed the request first.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0usernameStringusername

General PractitionerMember's primary or general care practitioner.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0General Practitioner NPI number.StringgeneralPractitionerNpi

Medical DirectorName of the medical director who reviewed the request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0usernameStringusername

Original Denial Medical DirectorThe name of the medical director who denied the original request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0usernameStringusername

Program Enrollment ResultResult containing details of all patient enrollment status. If there is success, it contains id of new records created for each patient.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Small, 46.0A list containing the results of all the patientenrollments.

Care ProgramEnrollment Result[]

careProgramEnrollmentResults

46.0Small, 46.0Error output containing the code and themessage text.

Error Messageerror

46.0Small, 46.0Indicates whether the enrollment wassuccessful.

BooleanisSuccess

755

REST ReferenceHealth Cloud Developer Guide

Page 760: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Requesting PractitionerOrdering or referring practitioner for the request.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Requesting Practitioner NPI numberStringrequestingPractitionerNpi

Servicing FacilityFacility where the service is being provided.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Servicing Facility NPI numberStringservicingFacilityNpi

Servicing PractitionerPractitioner administering the service.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Servicing Practitioner NPI numberStringservicingPractitionerNpi

SubscriberThe primary member on the plan.

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0First name of the subscriber. Maps to:Account.FirstName

StringfirstName

46.0Big, 46.0Last name of the subscriber. Maps to:Account.LastName

StringlastName

46.0Big, 46.0Member ID for the subscriber. Maps to:careRequestExtention.SubscriberMemberIdentifier

StringmemberID

Transport LocationTransport Location output representation

756

REST ReferenceHealth Cloud Developer Guide

Page 761: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Available VersionFilter Group andVersion

DescriptionTypeProperty Name

46.0Big, 46.0Distance traveled during ambulancetransport. Maps to:CareRequestItem.AmbulanceTransportDistance

DoubleambulanceTransportDistance

46.0Big, 46.0Reason for ambulance transport. Maps to:CareRequestItem.AmbulanceTransportReason

StringambulanceTransportReason

46.0Big, 46.0Type of ambulance transport. Maps to:CareRequestItem.AmbulanceTransportType

StringambulanceTransportType

46.0Big, 46.0NameStringname

Health Cloud Metadata APIs

CareSystemFieldMappingRepresents a mapping from source system fields to Salesforce objects and fields. This type extends the Metadata metadata type andinherits its fullName field.

File Suffix and Directory LocationCareSystemFieldMapping components have the suffix .careSystemFieldMapping and are stored in thecareSystemFieldMappings folder.

VersionCareSystemFieldMapping components are available in API version 49.0 and later.

Special Access RulesTo use this metadata type, your Salesforce org must have the Health Cloud license and the user must have the Health Cloud Foundationpermission.

Fields

DescriptionField TypeField Name

The ID of the field in the external system.stringexternalIdField

Indicates whether this field mapping is active (true) or not (false).The default value is False.

booleanisActive

An auto-generated value that doesn’t currently impact the behavior ofthe metadata type.

booleanisProtected

Required. The name of the care system field mapping.stringmasterLabel

757

Health Cloud Metadata APIsHealth Cloud Developer Guide

Page 762: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DescriptionField TypeField Name

Required. The role the field represents. Valid values are:SourceSystemFieldRole(enumeration oftype string)

role

• Patient—When the role field is set to Patient, theEnrollment API uses the value of externalIdField as thepatient ID. This role can be used when targetObject is set toAccount.

• RemoteMonitoringDevice—Indicates whichexternalIdField on the Asset object maps to the Devicefield in the CareObservation object. This role can be used whentargetObject is set to Asset.

• RemoteMonitoringPatient—Indicates whichexternalIdField on the Account object maps to theObservedSubject field in the Care Observation object. Thisrole is used when targetObject is set to Account.

• ServiceProvider—The Enrollment API uses the value ofexternalIdField as the provider ID. This role is used whentargetObject is set to Account.

• NotApplicable—This role is used when targetObject isset to CareProgram or Product, which means that there isno applicable role.

The system where the record originated.stringsourceSystem

The name of the Salesforce object to which the external system field ismapped.

stringtargetObject

Declarative Metadata Sample DefinitionThe following is an example of a CareSystemFieldMapping component.

<?xml version="1.0" encoding="UTF-8"?><CareSystemFieldMapping xmlns="http://soap.sforce.com/2006/04/metadata">

<externalIdField>AccountNumber</externalIdField><isActive>true</isActive><isProtected>false</isProtected><masterLabel>Map1</masterLabel><role>Patient</role><sourceSystem>Epic</sourceSystem><targetObject>Account</targetObject>

</CareSystemFieldMapping>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata">

<types><members>patient</members>

758

CareSystemFieldMappingHealth Cloud Developer Guide

Page 763: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

<name>CareSystemFieldMapping</name></types><version>49.0</version>

</Package>

IconRepresents the mapping of custom icons to objects.This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory LocationIcon components have the suffix .icon and are stored in the icons folder.

VersionIcon components are available in API version 49.0 and later.

Special Access RulesTo use this metadata type, your Salesforce org must have the Health Cloud or Financial Services Cloud license.

Fields

DescriptionField TypeField Name

Required. The image file that is mapped to the object.

Use the ContentAsset metadata type to hold the icon image referencedin the image field.

stringimage

Required. A field value in the object. For example, with thePersonLifeEventobject, possible values for key can bebirthday, marriage, childbirth, and so on.

stringkey

Required. The object that is mapped to the image. Valid values are:IconUsageType(enumeration oftype string)

usageType

• PersonLifeEvent

• InsurancePolicy

• BusinessMilestone

Declarative Metadata Sample DefinitionThe following is an example of an Icon component.

<?xml version="1.0" encoding="UTF-8"?><Icon xmlns="http://soap.sforce.com/2006/04/metadata">

<usageType>PersonLifeEvent</usageType><key>Birth</key>

759

IconHealth Cloud Developer Guide

Page 764: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

<image>image</image></Icon>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata">

<types><members>icons</members><name>Icon</name>

</types><version>49.0</version>

</Package>

IndustriesSettingsRepresents settings for industries verticals like Financial Service Cloud, Consumer Goods Cloud, and Health Cloud.This type extends theMetadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory LocationIndustriesSettings are stored in a single file named Industries.settings in the settings directory.

VersionIndustries settings are available in API version 47.0 and later.

Special Access RulesSome settings are specific to an industry vertical and are only available to customers with org editions where the vertical is enabled.Users need the FSC Insurance permission set to access the settings available in editions with Financial Services Cloud.

Fields for Financial Services Cloud

DescriptionFieldType

Field Name

Indicates whether multiple producers can be assigned to the sameinsurance policy. The default is false. This field is available ineditions where Financial Services Cloud is enabled.

booleanallowMultipleProducersToWorkOnSamePolicy

Indicates whether insurance agents can access the master list ofcoverage types. The default is false. This field is available in editionswhere Financial Services Cloud is enabled.

booleanenableAccessToMasterListOfCoverageTypes

Indicates whether Lightning Scheduler service appointments areadded to users' Salesforce calendars. For example, if set to false,

booleanenableBlockResourceAvailabilityOrgPref

760

IndustriesSettingsHealth Cloud Developer Guide

Page 765: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DescriptionFieldType

Field Name

users won’t see their service appointments on their calendars. Thedefault is false.

Indicates whether users can add multiple service resources to a serviceappointment. The default is false.

booleanenableEventManagementOrgPref

Indicates whether sales managers can access the dashboard andprebuilt reports. The default is false. This field is available in API

booleanenableFSCInsuranceReport

version 48.0 and later in editions where Financial Services Cloud isenabled.

Note: This setting can be enabled only if theallowMultipleProducersToWorkOnSamePolicysetting is already set to true.

Indicates whether insurance can manage many-to-many relationshipsbetween claims and cases, claims and assets, and assets and policy

booleanenableManyToManyRelationships

participants. For example, if set to true, agents can handle multipleclaims through one case or have multiple cases handling one claim.The default is false. This field is available in editions where FinancialServices Cloud is enabled.

Indicates whether the calculation of assets and liabilities for residentialloan application records is enabled for your org (true or not (false).

booleanenableMortgageRlaTotalsOrgPref

The default is false. This field is available in editions where FinancialServices Cloud is enabled.

Indicates whether users can add multiple service resources to a serviceappointment. The default is false.

booleanenableMultiResourceOrgPref

Indicates whether users can add multiple service appointments to asingle time slot for a service resource. If set to false, concurrenttime slots are visible, but can't be modified. The default is false.

booleanenableOverbookingOrgPref

Indicates whether Einstein Referral Scoring for Financial Services Cloudis enabled for your org (true) or not (false). The default is false. Thisfield is available in editions where Financial Services Cloud is enabled.

booleanenableReferralScoring

Fields for Health Cloud

DescriptionFieldType

Field Name

Indicates whether provider data search is synced every six hours. Thedefault is false. This field is available in editions where Health Cloudis enabled.

booleanenableProviderSearchSyncOrgPref

Indicates whether the Intelligent Sales features are enabled.booleanenableMedicalDeviceEnabled

761

IndustriesSettingsHealth Cloud Developer Guide

Page 766: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DescriptionFieldType

Field Name

Indicates whether the visit data model is enabled.booleanenableVisitInventoryEnabled

Fields for Consumer Goods Cloud

DescriptionFieldType

Field Name

Indicates whether Einstein Object Detection is enabled for your org.The default is false. This field is available in editions whereConsumer Goods Cloud is enabled.

booleanenableObjectDetection

Declarative Metadata Sample DefinitionThe following is an example of a Industries.Settings metadata file.

<?xml version="1.0" encoding="UTF-8"?><IndustriesSettings xmlns="http://soap.sforce.com/2006/04/metadata">

<enableEventManagementOrgPref>true</enableEventManagementOrgPref><enableMultiResourceOrgPref>false</enableMultiResourceOrgPref><enableOverbookingOrgPref>true</enableOverbookingOrgPref><enableBlockResourceAvailabilityOrgPref>true</enableBlockResourceAvailabilityOrgPref>

<enableAccessToMasterListOfCoverageTypes>true</enableAccessToMasterListOfCoverageTypes>

<enableManyToManyRelationships>true</enableManyToManyRelationships>

<allowMultipleProducersToWorkOnSamePolicy>false</allowMultipleProducersToWorkOnSamePolicy>

<enableMortgageRlaTotalsOrgPref>true</enableMortgageRlaTotalsOrgPref><enableObjectDetection>true</enableObjectDetection><enableProviderSearchSyncOrgPref>true</enableProviderSearchSyncOrgPref><enableReferralScoring>true</enableReferralScoring><enableFSCInsuranceReport>true</enableFSCInsuranceReport>

</IndustriesSettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata">

<types><members>Industries</members><name>Settings</name>

</types><version>47.0</version>

</Package>

762

IndustriesSettingsHealth Cloud Developer Guide

Page 767: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Health Cloud Custom Metadata Types

Custom metadata is customizable, deployable, packageable, and upgradeable application metadata.

GroupRecordTypeMapper

Maps a new custom Group record type to the standard Group record type.

IndividualRecordTypeMapper

Maps a new custom Individual record type to the standard Individual record type.

RiskScoreAgeBandContinuedEnrollee

Mapping used to indicate risk score based on age and continued enrollment status.

RiskScoreAgeBandNewEnrollee

Mapping used to indicate risk score based on age and new enrollment status.

RiskScoreHCCCode

Maps risk score to HCC codes.

RiskScoreDiseaseInteraction

Maps risk scores to disease interactions.

RiskScoreMedicaidInteractions

Maps risk scores to Medicaid and originally disabled interactions.

HealthCloudSetting

Holds mappings for field sets and other customizable elements in Health Cloud. To change a delivered setting, deactivate the setting,clone it, and make the new setting active.

HL7Setting

Specifies parser support for electronic health record transmissions using the HL7 standard.

HL7ParserMapping

Determines which Apex class is used to parse HL7 segments.

HcServiceOrchestrationSetting

Determines order of execution of parser operations.

GroupRecordTypeMapperMaps a new custom Group record type to the standard Group record type.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), describeSObjects(), query(), retrieve(), search()

DetailsField

Typestring

AccountRecordType__c

763

Health Cloud Custom Metadata TypesHealth Cloud Developer Guide

Page 768: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Nillable, Sort

DescriptionThe name of your new custom Group record type being mapped to the Group record type.

Note: This field is for Salesforce internal-use only. By default, this field doesn’t appear onany page layout.

Typestring

AccountRecordTypeNamespace__c

PropertiesFilter, Group, Nillable, Sort

DescriptionNamespace for Account record type being mapped.

IndividualRecordTypeMapperMaps a new custom Individual record type to the standard Individual record type.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), describeSObjects(), query(), retrieve(), search()

DetailsField

Typestring

AccountRecordTypeNamespace__c

PropertiesFilter, Group, Nillable, Sort

DescriptionNamespace for Account record type being mapped.

Typestring

AccountRecordType__c

PropertiesFilter, Group, Nillable, Sort

DescriptionThe name of your new custom Individual record type being mapped to the standard Individualrecord type.

764

IndividualRecordTypeMapperHealth Cloud Developer Guide

Page 769: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Note: This field is for Salesforce internal-use only. By default, this field doesn’t appear onany page layout.

Typestring

ContactRecordTypeNamespace__c

PropertiesFilter, Group, Nillable, Sort

DescriptionNamespace for Contact record type being mapped.

Typestring

ContactRecordType__c

PropertiesFilter, Group, Nillable, Sort

DescriptionContact record type being mapped to the standard Individual record type.

Typestring

DetailPage__c

PropertiesFilter, Group, Nillable, Sort

DescriptionSalesforce internal-use only.

Typestring

IndividualType__c

PropertiesFilter, Group, Nillable, Sort

DescriptionType of Individual being mapped.

Typestring

LeadRecordTypeNamespace__c

PropertiesFilter, Group, Nillable, Sort

DescriptionLead namespace for your custom record type’s org.

Typestring

LeadRecordType__c

PropertiesFilter, Group, Nillable, Sort

765

IndividualRecordTypeMapperHealth Cloud Developer Guide

Page 770: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionLead Record Type to be used when converting Lead records. Leave this field blank to useany record type. All available record types are converted to an Individual record type unlessthere is another mapping specified.

RiskScoreAgeBandContinuedEnrolleeMapping used to indicate risk score based on age and continued enrollment status.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typedouble

AgeBandFrom__c

PropertiesFilter, Sort

DescriptionMinimum age in a defined group.

Typedouble

AgeBandTo__c

PropertiesFilter, Sort

DescriptionMaximum age in a defined group.

Typedouble

CommunityFBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityFBDualDisabled__c

766

RiskScoreAgeBandContinuedEnrolleeHealth Cloud Developer Guide

Page 771: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.

Typedouble

CommunityNonDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.

Typedouble

CommunityNonDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.

Typedouble

CommunityPBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityPBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.

Typedouble

Community__c

PropertiesDefaulted on create, Filter, Nillable, Sort

767

RiskScoreAgeBandContinuedEnrolleeHealth Cloud Developer Guide

Page 772: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates that the patient lives at home.

Typepicklist

Gender__c

PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort

DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.

Typedouble

Institutional__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether this record is active.

Typestring

YearSpan__c

PropertiesFilter, Group, Sort

DescriptionCalendar year that this metadata applies to.

RiskScoreAgeBandNewEnrolleeMapping used to indicate risk score based on age and new enrollment status.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

768

RiskScoreAgeBandNewEnrolleeHealth Cloud Developer Guide

Page 773: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedouble

AgeBandFrom__c

PropertiesFilter, Sort

DescriptionMinimum age in a defined group.

Typedouble

AgeBandTo__c

PropertiesFilter, Sort

DescriptionMaximum age in a defined group.

Typeboolean

CSNP__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionWhether the patient is part of a CSNP (Chronic Condition Special Needs Plan).

Typepicklist

Gender__c

PropertiesDefaulted on create, Filter, Group, Restricted picklist, Sort

DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether this record is active.

Typedouble

MedicaidNonOriginallyDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

769

RiskScoreAgeBandNewEnrolleeHealth Cloud Developer Guide

Page 774: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.

Typedouble

MedicaidOriginallyDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionPatient is a Medicaid patient and the original reason for Medicare entitlementwas due to disability.

Typedouble

NonMedicaidNonOriginallyDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas not due to disability.

Typedouble

NonMedicaidOriginallyDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionPatient is not a Medicaid patient and the original reason for Medicare entitlementwas due to disability.

Typestring

YearSpan__c

PropertiesFilter, Group, Sort

DescriptionCalendar year that this metadata applies to.

RiskScoreHCCCodeMaps risk score to HCC codes.

Note: New custom fields can’t be added to managed custom metadata types.

770

RiskScoreHCCCodeHealth Cloud Developer Guide

Page 775: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typedouble

Community__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home.

Typedouble

CommunityFBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityFBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.

Typedouble

CommunityNonDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of age.

Typedouble

CommunityNonDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled in Medicarebecause of disability.

771

RiskScoreHCCCodeHealth Cloud Developer Guide

Page 776: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedouble

CommunityPBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

Description

Typedouble

CommunityPBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.

Typestring

ConditionCategory__c

PropertiesFilter, Group, Sort

DescriptionIndicates the medical condition category that the HCC belongs to.

Typestring

Description__c

PropertiesFilter, Group, Nillable, Sort

DescriptionDescription of the medical condition category.

Typestring

HCCCode__c

PropertiesFilter, Group, Nillable, Sort

DescriptionThe HCC code related to the condition.

Typedouble

Institutional__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.

772

RiskScoreHCCCodeHealth Cloud Developer Guide

Page 777: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether this record is active.

Typestring

OverriddenHCCCodes__c

PropertiesFilter, Group, Nillable, Sort

DescriptionIndicates which HHC codes are overridden by the value in HCCCode__c.

Typestring

YearSpan__c

PropertiesFilter, Group, Sort

DescriptionCalendar year that this metadata applies to.

RiskScoreDiseaseInteractionMaps risk scores to disease interactions.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typeboolean

ApplyIfDisabled__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates a disabled-disease interaction instead of a disease-disease interaction.

Typedouble

Community__c

773

RiskScoreDiseaseInteractionHealth Cloud Developer Guide

Page 778: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home.

Typedouble

CommunityFBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityFBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by both Medicareand Medicaid, and is enrolled in Medicare because of disability.

Typedouble

CommunityNonDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.

Typedouble

CommunityNonDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.

Typedouble

CommunityPBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

774

RiskScoreDiseaseInteractionHealth Cloud Developer Guide

Page 779: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityPBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.

Typestring

HasConditions__c

PropertiesFilter, Group, Nillable, Sort

DescriptionIndicates that there are conditions or HCC codes that interact with either the disabledstatus or a part of the disease-disease interaction.

Typedouble

Institutional__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.

Typestring

InteractingConditions__c

PropertiesFilter, Group, Nillable, Sort

DescriptionIndicates conditions that interact with the conditions found in HasConditions__c basedon disease-disease interactions.

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether this record is active.

775

RiskScoreDiseaseInteractionHealth Cloud Developer Guide

Page 780: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typestring

YearSpan__c

PropertiesFilter, Group, Sort

DescriptionCalendar year that this metadata applies to.

RiskScoreMedicaidInteractionsMaps risk scores to Medicaid and originally disabled interactions.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typedouble

Community__c1

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home.

Typedouble

CommunityFBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityFBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a full-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.

776

RiskScoreMedicaidInteractionsHealth Cloud Developer Guide

Page 781: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typedouble

CommunityNonDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of age.

Typedouble

CommunityNonDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is covered by Medicare, and is enrolled inMedicare because of disability.

Typedouble

CommunityPBDualAged__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of age.

Typedouble

CommunityPBDualDisabled__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives at home, is a partial-benefit member covered by bothMedicare and Medicaid, and is enrolled in Medicare because of disability.

Typeboolean

Disabled__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionPatient is disabled.

Typepicklist

Gender__c

777

RiskScoreMedicaidInteractionsHealth Cloud Developer Guide

Page 782: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesDefaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

DescriptionThe patient’s gender. Picklist values: Decline to Specify, Female, and Male.

Typedouble

Institutional__c

PropertiesDefaulted on create, Filter, Nillable, Sort

DescriptionIndicates that the patient lives in an institution, such as a skilled nursing facility.

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether this record is active.

Typeboolean

Medicaid__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIs eligible for Medicaid.

Typeboolean

OriginallyDisabled__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionOriginal reason for Medicare entitlement. Picklist values: Age and disabled.

Typestring

YearSpan__c

PropertiesFilter, Group, Sort

DescriptionCalendar year that this metadata applies to.

778

RiskScoreMedicaidInteractionsHealth Cloud Developer Guide

Page 783: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HealthCloudSettingHolds mappings for field sets and other customizable elements in Health Cloud. To change a delivered setting, deactivate the setting,clone it, and make the new setting active.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typeboolean

Active__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the record is active.

Typestring

SettingName__c

PropertiesFilter, Group, Sort

DescriptionName of the configuration setting or value that is mapped.

Typestring

SettingValue__c

PropertiesFilter, Group, Sort

DescriptionConfiguration value for a particular setting.

HL7SettingSpecifies parser support for electronic health record transmissions using the HL7 standard.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

779

HealthCloudSettingHealth Cloud Developer Guide

Page 784: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the record is active.

Typestring

Value__c

PropertiesFilter, Group, Sort

Description??? (Limit 255 characters.)

HL7ParserMappingDetermines which Apex class is used to parse HL7 segments.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typeboolean

IsActive__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the record is active.

Typestring

EntityName__c

PropertiesFilter, Group, Sort

DescriptionName of the configuration setting or value that is mapped. (Limit 255 characters.)

Typestring

ParserName__c

780

HL7ParserMappingHealth Cloud Developer Guide

Page 785: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

PropertiesFilter, Group, Sort

DescriptionName of the selected HL7 parser. (Limit 255 characters.)

Typestring

ReceivingApplication__c

PropertiesFilter, Group, Sort

DescriptionApplication receiving the HL7 data transmission. (Limit 255 characters.)

Typestring

ReceivingFacility__c

PropertiesFilter, Group, Sort

DescriptionOrganization receiving the HL7 data transmission. (Limit 100 characters.)

Typestring

SendingApplication__c

PropertiesFilter, Group, Sort

DescriptionApplication sending the HL7 data transmission. (Limit 255 characters.)

Typestring

SendingFacility__c

PropertiesFilter, Group, Sort

DescriptionOrganization sending the HL7 data transmission. (Limit 255 characters.)

Typestring

Version__c

PropertiesFilter, Group, Sort

DescriptionHL7 version in use. (Limit 255 characters.)

781

HL7ParserMappingHealth Cloud Developer Guide

Page 786: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

HcServiceOrchestrationSettingDetermines order of execution of parser operations.

Note: New custom fields can’t be added to managed custom metadata types.

Supported CallsdescribeLayout(), query(), retrieve()

DetailsField

Typeboolean

Active__c

PropertiesDefaulted on create, Filter, Group, Sort

DescriptionIndicates whether the record is active.

Typestring

ProcessId__c

PropertiesFilter, Group, Sort

Description??? (Limit 255 characters.)

Typeboolean

Required__c

PropertiesFilter, Group, Sort

DescriptionConfiguration value for a particular setting.

Typeint

Step__c

PropertiesFilter, Group, Sort

DescriptionPosition of this operation in the sequence of operations.

Typestring

StepClass__c

PropertiesFilter, Group, Sort

782

HcServiceOrchestrationSettingHealth Cloud Developer Guide

Page 787: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DetailsField

Description??? (Limit 255 characters.)

Health Cloud Empower Components for Communities

EDITIONS

Available in: Enterprise,Performance, andDeveloper Editions

Developers can use the Health Cloud Empower Components in other applications to create a patientor member community.

Create Your Own Health Cloud Empower Components

Use these examples to help you create custom Health Care Empower components.

Care Plan Selector for Health Cloud Empower Component

The Care Plan Selector for Health Cloud Empower component (HcCommunityCarePlanPicker) lets users select a patient or member’scare plan.

Care Team for Health Cloud Empower Component

The Care Team for Health Cloud Empower component (HcCommunityCareTeamList) displays details for members of the care team.

Care Plan Tasks for Health Cloud Empower Component

The Care Plan Tasks for Health Cloud Empower component (HcCommunityTaskList) lets users see tasks associated with a care plan.Members can view only their own tasks, and they can filter the task list to keep track of which tasks are completed.

Timeline for Health Cloud Empower Component

The Timeline for Health Cloud Empower component lets people see their past, current, and future healthcare events.

Create Your Own Health Cloud Empower ComponentsUse these examples to help you create custom Health Care Empower components.

Create a component that works with the care plan selector

You can create a component to display custom objects or information for a care plan or for a patient or member. For example:

• Customer has a custom object - display the related list of records for the care plan

• Display a list of the EHR records for the individual, like medications or visits

• Display the list of care plan problems or goals

• Display a graph of medical device measurements or lab results

• Display details of the care plan

The custom components are used with the Empower care plan selector, so you must handle the HcCommunityEventCarePlanSelectedevent.

For example:

.cmp file

<aura:component implements="forceCommunity:availableForAllPageTypes" access="global">

<!-- attributes here -->

783

Health Cloud Empower Components for CommunitiesHealth Cloud Developer Guide

Page 788: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

<aura:handler event="HcCommunityEventCarePlanSelected" action="{!c.onCarePlanChange}"/>

<!-- display data here -->

</aura:component>

controller.js file

({onCarePlanChange : function(component, event, helper) {

var carePlanId = event.getParam("carePlanId");var patientId = event.getParam("patientId");// do some action here to update the data/layout of the component

}})

Create custom component that replaces the care plan selectorYou can create a substitute component for the care plan selector. For example, the custom component could have a select list thatdisplays different information or behaves differently than the one included in the package. Or you could add a text search box tofind a name or medical record number.

The component must fire the HcCommunityEventCarePlanSelected event trigger.

.cmp file

<aura:component implements="forceCommunity:availableForAllPageTypes" access="global" ><!-- attributes here -->

<aura:registerEvent name="carePlanChange" type="c:HcCommunityEventCarePlanSelected"/>

<!-- display data here --></aura:component>

controller.js file

({onSomeActionInTheComponent : function(component, event, helper) {

var carePlanId = [get from component];// ORvar patientid = [get from component];var carePlanEvent =

$A.get("e.HcCommunityEventCarePlanSelected");carePlanEvent.setParams({

'carePlanId': carePlanId,'patientId': patientId

}).fire();}

})

SEE ALSO:

Admin Guide: Customize Fields in the Health Cloud Empower Lightning Components

784

Create Your Own Health Cloud Empower ComponentsHealth Cloud Developer Guide

Page 789: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Care Plan Selector for Health Cloud Empower ComponentThe Care Plan Selector for Health Cloud Empower component (HcCommunityCarePlanPicker) lets users select a patient or member’scare plan.

If the user has access to only one care plan, the plan is selected automatically. When a user is a member of multiple care teams, thepicklist shows all the user’s plans. If the user doesn’t belong to any care team, the picklist doesn’t appear. Only users who are membersof the care team or the owner of the care plan can see the plan.

Includes only case record types that are in the Care Plan Record Type custom metadata records.

Note: In the tables, the labels listed reflect the field in the Experience Builder and the Lightning App Builder. Attributes that donot have a label use a default, unless set by a custom use of the component.

Table 3: Care Plan Selector Component Attributes

DescriptionTypeField LabelAttribute

List of care plan IDs and descriptions. If no value isset, the attribute is populated with values based on

map[]carePlans

other selections and the list obtained from a SOQLquery.

Enter the text to display in the picklist beforeanything is selected. The default is Select a

stringPlaceholder text for picklistpicklistDefaultOptionText

name and care plan... Placeholder textcan’t be translated using the Translation Workbench.

Add the person's birthdate to the picklist in additionto their name and the care plan name. Default isfalse.

booleanShow birthdateshowBirthDate

Include year of birth. Default is true.booleanInclude birth yearincludeYearOfBirth

Show the person's birth month as text, such as Janor Feb. Default is true.

booleanShow birth month as textuseMonthText

Add an item to a picklist to show details for all careplans at once when the user has multiple care plans.

booleanShow all care plansincludeAllCarePlanOption

ALL CARE PLANS is shown as the name of thecare plan. Default is true.

Table 4: Care Plan Selector Component Events Handled

DescriptionName (Type)

When a user navigates within the community, the navigationchange is captured. The care plan selector fires the

forceCommunity:routeChange (Application)

eventCarePlanSelected event to keep all components in sync withthe currently selected option.

785

Care Plan Selector for Health Cloud Empower ComponentHealth Cloud Developer Guide

Page 790: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Table 5: Care Plan Selector Component Events Fired

DescriptionAttributes (Type)Name (Type)

Fire this event when an option is selected or changed sothat dependent components are kept in sync.

HcCommunity:EventCarePlanSelected(Application)

• carePlanId (string)

• patientId (string)

Usage

This component registers and fires on an event called HcCommunityEventCarePlanSelected.

If you build a component that responds to the user selection at runtime, include an event handler for theHcCommunityEventCarePlanSelected event.

The Health Cloud package provides two Lightning components, Care Team List and Care Plan Picker, that handle this event.

SEE ALSO:

Admin Guide: Care Plan Selector for Health Cloud Empower

Care Team for Health Cloud Empower ComponentThe Care Team for Health Cloud Empower component (HcCommunityCareTeamList) displays details for members of the care team.

HcCommunityPatientCard controls the fields and the order in which they appear for the patient or member in the community.HcCommunityTeamMembers controls which fields appear for the rest of the team members in the community and their order.

Table 6: Care Team Component Attributes

DescriptionTypeField LabelAttribute

ID of the care plan or case for a given care team.stringcarePlanId

Account ID of the person for whom to show care planmembers. Setting patientId shows all care plans for

stringpatientId

that person. Setting carePlanId shows only the detailsfor the referenced care plan. If both are set, carePlanIdis used.

Name of the field set on the User object. Retrievesthe fields to display for the patient or member. Default

stringPatient Field Set NamepatientFieldSet

is HcPatientInfoFields (which is part of theHealth Cloud managed package).

Name of the field set that contains the fields to displayfor the team members. Default is

stringTeam Member Field Set NameteamMemberFieldSet

HcTeamMemberInfoFields (which is part ofthe Health Cloud managed package).

Boolean attribute to toggle label visibility. Default istrue.

booleanShow labelsshowLabels

Toggle to show the care plan owner in the list of careteam members. Default is false.

booleanInclude owner in listincludeOwner

786

Care Team for Health Cloud Empower ComponentHealth Cloud Developer Guide

Page 791: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DescriptionTypeField LabelAttribute

Label text for the name of the care plan owner's role.For example, if a nurse practitioner creates and owns

stringCare Plan Owner Role NamecarePlanOwnerRoleLabel

the care plan, you can show Nurse Practitioner as therole instead of the default.

Table 7: Care Team Component Events Handled

DescriptionAttributes (Type)Name (Type)

Event that is fired when a care plan option is selectedin the Health Cloud Care Plan Picker component.

HcCommunityEventCarePlanSelected(Application)

• carePlanId (string)

• patientId (string)

Use Alongside Another Component

This component has an event handler for HcCommunityEventCarePlanSelected event.

Your custom component must fire the HcCommunityEventCarePlanSelected event that this component handles. The value passedin the event is CaseId (type string). The Health Cloud package provides the Care Plan Selector component, which registers and firesthe HcCommunityEventCarePlanSelected event with CaseId.

Use as a Child or Nested Component

This component requires carePlanId (type string) (or accountId or patientId) as input from its parent component. The value ofcarePlanId must be a valid CaseId value.

Use in a Case Record or Account Page

You can use this component in a Lightning record page for the Case and Account object. The Case or Account record page fires theAura attribute force:hasRecordId that this component handle.

SEE ALSO:

Admin Guide: Care Team for Health Cloud Empower

Care Plan Tasks for Health Cloud Empower ComponentThe Care Plan Tasks for Health Cloud Empower component (HcCommunityTaskList) lets users see tasks associated with a care plan.Members can view only their own tasks, and they can filter the task list to keep track of which tasks are completed.

Table 8: Care Plan Tasks Component Attributes

DescriptionTypeField LabelAttribute

ID of the care plan or case for a given care team.stringcarePlanId

The account ID of the person for whom list of careplan tasks need to be shown. Setting the patientId

stringpatientId

shows all tasks for the individual (when they havemultiple). Setting the carePlanId only shows thedetails for the referenced care plan. If both are set

787

Care Plan Tasks for Health Cloud Empower ComponentHealth Cloud Developer Guide

Page 792: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

DescriptionTypeField LabelAttribute

we prioritize carePlanId and show only one list ofcare plan tasks.

Name of the field set that contains the fields youwant to display for tasks. The default is

stringField Set NametaskFieldSet

HcCarePlanTaskFields (which is part of the HealthCloud managed package).

Boolean attribute to toggle visibility of the labelsthat appear in the task list. Default: true

booleanShow labelsshowLabels

Toggle visibility of all tasks. (Currently unavailableand has no effect.) Default:true

booleanShow all tasksshowAll

Table 9: Care Plan Tasks Component Events Handled

DescriptionAttributes (Type)Name (Type)

Event that is fired when a care plan option is selectedin the Health Cloud Care Plan Picker component.

HcCommunityEventCarePlanSelected(Application)

• carePlanId (string)

• patientId (string)

Event used to update the status of a task when it ischecked.

HcCommunityGlobalEvent • taskId (string)

• selected (boolean)

Use Alongside Another Component

This component has an event handler for HcCommunityEventCarePlanSelected event.

Your custom component must fire the HcCommunityEventCarePlanSelected event that this component handles. The value passedin the event is CaseId (type string). The Health Cloud package provides the Care Plan Selector component, which registers and firesthe HcCommunityEventCarePlanSelected event with CaseId.

Use as a Child or Nested Component

This component requires carePlanId (type string) (or accountId or patientId) as input from its parent component. The value ofcarePlanId must be a valid CaseId value.

Use in a Case Record or Account Page

You can use this component in a Lightning record page for the Case and Account object. The Case or Account record page fires theAura attribute force:hasRecordId that this component handle.

SEE ALSO:

Admin Guide: Care Plan Tasks for Health Cloud Empower

Timeline for Health Cloud Empower ComponentThe Timeline for Health Cloud Empower component lets people see their past, current, and future healthcare events.

788

Timeline for Health Cloud Empower ComponentHealth Cloud Developer Guide

Page 793: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

The HcCommunityTimeline component displays lists of events for a care plan as configured in the Timeline configuration records. Theevents are shown on three tabs: Today (always shown); Past (can be excluded); and Future (can be excluded). This component is similarto the care team and tasks list in that it handles the plan selected event.

Note: In the following tables, Label refers to the label for the field in the Community Builder and the Lightning App Builder.Attributes that do not have a label use a default unless set by a custom use of the component.

Table 10: HcCommunityTimeline Component Attributes

DescriptionTypeLabelName

ID of the care plan or case for a given care team.stringcarePlanId

Account ID of the person for whom to showcare plan members. Setting patientId shows all

stringpatientId

care plans for that person. Setting carePlanIdshows only the details for the referenced careplan. If both are set, carePlanId is used.

Flag indicates if the Past tab is included todisplay past timeline activity. Default is true.

booleanShow past eventsshowPastActivity

Flag indicates if the Future tab is included todisplay future timeline activity. Default is true.

booleanShow future eventsshowFutureActivity

Number of activities to be loaded when a careplan is selected, Show More button is clicked,or when filters are changed.

doublePage Reload SizepageReloadSize

Default: Select a care plan to view timeline events.stringText instructing usersto select a care plan toview timeline events.

picklistDefaultOptionTextForTimeline

Table 11: HcCommunityTImeline Component Events Handled

DescriptionAttributes (Type)Name (Type)

Event that is fired when a care plan option is selectedin the Health Cloud Care Plan Picker component.

HcCommunityEventCarePlanSelected(Application)

• carePlanId (string)

• patientId (string)

Use Alongside Another Component

This component has an event handler for HcCommunityEventCarePlanSelected event.

Your custom component must fire HcCommunityEventCarePlanSelected event that this component handles. The value passed inthe event is CaseId (type String). Health Cloud package provides a component, Care Plan Selector, that registers and firesHcCommunityEventCarePlanSelected event with CaseId.

Use as a Child or Nested Component

This component would require carePlanId (type String) as input from its parent component. The value of the carePlanId must be avalid CaseId value.

789

Timeline for Health Cloud Empower ComponentHealth Cloud Developer Guide

Page 794: Salesforce Health Cloud Developer Guide › assets › pdfs › health_cloud_dev... · 2020-06-18 · Salesforce Health Cloud provides a rich set of standard and custom objects to

Use in a Case Record Page

This component can be used in Lightning Record Page for Case object. The Case Record Page sets the recordId attribute to the caseId since it implements the force:hasRecordId interface.

SEE ALSO:

Admin Guide: Timeline for Health Cloud Empower

790

Timeline for Health Cloud Empower ComponentHealth Cloud Developer Guide


Recommended