Health Cloud Dev Guide
DOWNLOAD
First things first !
To download this implementation guide, click the download button below.
If you need more information about the implementation guide, you can read the Table of Contents below.
Salesforce Health Cloud
Developer Guide
Salesforce Spring
salesforcedocs
Last updated February
Copyright salesforcecom inc All rights reserved Salesforce is a registered trademark of salesforcecom inc
as are other names and marks Other marks appearing herein may be trademarks of their respective owners
CONTENTS
Health Cloud Developer Guide
Health Cloud Objects
Health Cloud Custom Fields on Standard Objects
Working With Electronic Health Records
Health Cloud Custom Metadata Types
Health Cloud Business API
Health Cloud Empower Components for Communities
HEALTH CLOUD DEVELOPER GUIDE
This guide provides information on the custom objects used by Health Cloud and their fields Some
fields 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 access
specialized health information
Health Cloud Custom Fields on Standard Objects
Health Cloud adds custom fields to some standard Salesforce objects to represent information
about individuals
EDITIONS
Health Cloud is available in
Salesforce Classic and
Lightning Experience
Available in Enterprise
Performance and
Unlimited Editions
Working With Electronic Health Records
HL Health Level Seven is a standard for exchanging electronic health records EHR You can parse EHR data transmitted via HL
data messages and store it in the Salesforce Health Cloud data model You can create parsers or use parsers supplied by Health
Cloud
Health Cloud Custom Metadata Types
Custom metadata is customizable deployable packageable and upgradeable application metadata
Health Cloud Business API
Use this single Apex API to create a patient record rather than making separate calls to the Account and Contact objects The Person
Account object and the Individual record type for Account and Contact objects are both supported
Health Cloud Empower Components for Communities
Developers can use the Health Cloud Empower Components in other applications to create a patient 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 version
behind the core Salesforce API Health Cloud standard objects have the same API version as core Salesforce For example if your
orgs API version is the custom objects in the Health Cloud managed package are API version and the standard Health Cloud
objects are API version
Care Management
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 with Salesforce using several standard APIs to map messages from EHR systems
into Health Cloud objects and fields
Claims
A claim is information submitted to an individuals health insurance company by an entity providing a service medication or device
Health Cloud Developer Guide
Care Management
Code Sets
The code sets data model represents industrystandard procedure and diagnosis codes available to use in priorauthorization request
and 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 participants
such as employment insurance coverage and dependents You can manage details of the benefits provided by plans to members
and treatment preauthorization requests made by members or providers
Social Determinants
The social determinants data model represents the barriers health determinants and interventions for a patient or member Available
in API version and later
Utilization Management
Utilization Management UM is a health insurance plans process of interfacing with plan members and contracted medical providers
to interpret administer and explain the medical policies of the health 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
right 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
Care Management
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 with
Salesforce using several standard APIs to map messages from EHR systems into Health Cloud objects
and fields
The Health Cloud clinical data model is similar to the FHIR standard This supports easier and more
straightforward clinical data integration from other source systems When devising an
implementation strategy you or your integration partner map messages from the EHR system to
the correct Health Cloud object Data is replicated into the clinical data model with readonly access
Data that originates in the EHR or other clinical systems is viewonly so the source system remains
the system of record
EDITIONS
Health Cloud is available in
Salesforce Classic and
Lightning Experience
Available in Enterprise
Performance and
Unlimited Editions
CarePlanTemplatec
Represents the template used to create a care plan including the problems goals and tasks that care coordinators use to manage and
mitigate a medical condition
Supported Calls
create delete describeLayout getDeleted getUpdated query retrieve undelete
update upsert
Health Cloud Developer Guide
Care Management
Fields
Field
Details
Activec
Type
boolean
Properties
Create Defaulted on create Filter Group Sort Update
Description
Indicates whether the record is active or not
ClonedFromc
Type
reference
Properties
Create Filter Nillable Group Sort Update
Description
Indicates where this template was cloned or copied from
Descriptionc
Type
textarea
Properties
Create Filter Group Nillable Sort Update
Description
A description of the template
Usage
Use this object to manage patient care templates
CarePlanTemplateGoalc
Represents a goal included in the care plan template
Supported Calls
create delete describeLayout getDeleted getUpdated query retrieve undelete
update upsert
Fields
Field
Details
Activec
Type
boolean
Health Cloud Developer Guide
Field
Care Management
Details
Properties
Create Defaulted on create Filter Group Sort Update
Description
Indicates whether the record is active or not
Descriptionc
Type
textarea
Properties
Create Filter Group Nillable Sort Update
Description
A description of the goal associated with the problem
Name
Type
string
Properties
Create Defaulted on create Filter Group idLookup Nillable Sort Update
Description
The name of the care plan goal Limit characters
OwnerId
Type
reference
Properties
Defaulted on create Filter Group Sort Update
Description
ID of the owner of the goal
Priorityc
Type
picklist
Properties
Create Filter Group Nillable Sort Restricted picklist Update
Description
The priority of the care plan goal such as low normal or high
SortOrderc
Type
picklistdouble
Properties
Create Filter Group Nillable Sort Update
Description
Indicates the sort order of goals in the list
TemplateProblemc
Type
reference
Health Cloud Developer Guide
Field
Care Management
Details
Properties
Create Filter Group Nillable Sort Update
Description
Name of the problem this goal is related to
Usage
Use this object to query and manage goals that are related to problems within a care plan template
CarePlanTemplateProblemc
Represents a problem included in the care plan template
Supported Calls
create delete describeLayout getDeleted getUpdated query retrieve undelete
update upsert
Fields
Field
Details
Activec
Type
boolean
Properties
Create Defaulted on create Filter Group Sort Update
Description
Indicates whether the record is active or not
CarePlanTemplatec
Type
reference
Properties
Create FilterGroup Nillable Sort Update
Description
The care plan template that the problem is related to
Descriptionc
Type
textarea
Properties
Create Filter Group Nillable Sort Update
Description
A description of the problem associated with the template
Health Cloud Developer Guide
Care Management
Field
Details
Name
Type
string
Properties
Create Defaulted on create Filter Group idLookup Nillable Sort Update
Description
The name of the care plan problem Limit characters
OwnerId
Type
reference
Properties
Defaulted on create Filter Group Sort Update
Description
ID of the owner of the problem
Priorityc
Type
picklist
Properties
Create Filter Group Nillable Sort Restricted picklist Update
Description
The priority of the care plan problem such as low normal or high
SortOrderc
Type
double
Properties
Create Filter Group Nillable Sort Update
Description
Indicates the sort order of problems in the list
Usage
Use this object to query and manage problems associated with a care plan template
CarePlanTemplateTaskc
Represents a task thats included in the care plan template
Supported Calls
create delete describeLayout getDeleted getUpdated query retrieve undelete
update upsert
Health Cloud Developer Guide
Care Management
Fields
Field
Details
Activec
Type
boolean
Properties
Create Defaulted on create Filter Group Sort Update
Description
Indicates whether the record is active or not
AssignedToc
Type
picklist
Properties
Create Filter Group NillableRestricted picklist Sort Update
Description
Name of the person whos assigned to the task
CarePlanTemplateGoalc Type
reference
Properties
Create Filter Group Nillable Sort Update
Description
Name of the goal associated with the task
Descriptionc
Type
textarea
Properties
Create Filter Group Nillable Sort Update
Description
A description of the task
Name
Type
string
Properties
Create Defaulted on create Filter Group idLookup Nillable Sort Update
Description
The name of the care plan problem Limit characters
Offsetc
Type
double
Properties
Create Filter Nillable Sort Update
Health Cloud Developer Guide
Field
Care Management
Details
Description
Adds an offsetDate to the date selected for a task in the care plan Tasks that have an offset
date add the assigned offset to the task start date For example if the care plan start date is
December and a task offset is days the tasks due date is December
Priorityc
Type
picklist
Properties
Create Filter Group Nillable Sort Restricted picklist Update
Description
The priority of the care plan task such as low normal or high
SortOrderc
Type
double
Properties
Create Filter Group Nillable Sort Update
Description
Indicates the sort order of tasks in the list
Statusc
Type
picklist
Properties
Create Filter Group Nillable Restricted picklist Sort Update
Description
The status of the care plan task such as in progress complete or new
Subjectc
Type
string
Properties
Create Filter Group Nillable Sort Update
Description
The subject or name of the task
Typec
Type
picklist
Properties
Create Filter Group Nillable Sort Update
Description
The type of task
Health Cloud Developer Guide
Care Management
Usage
Use this object to query and manage tasks associated with a care plan template
AccountAccountRelationc
Represents a onetoone relationship between two accounts each with a distinct role in relation to the other
Supported Calls
create delete describeLayout describeSObjects getDeleted getUpdated query
retrieve search undelete update upsert
Fields
Field
Details
Accountc
Type
reference
Properties
Create Filter Group Nillable Sort Update
Description
Account that RelatedAccountc is related from
Activec
Type
boolean
Properties
Create Defaulted on create Filter Group Sort Update
Description
Indicates whether the relationship between accounts is active true or not false The
default checkbox value is selected
EndDatec
Type
date
Properties
Create Filter Group Nillable Sort Update
Description
The last date when the two accounts are related
ExternalIdc
Type
string
Properties
Create Filter Group idLookup Nillable Sort Update
Health Cloud Developer Guide
Field
Care Management
Details
Description
An external ID that inhibits any duplicate definitions from FromAccount Role ToAccount
Name
Type
string
Properties
Create Defaulted on create Filter Group idLookup Nillable Sort Update
Description
The name of the relationship between the accounts Limit characters
OwnerId
Type
reference
Properties
Create Defaulted on create Filter Group Sort Update
Description
ID of the user who created the relationship record
RelatedAccountc
Type
reference
Properties
Filter Group Nillable Sort
Description
Account that Accountc is related to
Rolec
Type
reference
Properties
Create Filter Group Sort Update
Description
The role of the relationship
StartDatec
Type
date
Properties
Create Filter Group Nillable Sort Update
Description
The first date when the relationship between accounts is valid not when the object is
created
Health Cloud Developer Guide
Care Management
Usage
This resource tracks each accounts relationship to the other
CandidatePatientc
Represents the demographics and other administrative information about a patient whos receiving healthrelated services
Supported Calls
create delete describeLayout describeSObjects getDeleted getUpdated query
retrieve search undelete update upsert
Fields
Field
Details
AddressCityc
Type
string
Properties
Create Filter Group Nillable Sort Update
Description
The city in an address for the patient
AddressCountryc
Type
string
Properties
Create Filter Group Nillable Sort Update
Description
The country in an address for the patient
AddressEndDatec
Type
dateTime
Properties
Create Filter Nillable Sort Update
Description
The last date when an address for the patient is valid
AddressLinec
Type
string
Properties
Create Filter Group Nillable Sort Update
Description
The first line of a street address for the patient