Salesforce Health Cloud Developer Guide

Salesforce Health CloudDeveloper Guide

Salesforce, Summer ’22

@salesforcedocsLast updated: May 12, 2022

https://twitter.com/salesforcedocs

© Copyright 2000–2022 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.

CONTENTS

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

Health Cloud Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Health Cloud Associated Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185Health Cloud Fields on Standard Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211HealthCloudExt Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245Creating and Importing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283Intelligent Appointment Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284Working With Electronic Health Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1296Emergency Response Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417Health Cloud Business APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446Metadata Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1676Health Cloud Custom Metadata Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1690Health Cloud Empower Components for Experience Cloud Sites . . . . . . . . . . . . . . . . . . . . 1710API End-of-Life . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1717

HEALTH CLOUD DEVELOPER GUIDE

EDITIONS

Available in: LightningExperience

Available in: Enterprise andUnlimited Editions withHealth Cloud

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 Data Model

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

Health Cloud Fields on Standard Objects

Health Cloud adds standard and custom fields to some standard Salesforce objects to representinformation about individuals.

HealthCloudExt Namespace

The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic healthrecords (EHR) system.

Creating and Importing Documents

You can integrate a fax system with Health Cloud's Intelligent Document Automation features by creating and importing documentsprogrammatically.

Intelligent Appointment Management

Health Cloud integrates with a customer’s appointment management system to provide a patient appointment booking experiencein Salesforce for call center agents and care coordinators. The Health Cloud data model for appointments enables you to work withmultiple source systems operating on different EHR platforms.

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.

Emergency Response Management

Use the objects, fields, and metadata that extend Salesforce for Emergency Response Management.

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.

Metadata Types

Health Cloud Custom Metadata Types

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

Health Cloud Empower Components for Experience Cloud Sites

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

API End-of-Life

Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to matureand improve the quality and performance of the API, versions that are more than three years old might cease to be supported.

1

Health Cloud Data Model

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.

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.

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.

Clinical Data Model

The Clinical Data Model enhances Health Cloud to make it more interoperable. Developed to be aligned with FHIR v4.0, this datamodel is built almost entirely on core. The Clinical Data Model is meant to be the successor to the older packaged EHR Data Model.

Code Sets for Diagnosis and Procedure

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.

Electronic Health Records

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

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.


Health Cloud integrates with a customer’s appointment management system to provide a patient appointment booking experiencein Salesforce for call center agents and care coordinators. The Health Cloud data model for appointments enables you to work withmultiple source systems operating on different electronic health record platforms.

Home Health Care

Use the Home Health Care data objects to manage information about patient intake, assignment and care in home healthenvironments.

Intelligent Sales

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

2

Health Cloud Data ModelHealth Cloud Developer Guide

Medication Management

The Medication Management data model provides objects to enable providers and care coordinators to perform a comprehensivemedication reconciliation of their patients’ medication regimen whenever there’s a transition of care. The data model providesobjects for managing information on medication reconciliations and medication recommendations added for patients.

Provider Network Management

Provider Network Management allows health insurance companies to bring providers into their network. It provides objects formanaging provider application and credentialing data, so you can easily enroll providers into your network and help your membersor patients find care that fits their needs.

Remote Monitoring and Device Registration

The remote monitoring and device registration data model provides objects for managing data collected from devices issued topatients or program members, such as smart watches and heart monitors.

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.

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.

Benefits Verification Data Model

The benefits verification data model supports providers, payers, and life sciences organizations in determining benefits coverage forservices and products provided.

Identity Verification Data Model

The Identity Verification data model is used in configuring the process to verify the identity of a caller before their requests areprocessed by a call center agent.

TimelineObjectDefinition

Stores timeline configurations. This object is available in API version 55.0 and later.

SEE ALSO:

Salesforce Object Reference

Salesforce Developer Limits and Allocations Quick Reference

Care Management

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

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/

https://developer.salesforce.com/docs/atlas.en-us.238.0.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm

4


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


DetailsField

DescriptionA description of the template.

UsageUse this object to manage patient care templates.

CarePlanTemplateGoal__cRepresents a goal included in the care plan template.


Fields

DetailsField

Typeboolean

Active__c



Typereference

CarePlanTemplate__c

PropertiesCreate, Filter,Group, Nillable, Sort, Update

DescriptionThe care plan template that the goal is related to.

Typereference

CarePlanTemplateProblem___c


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

Typepicklist

Category__c

6


DetailsField


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

• Cognition Improvement

• Muscle Strength Improvement

• Weight Management

Typetextarea

Description__c


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


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

Typepicklistdouble

SortOrder___c


7


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.


Fields

DetailsField

Typeboolean

Active__c



Typereference

CarePlanTemplate__c


DescriptionThe care plan template that the problem is related to.

Typepicklist

Category__c


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

• Cognition

• Pain Monitoring or Management

8


DetailsField

• Respiratory Impairment

Typetextarea

Description__c


DescriptionA description of the problem associated with the template.

Typestring

Name


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


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

Typedouble

SortOrder___c


DescriptionIndicates the sort order of problems in the list.

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

9


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


Fields

DetailsField

Typeboolean

Active__c



Typepicklist

AssignedTo__c

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

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

Typereference

CarePlanTemplate__c


DescriptionThe care plan template that the task is related to.

Typereference

CarePlanTemplateGoal__c


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

Typereference

CarePlanTemplateProblem___c


10


DetailsField

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

Typetextarea

Description__c


DescriptionA description of the task.

Typestring

Name



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


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

Typedouble

SortOrder___c


DescriptionIndicates the sort order of tasks in the list.

Typepicklist

Status___c

11


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


DescriptionThe subject or name of the task.

Typepicklist

Type__c


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


DescriptionAccount that RelatedAccount__c is related from.

12


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


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


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

Typereference

OwnerId


DescriptionID of the user who created the relationship record.

Typereference

RelatedAccount__c

PropertiesFilter, Group, Nillable, Sort

13


DetailsField

DescriptionAccount that Account__c is related to.

Typereference

Role__c

PropertiesCreate, Filter, Group, Sort, Update

DescriptionThe role of the relationship.

Typedate

StartDate__c


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.

Note: Starting Sprint ‘22, the Candidate Patient object is no longer supported. Use the Lead object for patient conversion.

Note: As the Candidate Patient custom object is being retired, use the Lead object instead of the Candidate Patient object. If youneed a Candidate Patient field that Lead doesn't support, create the fields.

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

Fields

DetailsField

Typestring

Address1City__c


14


DetailsField

DescriptionThe city in an address for the patient.

Typestring

Address1Country__c


DescriptionThe country in an address for the patient.

TypedateTime

Address1EndDate__c


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

Typestring

Address1Line1__c


DescriptionThe first line of a street address for the patient.

Typestring

Address1Line2__c


DescriptionThe second line of a street address for the patient.

Typestring

Address1PostalCode__c


DescriptionThe postal code of an address for the patient.

TypedateTime

Address1StartDate__c


15


DetailsField

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

Typestring

Address1State__c


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


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

Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c


16


DetailsField


Typestring

Address2Line1__c



Typestring

Address2Line2__c



Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c


17


DetailsField


Typestring

Address2Use__c



Typestring

Address3City__c



Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c


18


DetailsField


Typestring




TypedateTime




Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c


19


DetailsField


Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



Typestring

Address4Line2__c



Typestring




TypedateTime



20


DetailsField

DescriptionThe first date when an address for the patient is valid

Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c


21


DetailsField


Typestring

Address5Line1__c



Typestring

Address5Line2__c



Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c


22


DetailsField


Typestring

Address5Use__c



TypedateTime

BirthDate__c


DescriptionThe patient’s birth date.

Typestring

Communication1Code__c


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

Typestring

Communication1Label__c


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

Typestring

Communication1System__c


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

23


DetailsField

Typestring




Typestring




Typestring




Typestring




Typestring




Typestring


24


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



25


DetailsField


Typestring




Typeboolean

Deceased__c


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

Typestring

FamilyName1__c


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

Typestring

FamilyName2__c


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

Typestring

FamilyName3__c


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

26


DetailsField

Typestring

GenderCode__c


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

Typestring

GenderLabel__c


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

Typestring

GenderSystem__c


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

Typestring

GivenName1__c


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

Typestring

GivenName2__c


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

Typestring

GivenName3__c

27


DetailsField


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

Typestring

GivenName4__c


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

Typestring

GivenName5__c


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

Typedate

LastActivityDate


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


28


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


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

Typestring

MaritalStatusLabel__c


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

Typestring

MaritalStatusSystem__c


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

Typestring

MedicalRecordNumber__c


DescriptionThe medical record number used to identify a patient.

Typeboolean

MultipleBirth__c


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

Typestring

Name

29


DetailsField

PropertiesAutonumber, Defaulted on create, Filter, idLookup, Sort

DescriptionThe EHR ADT patient ID. Limit: 255 characters.

Typetextarea

Name__c


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

Typestring

Organization255__c


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


DescriptionThe long text description of the organization:

• On behalf of which a patient contact is acting

• For which the patient contact is working

• That’s acting as the custodian of the patient record

Typereference

OwnerId


DescriptionID of the record owner.

Typetextarea

PhotoUrl__c


30


DetailsField

DescriptionThe URL for a photograph of the patient.

Typestring

PrefixName1__c


DescriptionThe first prefix in a patient’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in a patient’s name.

Typestring

PrefixName3__c


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


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

TypedateTime

SourceSystemModified__c


31


DetailsField

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

Typestring

SuffixName1__c


DescriptionThe first suffix in a patient’s name.

Typestring

SuffixName2__c


DescriptionThe second prefix in a patient’s name.

Typestring

SuffixName3__c


DescriptionThe third prefix in a patient’s name.

TypedateTime

Telecom1PeriodEndDate__c


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

TypedateTime

Telecom1PeriodStartDate__c


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

Typestring

Telecom1System__c

32


DetailsField


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

Typestring

Telecom1Use__c


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

Typestring

Telecom1Value__c


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

TypedateTime




TypedateTime




Typestring

Telecom2System__c


33


DetailsField


Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



TypedateTime




TypedateTime




Typestring

Telecom3System__c



34


DetailsField

Typestring

Telecom3Use__c



Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c

35


DetailsField



Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c


36


DetailsField


Typestring

Telecom5Value__c



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.


Fields

DetailsField

Typestring

Category__c


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


DescriptionDescibes the menu navigation item.

Typestring

ParamString__c

37


DetailsField


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

Typestring

Rec_Open_Type__c


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


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

Typestring

Type__c


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

Typestring

URL__c


DescriptionThe URL to access the page.

CarePlanGoal__cRepresents the intended objectives of carrying out a care plan.

38


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 time period.Can be limited to care for a specific condition or set of conditions.

Typereference

CarePlanProblem__c


DescriptionThe health problem that this goal addresses.

Typetextarea

Description__c


DescriptionA long text description of the care plan.

Typedate

LastActivityDate





TypedateTime

LastReferencedDate


39


DetailsField


TypedateTime

LastViewedDate



Typestring

Name


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

Typestring

PercentBar___c


DescriptionPercent completed.

Typepicklist

Priority___c


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

Typepercent

Progress___c


DescriptionProgress toward achieving the care plan goal.

Typedouble

SortOrder___c

40


DetailsField


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

Typepicklist

Category__c


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.


Fields

DetailsField

Typereference

CarePlanTemplate__c


DescriptionThe care plan template associated with the problem.

41


DetailsField

Typereference

CarePlan__c


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


DescriptionA description of the care plan problem.

Typedate

LastActivityDate



• 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



TypedateTime

LastViewedDate



Typestring

Name

42


DetailsField



Typepicklist

Priority___c


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

Typedouble

SortOrder___c


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

Typepicklist

Category__c


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.

43


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

Fields

DetailsField

Typeboolean

Active__c


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

Typestring

ConditionCode__c


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

Typestring

HCCCode__c


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


DescriptionThe last year in which the HCC codes are valid.

44


DetailsField

Typestring

YearConditionCodeHCCCode__c

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

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.


Fields

DetailsField

Typeboolean

Active__c


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

Typereference

Contact__c


DescriptionContact that RelatedContact__c is related from.

Typedate

EndDate__c

45


DetailsField


DescriptionThe last date when the relationship between contacts is valid.

Typestring

ExternalId__c


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

Typestring

Name


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

Typereference

OwnerId


DescriptionThe ID of the user who owns this record.

Typereference

RelatedContact__c


DescriptionContact that RelatedContact__c is related to.

Typereference

Role__c


DescriptionRole that describes how RelatedContact__c is related to Contact__c

46


DetailsField

Typedate

StartDate__c


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.


Fields

DetailsField

Typestring

FromObject__c


DescriptionThe related from object.

TypedateTime

LastReferencedDate


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

TypedateTime

LastViewedDate

47


DetailsField



Typestring

Name


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

Typereference

OwnerId


DescriptionThe owner of the record.

Typestring

Relationship__c


DescriptionThe relationship between the objects.

Typestring

ReverseRelationship__c


DescriptionThe reverse relationship between the objects.

Typestring

ToObject__c


DescriptionThe related to object.

48


CustomFieldSets__cRepresents a custom grouping of fields.

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

Fields

DetailsField

Typetextarea

ExcludedFields__c


DescriptionFields that aren’t included in the field set.

Typestring

FieldSetLabel__c


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


DescriptionThe name of the sObject. Limit: 255 characters.

Typeboolean

TwoColumnLayout


49


DetailsField

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

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


DescriptionName of the new label.

Typestring

ObjectFieldName__c


DescriptionThe name of the object field.

Typestring

ObjectName__c


50


DetailsField

DescriptionThe name of the object.

Typestring

ObjectRecordType__c


DescriptionThe object record type.

Typestring

RelationshipName__c


DescriptionThe name of the relationship.

Typestring

ViewName__c


DescriptionThe name of the view.

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


Fields

DetailsField

Typestring

FieldApi__c


51


DetailsField

DescriptionThe selected field.

Typestring

FieldLabel__c


DescriptionLabel of the selected field.

Typereference

FilterCriterion__c


DescriptionThe field criterion.

Typestring

Name


DescriptionThe filter column name. Limit: 255 characters.

Typetextarea

ObjectName__c


DescriptionA long text description of the name of the object.

Typedouble

Order__c


DescriptionOrder in which the field appears.

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

52



Fields

DetailsField

Typestring

FieldName__c


DescriptionThe name of the field.

Typereference

FieldCriterion__c


DescriptionThe field criterion.

Typestring

Name


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

Typetextarea

ObjectName__c



Typestring

Operator__c


DescriptionThe filter criteria operator.

53


DetailsField

Typedouble

RowNumber__c


DescriptionNumber of rows.

Typestring

SRowNumber__c


DescriptionThe number of rows to display.

Typestring

Type__c


DescriptionThe type of filter condition.

Typestring

Value__c


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()

54


Fields

DetailsField

Typetextarea

Grouping__c


DescriptionGrouping of the filter items.

Typeboolean

IsWaveList__c


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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


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

Typetextarea

ObjectName__c


55


DetailsField


Typereference

OwnerId


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


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

Typestring

FriendlyName__c


DescriptionName that appears as a title on the patient card.

Typeboolean

IsActive__c


DescriptionIndicates whether this field is appears on the patient card.

56


DetailsField

Typeboolean

IsAscending__c


DescriptionIndicates whether results appear in ascending order.

Typestring

LanguageCode__c


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


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

Typestring

ObjectName__c


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


57


DetailsField

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

Typestring

PatientAccountLookup__c


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


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

Typedouble

SortOrder__c


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.

PersonLifeEventRepresents the life events of an individual, such as marriage, birth of a child, birthday, engagement.

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

58


Fields

DetailsField

TypedateTime

EventDate


DescriptionThe date on which the life event occurred.

Typetextarea

EventDescription


DescriptionThe description of the life event.

Typereference

EventLocation


DescriptionThe location where the life event occurred.

This is a compound field of type Address and combines these fields: EventLocationCity,EventLocationCountry, EventLocationGeocodeAccuracy, EventLocationLatitude,EventLocationLongitude, EventLocationPostalCode, EventLocationState, andEventLocationStreet. For more information, see Address Compound Fields.

Typepicklist

EventType


DescriptionThe type of the life event. For example, birth, graduation, job, marriage, relocation, car, home,baby, retirement.

TypedateTime

ExpirationDate


DescriptionThe the date when a life event expired.

59


https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/compound_fields_address.htm

DetailsField

Typetextarea

ExpirationDescription


DescriptionDescribes why the event expired.

Typeboolean

IsExpired


DescriptionIndicates whether a life event has expired. The default value is False.

Typeboolean

IsTentative


DescriptionIndicates that the exact date of the event is not known. The default value is False.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


60


DetailsField

DescriptionThe name of the life event.

Typereference

OwnerId


DescriptionThe ID of the record owner.

Typereference

PrimaryPersonId


DescriptionID of the person to whom the life event is related. This field cannot be updated using API.

Typereference

RelatedPersonId


DescriptionThe person related to the primary person in a life event involving two people, such asmarriage.

Typestring

SourceSystem


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

Typestring

SourceSystemIdentifier


DescriptionThe ID of this record in the source system.

61


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


Fields

DetailsField

Typeboolean

CreateInverseRole__c


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

Typereference

InverseRelationship__c


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


DescriptionThe other role that is related.

Typestring

Name


DescriptionThe name of the role. Limit: 255 characters.

Typereference

OwnerId

62


DetailsField



Typepicklist

RelationshipType__c


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

Typestring

Role


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


DescriptionLookup to the Account object.

Typedate

EndDate__c

63


DetailsField


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

Typeboolean

IsActive__c


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

Typereference

Program__c


DescriptionThe program in which the patient is enrolled.

Typeboolean

Recalculate__c


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

Typereference

Provider


DescriptionName of the physician or other healthcare provider.

Typedate

StartDate__c


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

64


DetailsField

Typepicklist

Status__c


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.

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


Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient in Lightning Platform.

Typedouble

Age__c


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

Typestring

AgeBand__c

65


DetailsField


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

Typetextarea

Conditions__c


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

Typeboolean

DisabilityStatus__c


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

Typedate

EffectiveDate__c


DescriptionThe date when the risk score was calculated.

Typepicklist

EnrollmentType__c


DescriptionIndicates the Medicare enrollment type for the patient.

Typepicklist

Gender__c


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

66


DetailsField

Typestring

HCCCodes__c


DescriptionHCC codes that apply to the patient for the year.

Typeboolean

Institution__c


DescriptionIndicates whether the patient is in an institution.

Typeboolean

LowIncome__c


DescriptionIndicates whether the patient falls within low-income guidelines.

Typestring

Month__c


DescriptionThe month that the time spent applies.

Typeboolean

MostRecent__c


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

Typeboolean

NewPatient__c


67


DetailsField

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


DescriptionLookup to the ProgramPatientAffiliation object.

Typedouble

RiskScore__c

PropertiesCreate, Filter, NillableSort, Update

DescriptionThe patient’s calculated HCC risk score.

Typepicklist

Stage__c


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


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

Typestring

Unique__c

68


DetailsField


DescriptionA key used for time calculations.

Typestring

Year__c


DescriptionThe year that the risk score applies to.

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

Provider__cRepresents a person providing healthcare.


Fields

DetailsField

Typeboolean

Active__c


DescriptionIndicates whether this provider is actively practicing.

Typereference

EHRPractitioner__c


DescriptionLookup to the EhrPractictioner object.

69


DetailsField

Typereference

RelatedContact__c


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

Typereference

RelatedUser__c


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.


Fields

DetailsField

Typeboolean

Active__c


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.

70


DetailsField

Typestring

DetailField__c


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

Typereference

FilterCriterion__c


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

Typestring

FriendlyName__c


DescriptionThe human-readable name of the timeline view configuration.

Typestring

GraphicalIcon__c


DescriptionThe icon used to depict the event on the timeline.

Typestring

HoverFieldName__c


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

71


DetailsField



Typestring

LanguageCode__c


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



Typestring

Name


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

Typestring

ObjectCategory__c


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.

72


DetailsField

Typestring

ObjectName__c



Typestring

PatientAccountLookup__c


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


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

Typeboolean

ShowOnLoad__c


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

Typedouble

SortOrder__c


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

73


Program Management

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 Program Management standard objectsare visible to users with the Health Cloud and the Health Cloud Platform permission set licensesand the Health Cloud Permission Set License permission set. You must have the Health Cloudmanaged package installed in your org to access the program management data model. Availablein API version 46.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.

74

Program ManagementHealth Cloud Developer Guide

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.

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 a device or device registration information for a patient or a care program enrollee. This object is available in API version49.0 and later.

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.

SEE ALSO:

Care Program Enrollments

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.


75


Fields

DetailsField

Typereference

CareProgramProviderId


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

Typedate

EffectiveFrom


DescriptionThe date from when this association record is effective.

Typedate

EffectiveTo


DescriptionThe date when this association record is no longer effective.

Typereference

HealthcareProviderId


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

Typeboolean

IsPrimaryProvider


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

TypedateTime

LastReferencedDate

76


DetailsField



TypedateTime

LastViewedDate



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


DescriptionThe system from which the record was sourced.

Typestring



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.

77


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.


Fields

DetailsField Name

TypeCurrency

BudgetAmount


DescriptionApproved budget for the care program.

TypeText

CareProgramName


DescriptionCare program name.

TypeLong Text Area

Description


DescriptionShort description explaining the program.

TypeDate

EndDate


DescriptionProgram termination date.

78


DetailsField Name

TypeLookup(Care Program)

ParentProgram


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

TypeLookup(Account)

ProgramSponsor


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

Typestring



DescriptionID of the system from which the record was sourced.

TypeDate

StartDate


DescriptionEffective start date of the program.

TypePick list

Status


DescriptionStatus of the program.


CareProgramFeedFeed tracking is available for the object.

79


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.


Fields

DetailsField Name

TypeLookup(Campaign)

CareProgramId


DescriptionIdentifier for the care program.

TypeMaster-Detail(Care Program)

CareProgram


DescriptionName of the care program.

TypedateTime

LastReferencedDate


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

TypedateTime

LastViewedDate

80


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

PropertiesAutonumber, Defaulted on create, Filter, Sort

DescriptionA short name for the care program campaign.

Typestring

SourceSystem


DescriptionSystem from which the care program campaign was sourced.

Typestring




Typepicklist

Status


DescriptionThe status of the care program campaign record.


CareProgramCampaignFeedFeed tracking is available for the object.

81


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()

Fields

DetailsField

Typereference

CareProgramId


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


DescriptionCriteria that define patient enrollment eligibility for a care program.

Typeboolean

IsRequired


DescriptionIndicates whether the care program eligibility rule is required.

TypedateTime

LastReferencedDate


82


DetailsField


TypedateTime

LastViewedDate



Typestring

Name


DescriptionName for the care program eligibility rule.

Typereference

OwnerId



Typestring

SourceSystem


DescriptionSystem from which the record was sourced.

Typestring




Typepicklist

Status

83


DetailsField


DescriptionDefines whether the eligibility rule is in force or not.


CareProgramEligibilityRuleFeedFeed tracking is available for the object.

CareProgramEligibilityRuleHistoryHistory is available for tracked fields of the object.

CareProgramEligibilityRuleOwnerSharingRuleSharing rules are available for the object.

CareProgramEligibilityRuleShareSharing is available for the object.

CareProgramEnrolleeRepresents a participant enrolled in a care program.


Fields

DetailsField Name

TypeLookup(Account)

AccountId


DescriptionPerson Account representing the enrollee

TypeMaster-Detail(Care Program)

CareProgramId


84


DetailsField Name

DescriptionLook up for Care Program.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



TypeLookup(Lead)

LeadId


DescriptionLead representing the enrollee.

Typestring

Name


DescriptionName of the enrollee.

Typestring

SourceSystem


DescriptionSystem from which the enrollee record was sourced.

85


DetailsField Name

Typestring



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

TypePick list

Status


DescriptionStatus of the enrollee.

TypeLookup(User)

UserId


DescriptionUser representing the enrollee.


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.


86


Fields

DetailsField

Typereference

CareProgramEnrolleeId


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

Typereference

CareProgramProductId


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

Typereference

CareProgramProviderId


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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



87


DetailsField

Typestring

Name


DescriptionName of the product the enrollee participates in.

Typereference

OwnerId



Typestring

SourceSystem



Typestring




Typepicklist

Status


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


CareProgramEnrolleeProductFeedFeed tracking is available for the object.

88


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.


Fields

DetailsField

Typestring

CardNumber


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



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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

89


DetailsField



Typestring

Name


DescriptionName for the care program enrollment card.

Typereference

OwnerId



Typestring

SourceSystem



Typestring




Typepicklist

Status


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

90



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.


Fields

DetailsField

Typereference

CareProgramId


DescriptionThe care program associated with a corresponding goal.

Typedate

CompletionDate


DescriptionThe completion date of a care program goal.

Typetextarea

Description


DescriptionA detailed description of the care program goal.

91


DetailsField

Typedate

DueDate


DescriptionThe due date for a care program goal.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the care program goal.

Typereference

OwnerId



Typepicklist

Priority


92


DetailsField

DescriptionThe priority of the care program goal.

Typepercent

ProgressPercentage


DescriptionThe percentage completion of the care program goal.

Typedouble

SequenceNumber


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

Typestring

SourceSystem



Typestring




Typedate

StartDate


DescriptionThe start date for a care program goal.

Typepicklist

Status


93


DetailsField

DescriptionThe status of a care program goal.


CareProgramGoalFeedFeed tracking is available for the object.

CareProgramGoalHistoryHistory is available for tracked fields of the object.

CareProgramGoalOwnerSharingRuleSharing rules are available for the object.

CareProgramGoalShareSharing is available for the object.

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


Fields

DetailsField

Typepicklist

Availability


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


94


DetailsField

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

Typecurrency

CareProgramPrice


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

TypedateTime

LastReferencedDate



TypedateTIme

LastViewedDate



Typestromg

Name


DescriptionName of the care program product.

Typereference

OwnerId



Typereference

ProductId

95


DetailsField


DescriptionIdentifier of the product associated with a care program

Typestring

SourceSystem


DescriptionSystem from which the care program product was sourced.

Typestring



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

Typepicklist

Status


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


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.

96



Fields

DetailsField

Typereference

AccountId


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

Typereference

CareProgramContactId


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

Typereference

CareProgramProductId


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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



97


DetailsField

Typestring

Name


DescriptionName of the provider associated with the care program.

Typereference

OwnerId



Typepicklist

Role


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

Typestring

SourceSystem



Typestring




Typepicklist

Status


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

98



CareProgramProviderFeedFeed tracking is available for the object.

CareProgramProviderHistoryHistory is available for tracked fields of the object.

CareProgramProviderOwnerSharingRuleSharing rules are available for the object.

CareProgramProviderShareSharing is available for the object.

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


Fields

DetailsField Name

TypeLookup(Account)

AccountId


DescriptionPerson account representing the team member.

TypeMaster-Detail(CareProgram)

CareProgramId


DescriptionLookup for the care program.

TypedateTime

LastReferencedDate


99


DetailsField Name


TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the care program team member.

TypePicklist

Role


DescriptionRole of the team member.

Typestring

SourceSystem



Typestring




100


DetailsField Name

TypeLookup(User)

UserId


DescriptionUser representing the team member.


CareProgramTeamMemberFeedFeed tracking is available for the object.

CareProgramTeamMemberHistoryHistory is available for tracked fields of the object.

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


Fields

DetailsField

Typereference



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

TypeMaster-detail reference

DeviceId


DescriptionThe asset ID for the device.

101


DetailsField

Referenced ObjectsAsset

Typereference

DeviceTypeId


DescriptionThe system-defined code that represents the type of the device.

Examples: Cystoscope, oxygen tent

Referenced ObjectsCodeSet

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of this device registration record.

Typereference

PatientId


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

102


DetailsField

Referenced ObjectsAccount

TypedateTime

RegistrationDate


DescriptionThe date and time when this device was registered.

Typetextarea

SafetyInformation


DescriptionThe health and safety information about with the device.

Typestring

SourceSystem



Typestring




Typepicklist

Status

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

DescriptionIndicates whether the device registration is active.

Possible values are:

• Active

• Inactive

103


DetailsField

Typetextarea

SupportContactDetail


DescriptionContact details of the person or organization that provides support for the device.

Typestring

UniqueDeviceId1


DescriptionUnique device identifier (UDI) assigned to device label or package. It identifies the labelerand the specific version or model of a device. A device may have multiple UDIs since it couldhave been sold in multiple jurisdictions.

Typeurl

UniqueDeviceId1Issuer


DescriptionThe organization that issued the UDI1 for the device.

Typestring

UniqueDeviceId2



Typeurl




Typestring

UniqueDeviceId3

104


DetailsField



Typeurl




Additional Information for CareRegisteredDevice in Other ObjectsIn addition to creating a record using these fields, you can add more details to your CareRegisteredDevice record by creating records incertain other objects, and referencing your CareRegisteredDevice record as the parent record. Here’s the list of objects you can associateto CareRegisteredDevice in this way, the type of information they add, and the field they use to reference CareRegisteredDevice.

Reference FieldType of InformationObject

ParentRecordIdAssociates an identifier value to theCareRegisteredDevice record. This identifieris not the same as the device’s UID.

Identifier


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()

105


Fields

DetailsField Name

Typestring

DeveloperName


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.

Typestring

ExternalIdField


Description

The ID of the field in the external system.

Typeboolean

IsActive


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.

106


DetailsField Name

• 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


Description

The label for this care system field mapping.

Typepicklist

Role


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


• 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


107


DetailsField Name


Typestring

TargetObject


Description

Name of the parent entity for the external ID.

SEE ALSO:

Care Program Enrollments

Enrollments

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


Fields

DetailsField

Typereference

Description


DescriptionA comprehensive description of the enrollment eligibility criteria.

TypedateTime

LastReferencedDate



108


DetailsField

TypedateTime

LastViewedDate



Typestring

Name


DescriptionA short name for the enrollment eligibility criteria.

Typereference

OwnerId



Typestring

SourceSystem



Typestring





EnrollmentEligibilityCriteriaFeedFeed tracking is available for the object.

109


EnrollmentEligibilityCriteriaHistoryHistory is available for tracked fields of the object.

EnrollmentEligibilityCriteriaOwnerSharingRuleSharing rules are available for the object.

EnrollmentEligibilityCriteriaShareSharing is available for the object.

Claims

EDITIONS



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

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.

110

ClaimsHealth Cloud Developer Guide

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()

Fields

DetailsField

Typedate

AcceptedOn__c


DescriptionDate on which the claim was accepted.

Typecurrency

AdjudicatedAmount__c


DescriptionAmount paid for the service by primary payer.

Typedate

AdjudicatedOn__c


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

Typestring

BilledDRGCode__c


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

TypeCurrency

ClaimAmount__c


111


DetailsField

DescriptionAmount submitted with the original claim.

TypeText(64)

ClaimNumber__c


DescriptionNumber assigned to the claim.

TypeReference

ClaimStatusId__c


DescriptionCurrent status of the claim.

Typeurl

DisplayUrl


Description

Typestring

ExternalId

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

Description

Typestring

DrugName__c


DescriptionName of the drug.

Typestring

DrugQuantity__c


112


DetailsField

DescriptionAuthorized quantity per refill.

Typedouble

DrugSupplyDays__c


DescriptionNumber of days the supply is authorized for.

Typetextarea

EDIMessage__c


DescriptionUnparsed, unfiltered, raw EDI message.

Typedate

FillDate__c


DescriptionDate on which the drug was filled by the pharmacy.

Typestring

FormularyTier__c


DescriptionThe formulary tier level for the drug.

Typestring

HIC3ClassCode__c


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

Typestring

IsFormularyStatus__c


113


DetailsField

DescriptionIndicates whether the drug is approved for coverage.

Typestring

IsGeneric__c


DescriptionIndicates whether the drug is generic.

Typestring

IsRefillAuthorized__c


DescriptionIndicates whether refills for the drug are authorized.

Typereference

MemberPlanId__c


DescriptionID of member plan that this claim is related to.

Typestring

Name__c


DescriptionName of the claim record.

Typestring

NDC__c


DescriptionNational Drug Code (NDC) identification number.

Typestring

PartBorPartD__c


114


DetailsField

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

Typereference

PayerId__c


DescriptionID of the payer that this claim is related to.

Typedate

PaymentDate__c


DescriptionDate on which claim was paid out.

Typestring

PreauthNumber__c


DescriptionPreauthorization number for the service.

Typestring

ReferralNumber__c


DescriptionID of the referral for the service.

Typestring

SourceSystem__c


DescriptionName of the system where this claim originated.

Typestring

SourceSystemIdentifier__c


115


DetailsField

DescriptionID of the system where this claim was sourced from.

TypedateTime



DescriptionTimestamp of the most recent update from the source system.

Typestring

StandardGenericTherapeuticClass__c


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

Typestring

StandardTherapeuticClassDescription__c


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

Typedate

SubmittedOn__c


DescriptionClaim submission date.

Typestring

Type__c


DescriptionType of claim.

116


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


Fields

DetailsField

Typereference

ClaimDiagnosisId__c


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

Typereference

ClaimProcedureId__c


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

Typeurl

DisplayUrl


Description

Typestring

ExternalId


Description

Typestring

Name__c


117


DetailsField

DescriptionName of the claim diagnosis procedure record.

Typedouble

SequenceNumber__c


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

Typestring

SourceSystem__c


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

Typestring



DescriptionName of the system where this record was sourced from.

TypedateTime



DescriptionTimestamp of the most recent update from the source system

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


118


Fields

DetailsField

TypeReference

ClaimId__c


DescriptionID of the claim that this record is related to.

Typeurl

DisplayUrl


Description

Typestring

ExternalId


Description

TypeText(64)

Name__c

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

DescriptionName of the claim provider record.

TypeReference

Provider__c


DescriptionID of the provider that this record is related to.

TypeText(64)

ProviderNPI__c


DescriptionNational Provider Identifier (NPI) identification number.

119


DetailsField

TypeText(64)

Role__c


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

TypeText(64)

SourceSystem__c


DescriptionName of the system that this record was sourced from.

TypeText(255)



DescriptionID of the system that this record was sourced from.

TypeDateTime



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

ClaimLine__xRepresents a line item in a claim record.


120


Fields

DetailsField

Typecurrency

AdjustedAmount__c


DescriptionAdjusted amount for the service

Typereference

ClaimId__c



Typestring

ClaimStatusId__c


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

Typeurl

DisplayUrl


Description

Typestring

ExternalId


Description

Typedate

From__c


DescriptionService start date for claim line.

121


DetailsField

Typedouble

LineNumber__c


DescriptionClaim line ID number.

Typestring

Location__c


DescriptionLocation details of the place where service was performed.

Typestring

LocationCode__c


DescriptionLocation code of the place where service was performed.

Typestring

Modifier__c


DescriptionModifier associated with claim line.

Typestring

Name__c


DescriptionName of the claim line record.

Typestring

NDCCode__c


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

122


DetailsField

Typecurrency

PaidAmount__c


DescriptionAmount paid for the service.

Typecurrency

Price__c


DescriptionPrice for the service.

Typestring

ProcedureCPTHCPCSId__c


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

Typereference

RenderingProvider__c


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

Typedouble

RevenueCode__c


DescriptionRevenue grouping code associated with the claim line.

Typestring

SourceSystem__c


123


DetailsField


Typestring



DescriptionID of the system that this record was sourced from.

TypedateTime



DescriptionTimestamp of the most recent update from the source system

Typestring

Title__c


DescriptionTitle of the claim line.

Typedate

To__c


DescriptionService end date for claim line.

Typedouble

Unit__c


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.

124



Fields

DetailsField

Typereference

ClaimId__c



Typestring

Diagnosis__c


DescriptionDiagnosis code or description.

Typeurl

DisplayUrl


Description

Typestring

ExternalId


Description

Typedouble

LineNumber__c


DescriptionClaim diagnosis ID number.

Typestring

Name__c

125


DetailsField


DescriptionName of the claim diagnosis record.

Typestring

SourceSystem__c



Typestring



DescriptionIdentifier of the system where this record was sourced from.

TypedateTime




Clinical Data Model

EDITIONS

Available in: Enterprise andUnlimited Editions

The Clinical Data Model enhances Health Cloud to make it more interoperable. Developed to bealigned with FHIR v4.0, this data model is built almost entirely on core. The Clinical Data Model ismeant to be the successor to the older packaged EHR Data Model.

Patient data and healthcare records are very important in the healthcare industry. Without accurateinformation, performing and managing care becomes extremely difficult. These records are readilyavailable if a patient seeks care from the same provider every time. However, in reality, a patient’shealthcare journey takes them to multiple providers and hospitals at different times. Because the patient’s health hinges on the accuracyof their medical records, it is crucial for the systems used by different providers and hospitals to be interoperable. And to make thisinteroperability possible, it’s vital to have some industry-recognized standards for how these records are structured, stored, and transferred.That’s where the standards defined by Health Level 7 (HL7) come in. Two standards defined by HL7 for this purpose are the Fast HealthInteroperability Resources (FHIR) v4.0 and HL7 (the standard) 2.3. The Clinical data model is built from the ground up to align with FHIRv4.0, and also supports many of the HL7 v2.3 message types.

To enable these objects in your org, go to FHIR R4 Support Settings in Setup and enable the FHIR-Aligned Data Model org pref.

126

Clinical Data ModelHealth Cloud Developer Guide

Note: Some of these objects will be available in your org even before enabling this org pref because they’re part of other datamodels in Health Cloud.

Here’s the list of objects that are part of the general Health Cloud permission set, and the ones that need the org pref to be enabledbefore you can use them.

Org Pref Not RequiredOrg Pref Required

• CareObservation• AllergyIntolerance

• CarePerformer • CareObservationComponent

• CareProviderFacilitySpecialty• ClinicalAlert

• ClinicalEncounter • CodeSet

• CodeSetBundle• ClinicalEncounterDiagnosis

• ClinicalEncounterFacility • HealthcareFacility

• HealthcarePractitionerFacility• ClinicalEncounterIdentifier

• ClinicalEncounterProvider • HealthcareProvider

• Identifier• ClinicalEncounterReason

• ClinicalEncounterSvcRequest • Medication

• PersonLanguage• ClinicalServiceRequest

• ClinicalServiceRequestDetail • PersonName

• DiagnosticSummary

• HealthCondition

• MedicationRequest

• MedicationStatement

• PatientHealthReaction

• PatientImmunization

• PatientMedicalProcedure

• PatientMedicalProcedureDetail

• PatientMedicationDosage

And here’s the list of Health Cloud fields added to standard objects when you enable this org pref.

• ContactPointPhone.PreferenceRank

• ContactPointPhone.UsageType

• ContactPointEmail.PreferenceRank

• ContactPointEmail.UsageType

• ContactPointAddress.PreferenceRank

• ContactPointAddress.UsageType

• Account.IsActive

• Account.EffectiveDate

• Account.SourceSystemIdentifier

• Account.SourceSystemModifiedDate

127


• Account.EndDate

• Contact.MaritalStatus

• Contact.Gender

• Contact.DeceasedDate

• Contact.SequenceInMultipleBirth

Note:

• Starting with the Winter ’23 release, new customers won’t be able to create records in the packaged EHR objects that havecounterpart standard objects in the FHIR R4-aligned data model.

• All future development in Health Cloud will be built on the FHIR R4-aligned data model. The packaged objects in the EHR datamodel won’t be used for future development.

ActivityTiming

Represents detailed information about an activity that’s repeated in regular intervals over a period of time. This object is available inAPI version 52.0 and later.

AllergyIntolerance

Represents a clinical assessment of a patient’s allergy or intolerance. This object is available in API version 51.0 and later.

AuthorNote

Stores notes associated with different types of records along with information about the author of the note and the time the notewas authored. The author isn’t necessarily the person who created a record. The author is the person who provided the informationin the note. This object is available in API version 52.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.

CarePerformer

Represents the person performing care in observations, procedure, and immunizations. This person may be a physician, the patient’scontact, or anyone who administered any sort of care to the patient in the context of the concerned care event. This object is availablein API version 51.0 and later.

CareRegisteredDevice

Represents a device or device registration information for a patient or a care program enrollee. This object is available in API version49.0 and later.

DiagnosticSummary

Represents the findings, interpretations, and summaries of tests performed on patients. This object is available in API version 51.0and later.

ClinicalAlert

Represents a warning or notification of significance related to different healthcare entities. The subject of the alert may be a patient,a location, a provider, a procedure, or even a medication. This object is available in API version 51.0 and later.

ClinicalDetectedIssue

Represents information about a detected issue resulting from a clinical activity. This object is available in API version 55.0 and later.

ClinicalDetectedIssueDetail

Represents additional information about a clinical detected issue. This object is available in API version 55.0 and later.

128


ClinicalEncounter

Represents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of apatient’s healthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. This objectis available in API version 51.0 and later.

ClinicalServiceRequest

Represents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’shealthcare. This object is available in API version 51.0 and later.

CodeSet

Represents various industry defined codes in the context of their systems and versions of those systems. These codes are used in allsorts of digital records. This object is available in API version 50.0 and later.

CodeSetBundle

Represents a group of code sets across multiple systems and versions. All of these code sets refer to the same conceptual entity. Thisobject is available in API version 50.0 and later.

HealthcareFacility

Represents a healthcare facility and all its related details. These details may be physical, functional, geographic, or business details.This object is available in API version 51.0 and later.

HealthCondition

Represents a clinical condition, problem, or any clinically relevant occurrence that is a matter of concern. This object is available inAPI version 51.0 and later.

Identifier

Represents identifier information for multiple objects. This object is available in API version 51.0 and later.

Medication

Represents detailed information about different medications. This object is available in API version 51.0 and later.

MedicationDispense

Represents the dispense of a medication to a patient in response to a medication request or order. This object also includes theinstructions for how the medication is to be administered This object is available in API version 54.0 and later.

MedicationRequest

Represents a request or order for the supply of medication, along with information about how it should be administered. This objectis available in API version 51.0 and later.

MedicationStatement

Represents a record of medication that the patient is currently taking or has taken in the past. This object is available in API version51.0 and later.

PatientHealthReaction

Represents a patient’s adverse reaction to an allergy, intolerance, or immunization. This object is available in API version 51.0 andlater.

PatientImmunization

Represents information about a patient’s immunizations. This object is available in API version 51.0 and later.

PatientMedicalProcedure

Represents detailed information about a healthcare procedure the patient has undergone, is undergoing or will undergo. This objectis available in API version 51.0 and later.

PatientMedicationDosage

Represents dosage information for medication. This object is primarily used to add dosage information in MedicationStatement,MedicationRequest, or MedicationDispense records. This object is available in API version 51.0 and later.

129


PersonLanguage

Represents the use and preference information about a person’s language. This object is available in API version 51.0 and later.

PersonName

Represents detailed information about a person’s name. This object is available in API version 51.0 and later.

ActivityTimingRepresents detailed information about an activity that’s repeated in regular intervals over a period of time. This object is available in APIversion 52.0 and later.


Fields

DetailsField

Typedouble

ActivityCountPerRepetition


DescriptionThe recommended number of times the activity should be performed in a repetition cycle.

Typedouble

ActivityDuration


DescriptionThe length of time that the activity should be performed during each occurrence.

Typereference

ActivityDurationUnitId


DescriptionThe unit of the length of time that the activity should be performed during each occurrence.

This is a relationship field.

Referenced ObjectUnitOfMeasure

130


DetailsField

Typepicklist

ActivityTime


DescriptionThe approximate time of day or a daily event that acts as a point of reference for when theactivity should be performed.


• Default

Typeint

ActivityTimeOffset


DescriptionThe number of minutes before or after the reference point specified in ActivityTimewhen the activity should be performed.

Typeint

CountInPeriod


DescriptionThe recommended number of times the activity should be performed in the specified period.

TypedateTime

LastReferencedDate


DescriptionThe most recent date on which a user referenced the record.

TypedateTime

LastViewedDate


DescriptionThe most recent date on which a user viewed th reecord.

Typeint

MaxActivityCountPerRepetition

131


DetailsField


DescriptionThe maximum number of times the activity should be performed in a repetition cycle.

Typedouble

MaxActivityDuration


DescriptionThe maximum length of time that the activity should be performed during each occurrence.

Typeint

MaxCountInPeriod


DescriptionThe maximum number of times the activity should be performed in the specified period.

Typedouble

MaxRepetitionCycleLength


DescriptionThe maximum length of each cycle of repetition.

Typestring

Name


DescriptionThe name of the ActivityTiming record. This value is generated automatically.

TypePolymorphic reference

OwnerId


DescriptionThe owner of the ActivityTiming record.

Relationship NameOwner

132


DetailsField

Relationship TypeLookup

Referenced ObjectGroup, User

TypedateTime

PeriodEndDateTime


DescriptionThe end date of the period during which this activity should be performed.

Typeint

PeriodLength


DescriptionThe length of the period during which this activity should be performed.

Typedouble

PeriodLengthLowerLimit


DescriptionThe lower limit of the length of the period during which this activity should be performed.

Typereference

PeriodLengthUnitId


DescriptionThe unit of the period's length. This field is used to specify the unit for PeriodLength,PeriodLengthLowerLimit, and PeriodLengthUpperLimit.


Typedouble

PeriodLengthUpperLimit


133


DetailsField

DescriptionThe upper limit of the length of the period during which this activity should be performed.

TypedateTime

PeriodStartDateTime


DescriptionThe start date of the period during which this activity should be performed.

Typedouble

RepetitionCycleLength


DescriptionThe recommended length of each cycle of repetition.

Typereference

RepetitionCycleUnitId


DescriptionThe unit of the length of each cycle of repetition.


Typestring

SourceSystem


DescriptionThe name of the system the record came from.

Typestring



DescriptionThe ID of the record in its source system.

TypedateTime

SourceSystemModified

134


DetailsField


DescriptionThe date and time when the record was last changed in the source system.

Typereference

TimingCodeId


DescriptionThe system-defined code that represents the timing information of an activity. This code isexpected to be a complete statement of what is specified in the other fields of this object,and either this code or the data in the other fields may be used to interpret the timing of anactivity.


Referenced ObjectCodeSet

Typepicklist

UsageType


DescriptionSpecifies the type of activity the timing information is used for.


• CareObservation—Care Observation

• ClinicalServiceRequest—Clinical Service Request

• MedicationDosage—Medication Dosage

Typereference

WeeklyActivityTimeId


DescriptionThe day and time of the week when this activity should be performed.

Referenced ObjectOperatingHours

135


UsageActivityTiming records are referenced from MedicationDosage records to specify the timing of their activities. Here’s an example of anactivity’s timing information and how an ActivityTiming record would represent that information.

Scenario: Let’s say your doctor tells you that you have to run for 10 minutes every 2 days, 30 minutes after your meals. You need to runat least 5 times in the span of those 2 days. You have to do this for 3 to 4 weeks. You’re also told that you shouldn’t run for more than15 minutes at a time, and that you shouldn’t do it more than 7 times in 3 days. So in those 3-4 weeks, you should run somewhere between60-84 times.

Sample Record:

Id: 1CDR00000000006OAAOwnerId: 005R0000000dNImIAMIsDeleted: falseName: AT-3147CreatedDate: 2021-04-15T10:48:14.000+0000CreatedById: 005R0000000dNImIAMLastModifiedDate: 2021-04-15T10:49:47.000+0000LastModifiedById: 005R0000000dNImIAMSystemModstamp: 2021-04-15T10:49:47.000+0000LastViewedDate: 2021-04-15T11:14:26.000+0000LastReferencedDate: 2021-04-15T11:14:26.000+0000TimingCodeId: nullPeriodStartDateTime: nullPeriodEndDateTime: nullPeriodLength: nullPeriodLengthLowerLimit: 3PeriodLengthUpperLimit: 4PeriodLengthUnitId: 0hER0000000001VMAQCountInPeriod: 60MaxCountInPeriod: 84ActivityDuration: 10MaxActivityDuration: 15ActivityDurationUnitId: 0hER0000000001aMAAActivityCountPerRepetition: 5MaxActivityCountPerRepetition: 7RepetitionCycleLength: 2MaxRepetitionCycleLength: 3RepetitionCycleUnitId: 0hER0000000001fMAAActivityTime: AfterMealActivityTimeOffset: 30WeeklyActivityTimeId: 0OHR00000000HanOAEUsageType: MedicationDosageSourceSystem: WWHRSourceSystemIdentifier: 763851SourceSystemModified: 2021-04-05T23:00:00.000+0000

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

ActivityTimingFeed on page 1185Feed tracking is available for the object.

136


ActivityTimingHistory on page 1193History is available for tracked fields of the object.

ActivityTimingShare on page 1199Sharing is available for the object.

AllergyIntoleranceRepresents a clinical assessment of a patient’s allergy or intolerance. This object is available in API version 51.0 and later.


Fields

DetailsField


AssertionSourceId


DescriptionRepresents the person who asserted the information about the allergy or intolerance.

ExampleThe patient or the provider who assessed the patient’s condition.

Referenced Objects

• Account

• HealthcareProvider

Typemultipicklist

Category

PropertiesCreate, Filter, Nillable, Update

DescriptionSpecifies the categories the allergy or intolerance belongs to.


• Biologic

• Environment

• Food

• Medication

137


DetailsField

Typereference

ClinicalEncounterId


DescriptionThe encounter where the allergy or intolerance was asserted.

ExampleThe encounter record for a patient’s ER visit after a bee sting.

Typereference

CodeId


DescriptionThe system-defined code that represents the allergy or intolerance.

TypedateTime

LastOccurrenceDateTime


DescriptionThe date of the last occurence of the allergy or intolerance.

Example1993-11-09T21:45:00.384Z

TypedateTime

LastReferencedDate


DescriptionThe last date that the record was referenced.

TypedateTime

LastViewedDate


DescriptionThe last date that the record was viewed.

Typestring

Name

138


DetailsField


DescriptionThe system-generated name of the AllergyIntolerance record.

TypedateTime

OnsetEndDateTime


DescriptionThe end of the estimated onset period.

Example1993-11-09T23:50:00.384Z

TypedateTime

OnsetStartDateTime


DescriptionThe onset date of the allergy intolerance or the estimated start date of the allergy intolerance'sonset.

Example1993-11-09T21:45:00.384Z


PatientId


DescriptionThe patient who has the allergy or intolerance.

Referenced Objects

• Account

TypedateTime

RecordCreationDateTime


DescriptionThe time the record for the allergy or intolerance was created.

139


DetailsField


RecordCreatorId


DescriptionThe person who created the record for the allergy or intolerance.

Referenced Objects

• Account


Typepicklist

Severity


DescriptionSpecifies the severity of the allergy or intolerance.


• High

• Low

• Unable to assess

Typestring

SourceSystem


DescriptionThe source system from where the record was brought into Salesforce.

Typestring



DescriptionThe identifier of the record in its source system.

TypedateTime



140


DetailsField

DescriptionThe date and time when the record was last modified in its source system.

Typepicklist

Status


DescriptionSpecifies the current status of the allergy or intolerance.


• Active

• Inactive

• Resolved

Typepicklist

Type


DescriptionSpecifies whether the record is about an allergy or an intolerance.


• Allergy

• Intolerance

Typepicklist

VerificationStatus


DescriptionSpecifies whether the allergy or intolerance has been verified.


• Confirmed

• Entered in error

• Refuted

• Unconfirmed

141


Additional Information for AllergyIntolerance in Other ObjectsIn addition to creating a record using these fields, you can add more details to your AllergyIntolerance record by creating records incertain other objects, and referencing your AllergyIntolerance record as the parent record. Here’s the list of objects you can associate toAllergyIntolerance in this way, the type of information they add, and the field they use to reference AllergyIntolerance.


ParentIdSpecifies the information about the patient’sadverse reaction linked to the allergy orintolerance.

PatientMedicalReaction

ParentRecordIdAssociates an identifier value to the allergyintolerance.

Identifier

AuthorNoteStores notes associated with different types of records along with information about the author of the note and the time the note wasauthored. The author isn’t necessarily the person who created a record. The author is the person who provided the information in thenote. This object is available in API version 52.0 and later.


Fields

DetailsField

TypePreference

AuthorId


DescriptionReferences the author of the note.

This is a polymorphic relationship field.

Relationship NameAuthor


Referenced Objects

• Account

• Contact


• User—This value is available in API version 55.0 and later.

142


DetailsField

Typestring

AuthorName


DescriptionThe name of the author of the note.

TypedateTime

AuthoredDateTime


DescriptionThe date and time when the note was authored.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


DescriptionThe most recent date on which a user viewed the record.

Typestring

Name


DescriptionThe name of the AuthorNote record. This value is generated automatically.

Typetextarea

NoteText

PropertiesCreate, Update

DescriptionThe contents of the note.

143


DetailsField


OwnerId


DescriptionThe owner of the AuthorNote record.



Referenced ObjectsGroup, User

TypePolymorhpic reference

ParentRecordId


DescriptionReferences the parent record that the note is associated with.

Referenced Objects

• Account

• AllergyIntolerance

• CareObservation

• CareRegisteredDevice

• ClinicalDetectedIssue—This value is available in API version 55.0 and later.

• ClinicalServiceRequest

• HealthCondition





Typepicklist

RecipientType


DescriptionThe type of recipient for an author note.


• Patient

144


DetailsField

• Provider

This field is available in API version 55.0 and later.

Typestring

SourceSystem


DescriptionThe name of the system the record came from.

Typestring



DescriptionThe ID of the record in its source system.

TypedateTime



DescriptionThe date and time when the record was last changed in the source system.

UsageWhen a record requires a related note with the information about the author of that note, that information is stored in an AuthorNoterecord. This AuthorNote record references the parent record it’s associated with using the ParentRecordId field.


AuthorNoteFeedFeed tracking is available for the object.

AuthorNoteHistoryHistory is available for tracked fields of the object.

AuthorNoteShareSharing is available for the object.

145


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.


Fields

DetailsField

Typereference

AdditionalCode1Id


DescriptionThe system-defined code that represents the type of the observation. This field is meant tobe used if the CodeId field is not sufficient.

Referenced Objects

• CodeSet

Typereference

AdditionalCode2Id


DescriptionThe system-defined code that represents the type of the observation. This field is meant tobe used if the CodeId and AdditionalCode1Id fields are not sufficient.

Referenced Objects

• CodeSet


BasedOnId


DescriptionThe medication request or service request that the observation is based on.

Referenced Objects



146


DetailsField

Typereference

BaselineUnitId


DescriptionThe unit of measure for the baseline values of this observation.

Referenced Objects

• UnitOfMeasure

Typestring

BaselineValueText


DescriptionThe baseline value of an observation represented as a string.

Typereference

BodySiteId


DescriptionThe system-defined code that represent the site of the observation on the patient’s body.

Referenced Objects

• CodeSetBundle

Typepicklist

Category


DescriptionSpecifies the category of the observation.


• Activity

• Exam

• Imaging

• Procedure

• Social-History

• Survey

• Therapy

• Vital-Signs

147


DetailsField

Typereference

CodeId


DescriptionThe system-defined code that represents the specific observation type.

Referenced Objects

• CodeSet

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

Typereference

DerivationSourceId


DescriptionRepresents the document or observation from which the value of the observation is derived.If the observation value is derived from a document, reference the diagnostic summaryrecord that represents the document. If the observation value is derived from anotherobservation, reference the CareObservation record representing that observation.


Relationship NameDerivationSource


Referenced ObjectsCareObservation, DiagnosticSummary

Typereference

DeviceId


DescriptionThe ID of the device generating the observed value.


TypedateTime

EffectiveDateTime

148


DetailsField


DescriptionThe date and time when the observation was recorded or the start date and time of theobservation’s clinically relevant period.

Typereference

EncounterId


DescriptionThe encounter related to the observation.

Referenced Objects

• ClinicalEncounter

TypedateTime

EndDateTime


DescriptionThe end date and time of the observation’s clinically relevant period.

Typereference

ExpectedValueId


DescriptionThe CodeSet ID related to the care metric target.


Typeboolean

HasMetExpectedValue


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

Typereference

IdentifierId

149


DetailsField


DescriptionThe identifer for the observation.

Referenced Objects

• Identifier

Typeboolean

IsMonitoredRemotely


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

IsObserved


DescriptionIndicates the boolean value for the observation. The value is true if something is observed,and false if it’s not. The default value is false. This is field is a duplicate field introduced in APIversion 51.0 that stores the same information as IsOutcomePositive. Use only oneof these two fields for this type of information.

Typeboolean

IsOutcomePositive


DescriptionIndicates the boolean value for the observation. The value is true if something is observed,and false if it’s not. The IsObserved field is a duplicate of this field that stores the sameinformation. Use only one of these two fields for this type of information. The default valueis false.

TypedateTime

IssuedDateTime


DescriptionThe date and time the current version of the observation record is issued.

150


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typedouble

LowerBaselineValue


DescriptionRepresents the lower limit of the baseline value range for the observation.

Typereference

MethodId


DescriptionThe system-defined code that represents the method of the observation.

Referenced Objects

• CodeSetBundle

Typestring

Name


DescriptionThe name of this care observation.

Typedouble

NumericValue

151


DetailsField


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

TypedateTime

ObservationEndTime


DescriptionThe date and time when the observation ended.

TypedateTime

ObservationStartTime


DescriptionThe date and time when the observation started.

Typepicklist

ObservationStatus


DescriptionSpeicifies the status of the observation


• Amended

• Final

• Preliminary

• Registered


ObservedSubjectId


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

Referenced Objects

• Account

152


DetailsField


Typereference

ObservedValueCodeId


DescriptionThe system-defined code that represents the observed value.

Referenced Objects

• CodeSetBundle

Typedouble

ObservedValueDenominator


DescriptionThe denominator of the observed value.

Typedouble

ObservedValueNumerator


DescriptionThe numerator of the observed value.

Typestring

ObservedValueText


DescriptionThe observed value in text form.

Typepicklist

ObservedValueType


DescriptionSpecifies the type of observed values recorded in ObservedValueNumerator andObservedValueDenominator.


153


DetailsField

• Quantity

• Range

• Ratio

Typereference

ObservedValueUnitId


DescriptionThe unit of measure for the observed value. This is a duplicate field introduced in API version51.0 that stores the same information as UnitOfMeasureId. Use only one of these fieldsto store this information.

Referenced Objects

• UnitOfMeasure


ObserverId


DescriptionThe person who made the observation.

Referenced Objects

• Account



PartOfId


DescriptionThe medication statement, procedure, or immunization that this observation is a part of.

Referenced Objects




Typepicklist

ProcessingResult


154


DetailsField

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


• 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.

Typestring

SourceSystem



Typestring




TypedateTime




155


DetailsField

Typereference

UnitOfMeasureId


DescriptionThe unit of measure for the observed value. The ObservedValueUnitId field is aduplicate of this field that stores the same information. Use only one of these fields to storethis information.

Referenced Objects

• UnitOfMeasure


Typedouble

UpperBaselineValue


DescriptionRepresents the upper limit of the baseline value range for the observation.

Typepicklist

ValueInterpretation


DescriptionSpecifies the interpretation of values observed.


• High

• Low

• Normal

Additional Information for CareObservation in Other ObjectsIn addition to creating a record using these fields, you can add more details to your CareObservation record by creating records in certainother objects, and referencing your CareObservation record as the parent record. Here’s the list of objects you can associate toCareObservation in this way, the type of information they add, and the field they use to reference CareObservation.


CareObservationIdAssociates information about theobservation’s child components.

CareObservationComponent

156



CareObservationFeedFeed tracking is available for the object.

CareObservationHistoryHistory is available for tracked fields of the object.


Represents information about a component of a care observation. This object is available in API version 51.0 and later.

CareObservationComponentRepresents information about a component of a care observation. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

DetailsField

Typereference

BaselineUnitId


DescriptionThe baseline value’s unit.

Referenced Objects

• UnitOfMeasure

Typestring

BaselineValueText




CareObservationId


157


DetailsField

DescriptionReferences the parent care observation that this component belongs to.

Referenced Objects

• CareObservation

Typereference

ComponentTypeCodeId


DescriptionThe system-generated code that represents the component type.

Referenced Objects

• CodeSetBundle

ExampleThe LOINC code for niacin in blood.

Typeboolean

IsObserved


DescriptionIndicates a positive observation.

A record can only have a value for one of these fields or field combinations:

• IsObserved

• ObservationStartDateTime and ObservationEndDateTime

• ObservedValueCodeId

• ObservedValueText

• ObservedValueNumerator, ObservedValueDenominator, andObservedValueUnitId

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

158


DetailsField



Typedouble

LowerBaselineValue



Typestring

MissingDataReason


DescriptionThe reason why observation data is missing or incomplete.

Typestring

Name


DescriptionThe name of the CareObservationComponent record.

Typedouble

NumericValue


DescriptionThe value of the observation in numeric form.

TypedateTime

ObservationEndDateTime


DescriptionSpecifies the end of the period related to observation component value.


• IsObserved

159


DetailsField





TypedateTime

ObservationStartDateTime


DescriptionSpecifies the start of the period related to observation component value.


• IsObserved





Typereference

ObservedValueCodeId


DescriptionThe system-generated code that represents the observed value.


• IsObserved





Referenced Objects

• CodeSetBundle

Typedouble



160


DetailsField

DescriptionThe denominator of the numerical type value observed. Use to record quantity, range, andratio type values.


• IsObserved





Typedouble



DescriptionThe numerator of the numerical type value observed. Use to record quantity, range, andratio type values.


• IsObserved





Typestring

ObservedValueText


DescriptionThe text form of the value observed in the component.


• IsObserved





161


DetailsField

Typereference

ObservedValueUnitId


DescriptionRepresents the unit of the observed value. This field is used for quantity, range, and ratiotype of observed values.


• IsObserved





Referenced Objects

• UnitOfMeasure

Typedouble

UpperBaselineValue



Typepicklist

ValueInterpretation




• High

• Low

• Normal

Typepicklist

ValueType


162


DetailsField

DescriptionSpecifies the type of observed value recorded in ObservedValueNumerator andObservedValueDenominator.


• Quantity

• Range

• Ratio

Usage

This object is used to record the different components of an observation, such as different tests that are part of a clinical observation.Component records are connected to the parent observation records using the CareObservationId field.

Associated Objects

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

CareObservationComponentFeedFeed tracking is available for the object.

CareObservationComponentHistoryHistory is available for tracked fields of the object.

CarePerformerRepresents the person performing care in observations, procedure, and immunizations. This person may be a physician, the patient’scontact, or anyone who administered any sort of care to the patient in the context of the concerned care event. This object is availablein API version 51.0 and later.

Important: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certainterms to avoid any effect on customer implementations.


Fields

DetailsField

Typereference

AffiliatedOrganizationId


163


DetailsField

DescriptionReferences the business account of the organization the care performer is affiliated to in thecontext of the care event.

Referenced Objects

• Account

Typereference

CareSpecialtyId


DescriptionReferences the CareSpecialty record that represents the performer’s specialty.

Referenced Objects

• CareSpecialty

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the CarePerformer record.

TypePolymorphic master-detail reference

ParentRecordId


164


DetailsField

DescriptionReferences the care observation, procedure, or immunization that this performer was involvedin.

Referenced Objects


• CareObservation


• MedicationDispense—This value is available in API version 55.0 and later.


PersonId


DescriptionReferences the person who performed care.

Referenced Objects

• Account


• User—This value is available in API version 55.0 and later.


RoleId


DescriptionThe system-defined code that specifies the care performer's role in the care event.

Referenced Objects

• CodeSet

• CodeSetBundle

UsageThis object is used to record the relevant details of a care performer in the context of specific care events. The performed care is connectedto the procedure, observation, or immunization care event using the ParentRecordId field.


CarePerformerFeedFeed tracking is available for the object.

165


CarePerformerHistoryHistory is available for tracked fields of the object.

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


Fields

DetailsField

Typereference



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


DeviceId


DescriptionThe asset ID for the device.

Referenced ObjectsAsset

Typereference

DeviceTypeId


DescriptionThe system-defined code that represents the type of the device.

Examples: Cystoscope, oxygen tent

Referenced ObjectsCodeSet

166


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of this device registration record.

Typereference

PatientId


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


TypedateTime

RegistrationDate


DescriptionThe date and time when this device was registered.

Typetextarea

SafetyInformation

167


DetailsField


DescriptionThe health and safety information about with the device.

Typestring

SourceSystem



Typestring




Typepicklist

Status


DescriptionIndicates whether the device registration is active.


• Active

• Inactive

Typetextarea

SupportContactDetail


DescriptionContact details of the person or organization that provides support for the device.

Typestring

UniqueDeviceId1


168


DetailsField


Typeurl




Typestring

UniqueDeviceId2



Typeurl




Typestring

UniqueDeviceId3



Typeurl



169


DetailsField


Additional Information for CareRegisteredDevice in Other ObjectsIn addition to creating a record using these fields, you can add more details to your CareRegisteredDevice record by creating records incertain other objects, and referencing your CareRegisteredDevice record as the parent record. Here’s the list of objects you can associateto CareRegisteredDevice in this way, the type of information they add, and the field they use to reference CareRegisteredDevice.


ParentRecordIdAssociates an identifier value to theCareRegisteredDevice record. This identifieris not the same as the device’s UID.

Identifier


CareRegisteredDeviceFeedFeed tracking is available for the object.

CareRegisteredDeviceHistoryHistory is available for tracked fields of the object.

DiagnosticSummaryRepresents the findings, interpretations, and summaries of tests performed on patients. This object is available in API version 51.0 andlater.


Fields

DetailsField

Typestring

AttachmentLanguage


DescriptionRecords the language of the attached document.

170


DetailsField


BasedOnId


DescriptionReferences the medication or clinical service request that the diagnostic summary is basedon.

Referenced Objects



Typereference

CareObservationId


DescriptionReferences the care observation that’s a part of the diagnostic summary.

Referenced Objects


Typemultipicklist

Category


DescriptionSpecifies the category of the department or service that the diagnostic summary is a productof.


• Community

• Inpatient

• Outpatient

• Patient Specified

Typereference

ClinicalEncounterId


DescriptionSpecifies the encounter that the diagnostic summary is about.

171


DetailsField

Referenced Objects


Typereference

CodeId


DescriptionThe system-defined code that describes the diagnostic summary.

Referenced Objects

• CodeSetBundle

TypedateTime

EffectiveEndDateTime


DescriptionThe end date and time of the clinically relevant period of the summary.

TypedateTime

EffectiveStartDateTime


DescriptionThe start date and time of the clinically relevant period of the summary.

Typestring

ImageComments1


DescriptionComments about the first image linked in the report.

Typestring

ImageComments2


DescriptionComments about the second image linked in the report.

172


DetailsField

Typestring

ImageComments3


DescriptionComments about the third image linked in the report.

Typestring

ImageComments4


DescriptionComments about the fourth image linked in the report.

Typestring

ImageComments5


DescriptionComments about the fifth image linked in the report.

Typeurl

ImageUrl1


DescriptionThe link to a key image associated with the diagnostic summary.

Typeurl

ImageUrl2



Typeurl

ImageUrl3



173


DetailsField

Typeurl

ImageUrl4



Typeurl

ImageUrl5



Typereference

InterpretedById


DescriptionReferences the person or organization responsible for interpreting the diagnostic summaryand its conclusions.

Referenced Objects

• CarePerformer

Typereference

IssuedById


DescriptionThe care performer that issues the diagnostic summary.

Referenced Objects

• CarePerformer

TypedateTime

IssuedDateTime


DescriptionThe date and time when the diagnostic summary was issued.

174


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the diagnostic summary record.


PatientId


DescriptionReferences the patient who is the subject of the diagnostic summary.

Referenced Objects

• Account

Typereference

ReportAttachmentId


DescriptionThe attachment of the diagnostic summary as issued by the diagnostic service.

Referenced Objects

• Attachment

Typestring

SourceSystem

175


DetailsField



Typestring




TypedateTime




Typepicklist

Status


DescriptionThe status of the diagnostic summary.


• Active

• Completed

• Entered-in-error

• Intended

• Not-taken

• On-hold

• Stopped

• Unknown

Typestring

Summary


176


DetailsField

DescriptionThe clinical conclusion of the tests performed in the diagnostic service.

Typereference

SummaryCodeId


DescriptionThe system-defined code that represents the clinical conclusion of the tests as reported inthe diagnostic service.

Referenced Objects

• CodeSetBundle

Typepicklist

UsageType


DescriptionSpecifies whether the information in the record represents a diagnostic summary or adocument reference.


• DiagnosticSummary—Diagnostic Summary

• DocumentReference—Document Reference

UsageDiagnosticSummary is used to store records representing both DiagnosticReport and DocumentReference type information fromFHIR-based systems. You can use the UsageType field to specify which records represent diagnostic reports and which records representdocument references.

For document reference records, you can also use the DiagnosticSummaryDetail child object to associate authors, related documents,and related encounters to your DiagnosticSummary record.

Additional Information for DiagnosticSummary in Other ObjectsIn addition to creating a record using these fields, you can add more details to your DiagnosticSummary record by creating records incertain other objects, and referencing your DiagnosticSummary record as the parent record. Here’s the list of objects you can associateto DiagnosticSummary in this way, the type of information they add, and the field they use to reference DiagnosticSummary.


ParentRecordIdAssociates an identifier value to thediagnostic summary.

Identifier

177



DiagnosticSummaryIdAssociates document reference-typeDiagnosticSummary records with various

DiagnosticSummaryDetail

other records and defines the nature ofassociation. For instance, authors, relateddocuments, and related encounters.


DiagnosticSummaryFeedFeed tracking is available for the object.

DiagnosticSummaryHistoryHistory is available for tracked fields of the object.

DiagnosticSummaryDetail

Represents additional information associated with document reference-type DiagnosticSummary records. This additional informationmay be related documents, authors, or related encounters. This object is available in API version 52.0 and later.

DiagnosticSummaryDetailRepresents additional information associated with document reference-type DiagnosticSummary records. This additional informationmay be related documents, authors, or related encounters. This object is available in API version 52.0 and later.

Supported Calls


Fields

DetailsField


DetailRecordId


DescriptionReferences a record that adds information to a DiagnosticSummary record.

Referenced ObjetsAccount, CareRegisteredDevice, ClinicalEncounter, DiagnosticSummary, HealthcareProvider

Typepicklist

DetailType

178


DetailsField

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

DescriptionSpecifies the relation between the DiagnosticSummary record and the detail record.


• Author

• ClinicalEncounter—Clinical Encounter

• RelatedDocument—Related Document

TypeMaster-Detail reference

DiagnosticSummaryId


DescriptionThe parent DiagnosticSummary record that the detail record is associated to.

Referenced ObjetsDiagnosticSummary

Typepicklist

DocumentRelationType


DescriptionIf the detail type is Related Document, then this field specifies the type of relationship betweenthe two documents.


• Addition

• Conversion

• Replacement

• Signature

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

179


DetailsField



Typestring

Name


DescriptionThe system-generated name of the DiagnosticSummaryDetail record.

Usage

• Use the DiagnosticSummaryId field to reference the parent DiagnosticSummary record that the additional information is beingassociated to.

• Use the DetailType picklist to specify the type of information that’s being associated to the DiagnosticSummary record.

• Use the DetailRecordId field to reference the record with the associated information. The records that correspond to each detail typeare as follows.

– Author: Account, CareRegisteredDevice, and HealthcareProvider

– ClinicalEncounter: ClinicalEncounter

– RelatedDocument: DiagnosticSummary

• If the detail type is related document, then use the DocumentRelationType picklist to specify the type of the relation between thetwo documents.

Associated Objects

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

DiagnosticSummaryDetailFeed on page 1185Feed tracking is available for the object.

DiagnosticSummaryDetailHistory on page 1193History is available for tracked fields of the object.

ClinicalAlertRepresents a warning or notification of significance related to different healthcare entities. The subject of the alert may be a patient, alocation, a provider, a procedure, or even a medication. This object is available in API version 51.0 and later.


180


Fields

DetailsField

Typemultipicklist

Categories


DescriptionSpecifies the category that the alert belongs to.


• Clinical

• Diet

• Drug

• Lab

• Subject Contact

Typestring

CodeDescription


DescriptionThe description of the alert.

Typereference

CodeId


DescriptionThe system-defined code that represents the alert.

Referenced Objects

• CodeSetBundle

TypedateTime

EndDate


DescriptionThe date and time when the alert was deactivated.

TypedateTime

LastReferencedDate

181


DetailsField



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the clinical alert record.

Typereference

OwnerId


DescriptionThe user that this record belongs to.


RaisedById


DescriptionThe person or facility that raised the alert.

Referenced Objects


• HealthcarePractitionerFacility


Typereference

RelatedEncounterId


182


DetailsField

DescriptionThe encounter that this alert is related to.

Referenced Objects

• ClincialEncounter

Typestring

SourceSystem



Typestring




TypedateTime




TypedateTime

StartDate


DescriptionThe date and time when the alert was activated.

Typepicklist

Status


DescriptionThe status of the clinical alert.


• Active

183


DetailsField

• Entered-In-Error

• Inactive

Typepolymorphic reference

SubjectId


DescriptionThe person or entity the alert is about.

Examples

• A patient experiencing kidney failure.

• A location with an avian flu outbreak.

• A practitioner flagged from referrals.

• A medication that’s flagged for special circumstances.

Referenced Objects

• Location


• Medication


• Account

Additional Information for Clinical Alert in Other ObjectsIn addition to creating a record using these fields, you can add more details to your clinical alert record by creating records in certainother objects, and referencing your ClinicalAlert record as the parent record. Here’s the list of objects you can associate to ClinicalAlertin this way, the type of information they add, and the field they use to reference ClinicalAlert.


ParentRecordIdAssociates an identifier value to the clinicalalert.

Identifier


ClinicalAlertFeedFeed tracking is available for the object.

ClinicalAlertHistoryHistory is available for tracked fields of the object.

ClinicalAlertShareSharing is available for the object.

184


ClinicalDetectedIssueRepresents information about a detected issue resulting from a clinical activity. This object is available in API version 55.0 and later.



Fields

DetailsField

Typereference

CategoryCodeId


DescriptionThe code of the category associated with the issue.

This field is a polymorphic relationship field.

Relationship NameCategoryCode


Refers ToCodeSet, CodeSetBundle

Typetextarea

Description


DescriptionAdditional information about the issue.

TypedateTime

IdentificationEndDateTime


DescriptionThe date and time when the issue identification was complete.

185


DetailsField

TypedateTime

IdentificationStartDateTime


DescriptionThe date and time when the issue was identified.

Typereference

IdentifiedById


DescriptionThe account, healthcare provider, user, or device that detected the issue.


Relationship NameIdentifiedBy


Refers ToAccount, CareRegisteredDevice, HealthcareProvider, User

TypedateTime

LastReferencedDate


DescriptionThe most recent date on which a user referenced this record.

TypedateTime

LastViewedDate


DescriptionThe most recent date on which a user viewed this record.

Typestring

Name


186


DetailsField

DescriptionThe system-generated name of the clinical detected issue record.


PatientId


DescriptionThe patient associated with the issue.

This field is a relationship field.

Relationship NamePatient


Refers ToAccount

Typetextarea

ReferenceUri


DescriptionThe medical references available on the issue.

Typepicklist

SeverityLevel


DescriptionSpecifies the impact level of the issue.


• High

• Low

• Moderate

TypedateTime

SourceSysModifiedDateTime



187


DetailsField

Typestring

SourceSystem


DescriptionThe source system from where the record was brought into Health Cloud.

Typestring



DescriptionThe identifier for the record in its source system.

Typepicklist

Status


DescriptionSpecifies the status of the issue.


• Amended

• Cancelled

• Corrected

• Entered in Error

• Final

• Preliminary

• Registered

• Unknown

UsageIndicates an actual or potential clinical issue associated with a clinical action for a patient. The category of the clinical issue, for example,drug-drug interactions or duplicate therapy, is stored in the Category Code field that has a lookup to the CodeSetBundle and CodeSetobjects.


188


ClinicalDetectedIssueFeedFeed tracking is available for the object.

ClinicalDetectedIssueHistoryHistory is available for tracked fields of the object.

ClinicalDetectedIssueDetailRepresents additional information about a clinical detected issue. This object is available in API version 55.0 and later.



Fields

DetailsField


ClinicalDetectedIssueId


DescriptionThe parent clinical detected issue associated with the issue detail.


Relationship NameClinicalDetectedIssue


Refers ToClinicalDetectedIssue

Typereference

DetailCodeId


DescriptionThe code associated with the Clinical Detected Issue Detail record.


Relationship NameDetailCode

189


DetailsField



Typereference

DetailRecordId


DescriptionThe reference to a record that adds information to a Clinical Detected Issue record.


Relationship NameDetailRecord


Refers ToAccount, ClinicalEncounterDiagnosis, DiagnosticSummary, HealthcareProvider

Typepicklist

DetailType


DescriptionSpecifies the relation between the Clinical Detected Issue record and the detail record.


• Evidence

• Implicated

• Mitigation

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


190


DetailsField


Typereference

MitigationAuthorId


DescriptionThe owner who is responsible for creating and executing the mitigation plan.


Relationship NameMitigationAuthor


Refers ToHealthcarePractitionerFacility, HealthcareProvider, User

TypedateTime

MitigationAuthoringDateTime


DescriptionThe date and time of authoring the mitigation details.

Typestring

Name


DescriptionThe system-generated name of the clinical detected issue detail record.

Usage

• Use the ClinicalDetectedIssueId field to reference the parent ClinicalDetectedIssue record that the additional informationis being associated to.

• Use the DetailRecordId field to reference the record with the associated information. This field looks up to the followingobjects:

– Account

– ClinicalEncounterDiagnosis

– DiagnosticSummary

– HealthcareProvider

191


• Use the DetailType picklist to specify the type of information that’s being associated to the ClinicalDetectedIssue record.

• If the detail type is Evidence, specify either a detail code or detail record or both. If the detail type is Implicated, specify a detail record,but do not add a detail code. If the detail type is Mitigation, specify a detail code, but do not add a detail record.


ClinicalDetectedIssueDetailFeedFeed tracking is available for the object.

ClinicalDetectedIssueDetailHistoryHistory is available for tracked fields of the object.

ClinicalEncounterRepresents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of a patient’shealthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. This object is availablein API version 51.0 and later.


Fields

DetailsField

Typepicklist

AdmissionSource


DescriptionSpecifies the source of the admission.


• Another Hospital

• Emergency Department

• General Practitioner Referral

• In-Hospital Birth

• Nursing Home

• Other

• Other Medical Practitioner Referral

• Outpatient Department

• Psychiatric Hospital

192


DetailsField

• Rehabilitation Facility

Typepicklist

Category


DescriptionSpecifies the classification of the encounter.


• Ambulatory

• Emergency

• Home Health

• Inpatient Encounter

Typereference

DestinationFacilityId


DescriptionThe facility to which the patient is transferred.

Referenced Objects

• HealthcareFacility

Typereference

DestinationOrganizationId


DescriptionThe organization to which the patient is transferred.

Referenced Objects

• Account

Typemultipicklist

DietPreference


DescriptionThe diet preferences of the patient.


• Dairy-Free

193


DetailsField

• Gluten-Free

• Halal

• Kosher

• Nut-Free

• Vegan

• Vegetarian

Typereference

DischargeDispositionId


DescriptionThe status of the patient at discharge.

Referenced Objects

• CodeSetBundle

Typedouble

Duration


DescriptionThe duration of the patient encounter, in the given unit of measure.

Typereference

DurationUnitId


DescriptionThe unit of measurement for the encounter duration.

Referenced Objects

• UnitOfMeasure

TypedateTime

EndDate


DescriptionThe date on which the encounter ended.

Typereference

FacilityId

194


DetailsField


DescriptionThe facility where the encounter took place.

Referenced Objects


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the clinical encouter record.

Typereference

PatientId


DescriptionThe patient receiving the treatment.

Referenced Objects

• Account

Typereference

PreAdmissionIdentifierId


195


DetailsField

DescriptionThe identifier for the encounter pre-admission.

Referenced Objects

• ClinicalEncounterIdentified

Typereference

PreviousFacilityId


DescriptionThe patient's location before the admission.

Referenced Objects


Typereference

PreviousOrganizationId


DescriptionThe name of the organization where the patient was previously located.

Referenced Objects

• Account

Typereference

PriorityId


DescriptionThe system-defined code that represents the priority associated with the urgency of theencounter.

Referenced Objects

• CodeSetBundle

Typereference

ReadmissionCodeId


DescriptionThe system-defined code for the readmission.

196


DetailsField

Referenced Objects

• CodeSetBundle

Typereference

RelatedClinicalEncounterId


DescriptionSpecifies an encounter that is related to this encounter.

Referenced Objects


Typereference

ServiceAppointment


DescriptionThe appointment associated with this clinical encounter.

Referenced Objects

• ServiceAppointment

Typepicklist

ServiceType


DescriptionSpecifies the classification of the type of service.


• Homoeopathy

• Meditation

• Naturopathy

• Reflexology

Typestring

SourceSystem


DescriptionThe name of the system this record came from.

197


DetailsField

Typestring



DescriptionThe ID of this record in its source system.

TypedateTime



DescriptionThe date on which this item was last changed in the source system.

Typepicklist

SpecialCourtesy


DescriptionSpecifies a class of courtesy extended to the patient.


• Extended

• Normal

• Professional

• Staff

• Unknown

• VIP

TypedateTime

StartDate


DescriptionThe date on which the encounter began.

Typepicklist

Status


198


DetailsField

DescriptionSpecifies the status of the patient encounter.


• Arrived

• Cancelled

• Finished

• In Progress

• Planned

• Triaged

Typereference

TypeId


DescriptionThe system-defined code that represents the type of the encounter.

Referenced Objects

• CodeSetBundle

Additional Information for ClinicalEncounter in Other ObjectsIn addition to creating a record using these fields, you can add more details to your ClinicalEncounter record by creating records incertain other objects, and referencing your ClinicalEncounter record as the parent record. Here’s the list of objects you can associate toClinicalEncounter in this way, the type of information they add, and the field they use to reference ClinicalEncounter.


ClinicalEncounterIdSpecifies the different diagnoses from anencounter, and other diagnosis-relatedinformation.

ClinicalEncounterDiagnosis

ClinicalEncounterIdSpecifies the different healthcare facilitiesinvolved in an encounter, and other detailsrelevant to the facility and the encounter.

ClinicalEncounterFacility

ClinicalEncounterIdSpecifies identifiers for the encounter. Theobject is very similar to the standard

ClinicalEncounterIdentifier

Identifier object, but is exclusive toClinicalEncounter.

ClinicalEncounterIdSpecifies the different providers involved inan encounter and the details of theirinvolvement.

ClinicalEncounterProvider

199



ClinicalEncounterIdSpecifies the reasons for why the encounterhappened or was required.

ClinicalEncounterReason

ClinicalEncounterIdSpecifies service requests that the encounterwas based on.

ClinicalEncounterSvcRequest


ClinicalEncounterFeedFeed tracking is available for the object.

ClinicalEncounterHistoryHistory is available for tracked fields of the object.


Represents a diagnosis related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in APIversion 51.0 and later.


Represents information about the different facilities involved in an encounter, the time spent at those facilies, and other relevantdetails. This is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.


Represents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. This object is availablein API version 51.0 and later.


Represents the providers involved in an encounter. This object is a child object of ClinicalEncounter. This object is available in APIversion 51.0 and later.


Represents the reasons for why the encounter was required. This object is a child object of ClinicalEncounter. This object is availablein API version 51.0 and later.


Represents the service requests related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is availablein API version 51.0 and later.

ClinicalEncounterDiagnosisRepresents a diagnosis related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in APIversion 51.0 and later.

Supported Calls


200


Fields

DetailsField


ClinicalEncounterId


DescriptionReferences the parent clinical encounter record the diagnosis belongs to.

Referenced Objects


Typereference

DiagnosisId


DescriptionReferences the condition or procedure relevant to the encounter.

Referenced Objects

• HealthCondition


Typedouble

DiagnosisRank


DescriptionSpecifies the rank of a particular diagnosis among multiple diagnoses for an encounter.

TypedateTime

LastReferencedDate


DescriptionThe last date and time whenthe record was referenced.

TypedateTime

LastViewedDate


DescriptionThe last date and time when the record was viewed.

201


DetailsField

Typestring

Name


DescriptionA system-generated name for the ClinicalEncounterDiagnosis record.

Typereference

UsageTypeId


DescriptionThe system-defined code that represents the role the diagnosis plays in context of theencounter.

Referenced Objects

• CodeSetBundle

Usage

Once the diagnosis-related information is recorded in the ClinicalEncounterDiagnosis record, the parent ClinicalEncounter record isreferenced using the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterDiagnosisFeedFeed tracking is available for the object.

ClinicalEncounterDiagnosisHistoryHistory is available for tracked fields of the object.

ClinicalEncounterFacilityRepresents information about the different facilities involved in an encounter, the time spent at those facilies, and other relevant details.This is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.

Supported Calls


202


Fields

DetailsField


ClinicalEncounterId


DescriptionThe parent clinical encounter that the clinical encounter facility record is related to,

Referenced Objects


Typedouble

Duration


DescriptionThe duration of time that the patient was present at the facility.

Typereference

DurationUnitId


DescriptionThe unit of time for the Duration field.

Referenced Objects

• UnitOfMeasure

TypedateTime

EndDate


DescriptionThe end date and time of the patient’s time at the facility during the encounter.

Typereference

FacilityId


DescriptionThe healthcare facility where the encounter occurred.

203


DetailsField

Referenced Objects


Typereference

FacilityTypeId


DescriptionThe system-defined code that represents the type of the facility, in the context of its physicalstructure.

Referenced Objects

• CodeSetBundle

TypedateTime

LastReferencedDate


DescriptionThe date and time when the record was last referenced.

TypedateTime

LastViewedDate


DescriptionThe last date and time when the record was viewed.

Typestring

Name


DescriptionThe system-generated name of the ClinicalEncounterFacility record.

TypedateTime

StartDate


DescriptionThe start date and time of the patient’s time at the facility during the encounter.

204


DetailsField

Typepicklist

Status


DescriptionThe status of the patient’s presence at the facility in the context of the patient’s encounter.


• Active

• Completed

• Planned

• Reserved

Usage

Once the facility-related information is recorded in the ClinicalEncounterFacility record, the parent ClinicalEncounter record is referencedusing the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterFacilityFeedFeed tracking is available for the object.

ClinicalEncounterFacilityHistoryHistory is available for tracked fields of the object.

ClinicalEncounterIdentifierRepresents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. This object is available inAPI version 51.0 and later.

Supported Calls


Fields

DetailsField


ClinicalEncounterId


205


DetailsField

DescriptionThe parent clinical encounter that this identifier belongs to.

Referenced Objects


TypedateTime

EffectiveDate


DescriptionThe date and time from when the identifier is in effect.

TypedateTime

EndDate


DescriptionThe date and time from when the identifier is no longer in effect.


IdTypeId


DescriptionThe system-defined code that represents the type of the identifier.

Referenced Objects

• CodeSet

• CodeSetBundle

Typepicklist

IdUsageType


DescriptionSpecifies the type of use of the identifier.


• Official

• Old

• Secondary

• Temp

206


DetailsField

• Usual

Typestring

IdValue


DescriptionThe unique value of the identifier. No two ClinicalEncounterIdentifier records in an org canshare the same IdValue.

Typereference

IssuingAuthorityId


DescriptionThe authority or organization that issued the identifier.

Referenced Objects

• Account

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


DescriptionThe date and time when the record was last viewed.

Typestring

Name


DescriptionThe system-generated name of the ClinicalEncounterIdentifier record.

Typestring

SourceSystem

207


DetailsField


DescriptionThe source system that the identifier belongs to.

Usage

Once the identifier-related information is recorded in the ClinicalEncounterIdentifier record, the parent ClinicalEncounter record isreferenced using the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterIdentifierFeedFeed tracking is available for the object.

ClinicalEncounterIdentifierHistoryHistory is available for tracked fields of the object.

ClinicalEncounterProviderRepresents the providers involved in an encounter. This object is a child object of ClinicalEncounter. This object is available in API version51.0 and later.

Supported Calls


Fields

DetailsField


ClinicalEncounterId


DescriptionThe parent clinical encounter that the ClinicalEncounterProvider record belongs to.

Referenced Objects

• ClinicalEncounter.

Typedouble

Duration

208


DetailsField


DescriptionThe duration of the performer's participation in the encounter.

Typereference

DurationUnitId


DescriptionThe unit of measurement for the duration field.

TypedateTime

EndDate


DescriptionThe date and time when the provider’s participation in the encounter ended.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the ClinicalEncounterProvider record.

Typereference

PractitionerId

209


DetailsField


DescriptionThe person who is performing care in the encounter.

Referenced Objects


Typereference

PractitionerTypeId


DescriptionThe system-defined code that represents the role of the practitioner in the encounter. Forexample, admitter, attender discharger, or escort.

Referenced Objects

• CodeSetBundle

TypedateTime

StartDate


DescriptionThe date and time when the provider’s participation in the encounter started.

Usage

Once the provider-related information is recorded in the ClinicalEncounterProvider record, the parent ClinicalEncounter record isreferenced using the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterProviderFeedFeed tracking is available for the object.

ClinicalEncounterProviderHistoryHistory is available for tracked fields of the object.

ClinicalEncounterReasonRepresents the reasons for why the encounter was required. This object is a child object of ClinicalEncounter. This object is available inAPI version 51.0 and later.

210


Supported Calls


Fields

DetailsField


ClinicalEncounterId


DescriptionThe parent ClinicalEncounter record that this ClinicalEncounterReason record belongs to.

Referenced Objects


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of this encounter reason.

Typereference

ReasonCodeId


211


DetailsField

DescriptionThe system-defined code that indicates the reason why the encounter took place.

Referenced Objects

• CodeSetBundle


ReasonReferenceId


DescriptionThe reason for the encounter.

Referenced Objects

• HealthCondition

• CareObservation


Usage

Once the reasons for the encounter is recorded in the ClinicalEncounterReason record using the ReasonCodeId and ReasonReferenceIdfields, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterReasonFeedFeed tracking is available for the object.

ClinicalEncounterReasonHistoryHistory is available for tracked fields of the object.

ClinicalEncounterSvcRequestRepresents the service requests related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is availablein API version 51.0 and later.

Supported Calls


212


Fields

DetailsField


ClinicalEncounterId


DescriptionThe parent ClinicalEnounter record that this ClinicalEncounterSvcRequest record belongsto.

Referenced Objects

• ClinicalEncouter

Typereference

ClinicalServiceRequestId


DescriptionThe service request that the encounter is based on.

Referenced Objects


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the clinical encounter service request record.

213


Usage

Once the service request-related information is recorded in the ClinicalEncounterSvcRequest record, the parent ClinicalEncounter recordis referenced using the ClinicalEncounterId field.

Associated Objects


ClinicalEncounterSvcRequestFeedFeed tracking is available for the object.

ClinicalEncounterSvcRequestHistoryHistory is available for tracked fields of the object.

ClinicalServiceRequestRepresents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’shealthcare. This object is available in API version 51.0 and later.


Fields

DetailsField

Typereference

BodySiteId


DescriptionThe system-defined code that represents site of the body associated with the serivce request.

Referenced Objects

• CodeSetBundle

Typereference

CategoryId


DescriptionThe system-defined code that represents the category of the service request.

Referenced Objects

• CodeSetBundle

214


DetailsField

Typereference

ConditionId


DescriptionThe condition that justifies the service request.

Referenced Objects

• HealthCondition

TypedateTime

DateSigned


DescriptionThe date the service request was signed.

Typereference

DiagnosticReportId


DescriptionThe diagnosis that justifies the service request.

Referenced Objects

• ClinicalEncounterDiagnosis

Typereference

EncounterId


DescriptionThe encounter related to the service request.

Referenced Objects


TypedateTime

EndDate


DescriptionThe end date and time for the service request.

215


DetailsField

Typereference

FacilityCodeId


DescriptionThe system-generated code for the facility where the service request is to be performed.

Referenced Objects

• CodeSetBundle

Typereference

FacilityId


DescriptionThe facility where the service request is to be performed.

Referenced Objects


Typeboolean

HasPrerequisites


DescriptionIndicates whether there are any prerequisites for the service request. If the value of this fieldis true, then you can’t select a PrerequisiteCodeId.

Typeboolean

IsIgnored


DescriptionIndicates whether the request should be ignored.

TypedateTime

LastReferencedDate



216


DetailsField

TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the clinical service request.

Typereference

ObservationId


DescriptionThe observation that justifies the service request.

Referenced Objects

• ClinicalObservation

Typereference

OriginalRequestId


DescriptionA reference to the original service request the service request replaces.

Referenced Objects



PatientId


DescriptionThe patient associated with the service request.

Referenced Objects

• Account

217


DetailsField

Typetextarea

PatientInstruction


DescriptionInstructions for the patient.


PerformerId


DescriptionThe person or device that performs the service request.

Referenced Objects

• Account

• Asset



Typereference

PerformerTypeId


DescriptionThe system-defined code that represents the type or role of the person performing theservice request.

Referenced Objects

• CodeSetBundle

Typereference

PrerequisiteCodeId


DescriptionThe system-generated code that represents the prerequisites for the service request. Youcan’t select a record for this field if the HasPrerequisites field is set to true.

Referenced Objects

• CodeSetBundle

218


DetailsField

Typepicklist

Priority


DescriptionSpecifies the priority of the service request.


• ASAP

• Routine

• Stat

• Urgent

Typedouble

QuantityDenominator


DescriptionThe denominator value of the quantity associated with the service request.

Typedouble

QuantityNumerator


DescriptionThe numerator value of the quantity associated with the service request.

Typereference

QuantityNumeratorUnitId


DescriptionThe unit of the numerator value of the quantity associated with the service request.

Referenced Objects

• UnitOfMeasure

Typepicklist

QuantityType

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

219


DetailsField

DescriptionIndicates the type of quantity related to the service request.


• Range

• Ratio

Typereference

ReasonCodeId


DescriptionThe system-defined code that represents the justification for the service request.

Referenced Objects

• CodeSetBundle

Typereference

RequestCodeId


DescriptionThe system-defined code that represents the service request.

Referenced Objects

• CodeSetBundle


RequesterId


DescriptionThe person or device raising a service request.

Referenced Objects

• Account

• Asset

• HelathcareProvider


Typereference

ServiceRequestGroupIdentifierId


220


DetailsField

DescriptionIdentifier that ties the service request to its batch of requests.

Referenced Objects

• Identifier

Typestring

SourceSystem



Typestring




TypedateTime




TypedateTime

StartDate


DescriptionThe start date and time for the service request.

Typepicklist

Status


DescriptionThe status of the service request.


• Active

221


DetailsField

• Completed

• Draft

• Entered-in-Error

• On-Hold

• Revoked

• Unknown

Typepicklist

Type


DescriptionThe type of the service request.


• Directive

• Filler-Order

• Instance-Order

• Option

• Order

• Original-Order

• Plan

• Proposal

• Reflex-Order

Additional Information for ClinicalServiceRequest in Other ObjectsIn addition to creating a record using these fields, you can add more details to your ClinicalServiceRequest record by creating recordsin certain other objects, and referencing your ClinicalServiceRequest record as the parent record. Here’s the list of objects you can associateto ClinicalServiceRequest in this way, the type of information they add, and the field they use to reference ClinicalServiceRequest.


ParentRecordIdAssociates an identifier value to the servicerequest.

Identifier

ClinicalServiceRequestIdAssociates the service request with variousother records and defines the nature of

ClinicalServiceRequestDetail

association. For instance, if the servicerequest is based on an associated record.

222



ClinicalServiceRequestFeedFeed tracking is available for the object.

ClinicalServiceRequestHistoryHistory is available for tracked fields of the object.


Associates records from different objects to a clinical service request record to add more information to it. This is a multi-objectjunction object. This object is available in API version 51.0 and later.

ClinicalServiceRequestDetailAssociates records from different objects to a clinical service request record to add more information to it. This is a multi-object junctionobject. This object is available in API version 51.0 and later.

Supported Calls


Fields

DetailsField




DescriptionReferences the parent service request record.

Referenced Objects



DetailCodeId


DescriptionReferences a code set or code set bundle that adds information to a clinical service requestrecord.

Referenced Objects

• CodeSet

• CodeSetBundle

223


DetailsField


DetailRecordId


DescriptionReferences a record that adds information to a clinical service request record.

Referenced Objects




• CareObservation

• HealthCondition


Typepicklist

DetailType


DescriptionSpecifies the relation between the service request and the detail record.


• Based On

• Body Site

• Reason Reference

• Request Facility

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



224


DetailsField

Typestring

Name


DescriptionThe system-generated name of the clinical service request detail record.

Usage

ClinicalServiceRequestDetail records add additional information to ClinicalServiceRequest records. This information may be of thefollowing types, referencing the following types of records:

• Based On: Clinical service requests or medication requests

• Body Site: Code sets or code set bundles

• Reason Reference: Health conditions, care observations, or diagnostic summaries

• Request Facility: Healthcare facilities, code sets, or code set bundles

The records providing this additional information is selected using either the DetailCodeId or DetailRecordId fields, andthen the type of information is specified using the DetailType field. This information is then connected to the clinical service requestrecord it belongs to using the ClinicalServiceRequestId field.

One record of ClinicalServiceRequestDetail can specify only one type and piece of information. If multiple detail types or detail instancesare required in the parent clinical service request record, multiple records of ClinicalServiceRequestDetail are required.

Associated Objects


ClinicalServiceRequestDetailFeedFeed tracking is available for the object.

ClinicalServiceRequestDetailHistoryHistory is available for tracked fields of the object.

CodeSetRepresents various industry defined codes in the context of their systems and versions of those systems. These codes are used in all sortsof digital records. This object is available in API version 50.0 and later.


225


Fields

DetailsField

Typestring

Code


DescriptionThe system-defined code that’s represented by this code set.

Typetextarea

CodeDescription


DescriptionAdditional information associated with the code set.

Typestring

CodeSetKey


DescriptionRepresents a unique key that identifies the concept represented by code sets across differentsystems and versions. This key is not case sensitive.

Typepicklist

CodeSetType


DescriptionSpecifies the type of the code set.

Typedate

EndDate


DescriptionThe end date of the code set’s effective period.

Typeboolean

IsActive


226


DetailsField

DescriptionIndicates whether the code set is an active code set.

Typeboolean

IsCustomCode


DescriptionIndicates whether the code set is defined by a specific organization, as opposed to recognizedacross the industry.

Typeboolean

IsPrimary


DescriptionIndicates whether the code set is the primary code set for the concept. That is, it was selectedmanually by a user instead of being selected by an automated process.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe textual representation of the meaning of the code.

Typereference

OwnerId

227


DetailsField


DescriptionA reference to the person who owns the code set record.

Typestring

SourceSystem


DescriptionThe system that sets the context for the code and defines its meaning.

Typedate

StartDate


DescriptionThe start date of the code set’s effective period.

Typestring

SystemVersion


DescriptionThe version of the source system the code belongs to.

UsageCode sets are used across multiple features and objects in Health Cloud to represent coded, system-defined information about variousentites. These codes are usually industry recognized codes from systems like LOINC or SNOMED.

CodeSetBundleRepresents a group of code sets across multiple systems and versions. All of these code sets refer to the same conceptual entity. Thisobject is available in API version 50.0 and later.


228


Fields

DetailsField

Typereference

CodeSet10Id


DescriptionA code set that represents the conceptual entity represented by the code set bundle.

Typereference

CodeSet11Id



Typereference

CodeSet12Id



Typereference

CodeSet13Id



Typereference

CodeSet14Id



Typereference

CodeSet15Id


229


DetailsField


Typereference

CodeSet1Id



Typereference

CodeSet2Id



Typereference

CodeSet3Id



Typereference

CodeSet4Id



Typereference

CodeSet5Id



Typereference

CodeSet6Id


230


DetailsField


Typereference

CodeSet7Id



Typereference

CodeSet8Id



Typereference

CodeSet9Id



Typestring

CodeSetBundleKey


DescriptionA unique key that represents the concept referenced by the bundled code sets. This valueis unique, but not case sensitive.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

231


DetailsField



Typestring

Name


DescriptionThe name of conceptual entity referenced by the different code sets grouped together inthe bundle.

Typereference

OwnerId


DescriptionReferences the user who owns the code set bundle record.

Typepicklist

Type


DescriptionSpecifies the type of the code set bundle. This field can be used to group together code setbundles of similar types. Add values to this picklist as needed for your business functions.

UsageThe different code sets that represent the same conceptual entity are referenced using the different CodeSetId fields, and then givena unique CodeSetBundleKey. This object can’t have more than one record referencing the same group of code sets. Though theindustry defines code set bundles as supporting infinite references to code sets, the salesforce implementation supports a maximum offifteen code set references in a bundle.

HealthcareFacilityRepresents a healthcare facility and all its related details. These details may be physical, functional, geographic, or business details. Thisobject is available in API version 51.0 and later.

232



Fields

DetailsField


AccountId


DescriptionReferences the business account of the facility.

Referenced Objects

• Account

Typestring

AvailabilityExceptions


DescriptionThe times when the facility is not available. Only non-standard time-offs are recorded in thisfield.

ExamplesFacility time off because of a natural disaster.

Typereference

FacilityTypeId


DescriptionThe system-defined code that represents the type of the facility in terms of that functionsperformed.

Referenced Objects

• CodeSetBundle

Typeboolean

IsAlwaysOpen


DescriptionIndicates whether the facility is open during all hours.

233


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typeint

LicensedBedCount


DescriptionThe number of licensed beds the facility has.

Typereference

LocationId


DescriptionReferences the location record representing the facility’s geolocation.

Referenced Objects

• Location

Typepicklist

LocationType


DescriptionSpecifies the type of the facility in terms of its physical structure.


• Building

• Facility

• House

234


DetailsField

• ICU Ward

Typestring

Name


DescriptionThe name of the healthcare facility record.

Typereference

ParentHealthcareFacilityId


DescriptionThe parent facility that the facility is a part of.

ExamplesThe hospital that an ER wing is a part of.

Referenced Objects


Typestring

SourceSystem



Typestring




TypedateTime




235


Additional Information for HealthcareFacility in Other ObjectsIn addition to creating a record using these fields, you can add more details to your HealthcareFacility record by creating records incertain other objects, and referencing your HealthcareFacility record as the parent record. Here’s the list of objects you can associate toHealthcareFacility in this way, the type of information they add, and the field they use to reference HealthcareFacility.


ParentRecordIdAssociates an identifier value to the facility.Identifier


HealthcareFacilityFeedFeed tracking is available for the object.

HealthcareFacilityHistoryHistory is available for tracked fields of the object.

HealthConditionRepresents a clinical condition, problem, or any clinically relevant occurrence that is a matter of concern. This object is available in APIversion 51.0 and later.


Fields

DetailsField

TypedateTime

AbatementEndDateTime


DescriptionThe end date and time of the abatement period.

TypedateTime

AbatementStartDateTime


DescriptionThe start date and time of the abatement period or the specific date and time when thecondition abated.

236


DetailsField


AssertionSourceId


DescriptionThe person made the assertion about the condition. This may be a physician, a patient, oreven the patient’s contact.

Referenced Objects

• Account


Typereference

ClinicalEncounterId


DescriptionThe clinical encounter that the immunization was a part of.

Referenced Objects


Typereference

ConditionCodeId


DescriptionThe system-defined code that represents the condition.

Referenced Objects

• CodeSetBundle

Typepicklist

ConditionStatus


DescriptionSpecifies the status of the condition.


• Active

• Inactive

• Recurrence

• Relapse

237


DetailsField

• Remission

• Resolved

Typepicklist

DiagnosticStatus


DescriptionThe diagnostic status of the condition.


• Confirmed

• Differential


• Provisional

• Refuted

• Unconfirmed

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the health condition record.

TypedateTime

OnsetEndDateTime

238


DetailsField


DescriptionThe end date and time of the onset period.

TypedateTime

OnsetStartDateTime


DescriptionThe start date and time of the onset period or the specific date and time when the conditionmanifested.


PatientId


DescriptionThe patient who is afflicted with the condition.

Referenced Objects

• Account

TypedateTime



DescriptionThe date and time when the record of the condition was created.


RecordCreatorId


DescriptionThe person who created the record of the condition.

Referenced Objects

• Account


Typepicklist

Severity

239


DetailsField


DescriptionSpecifies the severity of the condition.


• Mild

• Moderate

• Severe

Typereference

SiteId


DescriptionThe system-defined code that represents the site of the condition on the patient’s body.

Referenced Objects

• CodeSetBundle

Typestring

SourceSystem


DescriptionThe source system from where the record was brought into Health Cloud.

Typestring



DescriptionThe identifier for the record in its source system.

TypedateTime




Typereference

StageId

240


DetailsField


DescriptionThe system-defined code that represents the stage of the condition.

Referenced Objects

• CodeSetBundle

Typepicklist

Type


DescriptionThe contextual type of the condition.


• Encounter Diagnosis

• Problem List Item

Additional Information for HealthCondition in Other ObjectsIn addition to creating a record using these fields, you can add more details to your HealthCondition record by creating records in certainother objects, and referencing your HealthCondition record as the parent record. Here’s the list of objects you can associate toHealthCondition in this way, the type of information they add, and the field they use to reference HealthCondition.


ParentRecordIdAssociates an identifier value to the healthcondition.

Identifier

HealthConditionDetail

This child object is used to associate body site and laterality codes to HealthCondition records. This object is available in API version52.0 and later.

HealthConditionDetailThis child object is used to associate body site and laterality codes to HealthCondition records. This object is available in API version 52.0and later.

Supported Calls


241


Fields

DetailsField

TypePolymorphic Master-Detail reference

DetailCodeId


DescriptionReferences a code set or code set bundle that adds information to a HealthCondition record.

Referenced ObjectsCodeSet, CodeSetBundle

Typepicklist

DetailType


DescriptionSpeicifies the type of information represented by the detail code that’s accosicated to theHealthCondition record.


• Body Site

• Laterality

TypeMaster-Detail reference

HealthConditionId


DescriptionThe parent HealthCondition record to which the body site and laterality information is beingadded.

Referenced ObjectsHealthCondition

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

242


DetailsField



Typestring

Name


DescriptionThe system-generated name of the HealthConditionDetail record.

Usage

• Use the HealthConditionId field to reference the parent HealthCondition record that the additional information is being associatedto.

• Use the DetailType picklist to specify the type of code that’s being associated to the HealthCondition record.

• Use the DetailCodeId field to reference the code set or code set bundle record with the associated information.

Associated Objects


HealthConditionDetailFeed on page 1185Feed tracking is available for the object.

HealthConditionDetailHistory on page 1193History is available for tracked fields of the object.

IdentifierRepresents identifier information for multiple objects. This object is available in API version 51.0 and later.



243


Fields

DetailsField

TypedateTime

EffectiveDate


DescriptionThe date and time from when the identifier is valid.

TypedateTime

EndDate


DescriptionThe date and time from when the identifier is no longer valid.


IdTypeId


DescriptionThe system-defined code that represents the type of ID the identifier is.

Referenced Objects

• CodeSet

• CodeSetBundle

Typepicklist

IdUsageType


DescriptionSpecifies the type of use of the ID.


• Official

• Old

• Secondary

• Temp

• Usual

Typestring

IdValue

244


DetailsField


DescriptionThe value of the identifier.

Typestring

IdentifierKey

PropertiesFilter, Group, idLookup, Nillable, Sort

DescriptionA unique key assigned to the identifier record.

This is a calculated field.

Typereference

IssuingAuthorityId


DescriptionThe authorized body that issued the identifier.

Referenced Objects

• Account

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


245


DetailsField

DescriptionThe system-generated name for the identifier record.


ParentRecordId


DescriptionThe parent entity associated with the identifier.

Referenced Objects

• Account

• BoardCertification

• Contact


• Medication

• HealthCondition








• ClinicalAlert





• ClinicalDetectedIssue—This value is available in API version 55.0 and later.

Typestring

SourceSystem


DescriptionThe source system from which the identifier record was brought into Health Cloud.

Typestring


246


DetailsField


DescriptionThe identifier of the identifier record in its source system.

TypedateTime



DescriptionThe date and time when the identifier record was last modified in its source system.

UsageThe identifier object is used to assign identifiers to records in various other objects. Here’s a list of the objects whose records you canadd identifiers to:

• Account

• Contact

• Board Certification

• Medication

• HealthCondition







• ClinicalAlert





• ClinicalDetectedIssue

You connect the identifier record to its related record in any of the listed objects by referencing that record using the ParentRecordIdfield.

MedicationRepresents detailed information about different medications. This object is available in API version 51.0 and later.

247



Fields

DetailsField

Typeint

BatchNumber


DescriptionSpecifies the batch number of the medication.

TypedateTime

ExpirationDateTime


DescriptionSpecifies the expiration date of the medication.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

ManufacturerId


DescriptionThe company that makes the medicine.

248


DetailsField

Referenced Objects

• Account

Typereference

MedicationCodeId


DescriptionThe system-defined code that identifies a medication.

Referenced Objects

• CodeSetBundle

Typereference

MedicationFormId


DescriptionThe system-defined code for the dosage form this medication is manufactured in.

Referenced Objects

• CodeSetBundle

Typestring

Name


DescriptionThe name of the medication.

Typereference

OwnerId


DescriptionThe user who owns the medication record.

Typedouble

QuantityDenominator


249


DetailsField

DescriptionThe total volume of the medication contained in the packaged product.

Typedouble

QuantityNumerator


DescriptionThe total amount of the medication contained in the packaged product.

Typereference

QuantityUnitId


DescriptionThe measurement unit for the quantity.

Referenced Objects

• UnitOfMeasure

Typestring

SourceSystem



Typestring



DescriptionThe ID of this record on its source system.

TypedateTime



DescriptionThe date on which this item was last changed on the source system.

250


DetailsField

Typepicklist

Status


DescriptionSpecifies the status of the medication.


• Active


• Inactive

Additional Information for Medication in Other ObjectsIn addition to creating a record using these fields, you can add more details to your Medication record by creating records in certainother objects, and referencing your Medication record as the parent record. Here’s the list of objects you can associate to Medication inthis way, the type of information they add, and the field they use to reference Medication.


ParentRecordIdAssociates an identifier value to themedication record.

Identifier

ParentRecordIdAdds information about the differentingredients used in the medication.

MedicinalIngredient

MedicinalIngredient

MedicinalIngredient is a child object of Medication that represents substances or drugs that are used as ingredients in the medication.This object is available in API version 52.0 and later.

MedicinalIngredientMedicinalIngredient is a child object of Medication that represents substances or drugs that are used as ingredients in the medication.This object is available in API version 52.0 and later.

Supported Calls


251


Fields

DetailsField


IngredientId


DescriptionThe substance that’s used as an ingredient in the medication. If the ingredient is anothermedication or drug, reference a Medication record. If the ingredient is not a medication,reference a code set bundle record with the system-defined code that represents theingredient.

Referenced ObjectsMedication, CodeSetBundle

Typeboolean

IsActive


DescriptionIndicates whether the ingredient is an active ingredient in the medication. An active ingredientaffects the therapeutic action of the medication.

The default value is 'false'.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


252


DetailsField

DescriptionThe system-generated name of the record.


OwnerId


DescriptionThe owner of the record.

Referenced ObjectsGroup, User

Typereference

ParentRecordId


DescriptionThe medication that this ingredient is a part of.


Referenced ObjectsMedication

Typedouble

StrengthDenominator


DescriptionThe denominator value of the ingredient’s strength or quantity in the medication.

Typereference

StrengthDenominatorUnitId


DescriptionThe unit of StrengthDenominator

Referenced ObjectsUnitOfMeasure

Typedouble

StrengthNumerator

253


DetailsField


DescriptionThe numerator value of the ingredient’s strength or quantity in the medication.

Typereference

StrengthNumeratorUnitId


DescriptionThe unit of StrengthNumerator


Refers ToUnitOfMeasure

Usage

Ingredients are added to a medication record by creating MedicinalIngredient records to represent each iongredient, and then referencingthe medication record using the ParentRecordId field in all the MedicinalIngredient records.

Associated Objects


MedicinalIngredientFeedFeed tracking is available for the object.

MedicinalIngredientHistory on page 1193History is available for tracked fields of the object.

MedicinalIngredientShare on page 1199Sharing is available for the object.

MedicationDispenseRepresents the dispense of a medication to a patient in response to a medication request or order. This object also includes the instructionsfor how the medication is to be administered This object is available in API version 54.0 and later.



254


Fields

DetailsField

Typereference

CollectedBy


DescriptionThe contact, account, or a healthcare provider who collected the dispensed medication. Thisfield is available in API version 55.0 and later.


Relationship NameCollectedBy


Refers ToAccount, Contact, HealthcareProvider

Typereference

ContextId


DescriptionThe encounter that establishes the context for the dispense of a medication.

Refers To


Typereference

DeliveryLocationId


DescriptionThe location where the dispensed medication will be delivered. This field is available in APIversion 55.0 and later.


Relationship NameDeliveryLocation


Refers ToHealthcareFacility, Location

255


DetailsField

TypePolymorphic lookup

DispenseTypeCodeId


DescriptionThe system-defined code that identifies the dispense event type. For instance, a first fill, trialfill, or refill.

Refers To

• CodeSet

• CodeSetBundle

TypedateTime

DispensedDateTime


DescriptionThe date and time when the medication was handed over.

Typereference

HealthcareFacilityId


DescriptionThe location where the dispense occurred.

Refers To


Typeboolean

IsSubstituted


DescriptionIndicates whether a substitute medication was dispensed.

The default value is false.


TypedateTime

LastReferencedDate


256


DetailsField


TypedateTime

LastViewedDate



Typepicklist

MedAdministrationSettingCategory


DescriptionSpecifies the setting in which the medication is expected to be administered to the patient.


• Inpatient

• Outpatient

• Community

• Discharge

Typereference

MedicationCodeId


DescriptionThe system-defined code that identifies the medication that's dispensed.

Refers To

• CodeSet

• CodeSetBundle

Typereference

MedicationId


DescriptionThe medication that's dispensed.

Relationship NameMedication

257


DetailsField


Refers To

• Medication

Typestring

Name


DescriptionThe name of the record.


PatientId


DescriptionThe patient for whom the medication is dispensed.

Refers To

• Account

TypedateTime

PreparedDateTime


DescriptionThe date and time when the medication was prepared for dispense.

Typereference

PrimaryDetectedIssueId


DescriptionThe primary clinical issue associated with the medication dispensation. This field is availablein API version 55.0 and later.


Relationship NamePrimaryDetectedIssue


258


DetailsField


Typereference

PrimaryMedicationRequestId


DescriptionThe primary medication request that authorized the dispense of the medication.

Refers To


Typereference

PrimaryProcedureId


DescriptionThe primary medical procedure associated with the medication dispensation. This field isavailable in API version 55.0 and later.


Relationship NamePrimaryProcedure


Refers ToPatientMedicalProcedure

Typedouble

Quantity


DescriptionThe quantity of medication that was dispensed.

Typereference

QuantityUnitId


DescriptionThe unit of the quantity of medication that was dispensed.

259


DetailsField

Refers To

• UnitOfMeasure

Typestring

SourceSystem



Typestring




TypedateTime

SourceSystemModifiedDateTime


DescriptionThe date and time when this item was last changed in the source system.

Typepicklist

Status


DescriptionSpecifies the status of the dispense event.


• Cancelled

• Completed

• Declined

• Entered-In-Error

• In-Progress

• On-Hold

• Preparation

• Stopped

• Unknown

260


DetailsField


StatusReasonCodeId


DescriptionThe system-defined code that specifies the reason for the specified status.

Refers To

• CodeSet

• CodeSetBundle

Typereference

StatusReasonRelatedIssueId


DescriptionSpecifies clinical issue that resulted in the status of the medication dispensation. This fieldis available in API version 55.0 and later.


Relationship NameStatusReasonRelatedIssue



Typereference

SubstitutedById


DescriptionSpecifies the user or healthcare provider who substituted the medication. This field is availablein API version 55.0 and later.


Relationship NameSubstitutedBy


Refers ToHealthcareProvider, User

261


DetailsField

Typemultipicklist

SubstitutionReason


DescriptionSpecifies the reason for substituting the medication.


• Continuing therapy

• Formulary policy

• Out of stock

• Regulatory requirement


Typepicklist

SubstitutionType


DescriptionSpecifies the type of substitution done for the medication.


• Brand composition

• Equivalent

• Equivalent composition

• Formulary

• Generic composition

• None

• Therapeutic alternative

• Therapeutic brand

• Therapeutic generic


Typedouble

SupplyDaysCount


DescriptionThe number of days that the dispensed supply is expected to last.

262


Additional Information for MedicationStatement in Other ObjectsIn addition to creating a record using these fields, you can add more details to your MedicationDispense record by creating records incertain other objects, and referencing your MedicationDispense record as the parent record. Here’s the list of objects you can associateto MedicationStatement in this way, the type of information they add, and the field they use to reference MedicationStatement.


ParentRecordIdAssociates an identifier value to themedication dispense.

Identifier


MedicationDispenseFeedFeed tracking is available for the object.

MedicationDispenseHistoryHistory is available for tracked fields of the object.

MedicationRequestRepresents a request or order for the supply of medication, along with information about how it should be administered. This object isavailable in API version 51.0 and later.


Fields

DetailsField

Typereference

AllowedSubstitutionTypeCodeId


DescriptionThe system-defined code that represents the type of substitution that's allowed. This fieldcan’t be used if the CanSubstitute field is set to true.

Referenced Objects

• CodeSetBundle

Typeboolean

CanSubstitute

263


DetailsField


DescriptionIndicates whether substitution is okay. If the value for this field is set to true, then theAllowedSubstitutionTypeCodeId field can’t be selected.

Typereference

ClinicalEncounterId


DescriptionThe clinical encounter related to the medication request.

Referenced Objects


Typereference



DescriptionReferences the service request related to the medication request.

Referenced Objects


Typedouble

DispenseInterval


DescriptionThe minimum interval required between refills.

Typereference

DispenseIntervalUnitId


DescriptionThe unit for that interval.

Referenced Objects

• UnitOfMeasure

264


DetailsField

Typereference

DispenserId


DescriptionThe person who provides the medication.

Referenced Objects

• Account

Typereference

FillDurationUnitId


DescriptionThe unit for the fill duration.

Referenced Objects

• UnitOfMeasure

Typereference

FillQuantityUnitId


DescriptionThe unit of the fill quantity.

Referenced Objects

• UnitOfMeasure

Typedouble

InitialFillDuration


DescriptionThe length of time the first fill is expected to last.

Typedouble

InitialFillQuantity


DescriptionThe quantity to be filled in the first dispense.

265


DetailsField

Typeboolean

IsIgnored


DescriptionIndicates whether the request should be ignored.

Typeboolean

IsSecondaryInformation


DescriptionIndicates whether the request is based on information from a secondary source instead ofa primary one. If this field is set to true, then the SecondarySourceId field can’t beselected.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedicationAdministrationContextId


DescriptionThe system-defined code that represents the setting in which the medication is administered.

Referenced Objects

• CodeSetBundle

Typereference

MedicationCodeId

266


DetailsField


DescriptionThe system-defined code that specifies the medication requested. A record can select eithera MedicationId or a MedicationCodeId, but not both.

Referenced Objects

• CodeSetBundle

Typereference

MedicationId


DescriptionLookup to the medication record for the medicine requested. A record can select either aMedicationId or a MedicationCodeId, but not both.

Referenced Objects

• Medication

Typereference

MedicationRequestGroupId


DescriptionA shared identifier common to all medication requests that were authorized more or lesssimultaneously by a single author.

Referenced Objects

• Identifier

Typestring

Name


DescriptionThe system-generated name of the medication request record.


PatientId


DescriptionThe person who needs the medicine.

267


DetailsField

Referenced Objects

• Account


PerformerId


DescriptionThe person who will administer the medicine.

Referenced Objects

• Account



Typereference

PerformerTypeId


DescriptionThe system-defined code that represents the performer's role. For instance, cardiologist,neurosurgeon, etc.

Referenced Objects

• CodeSetBundle

TypedateTime

PrescribedDate


DescriptionThe date and perhaps time when the prescription was initially written or authored on.

TypedateTime

PrescriptionPeriodEnd


DescriptionThe end date for the prescription's validity.

TypedateTime

PrescriptionPeriodStart

268


DetailsField


DescriptionThe start date for the prescription's validity.

Typereference

PreviousPrescriptionId


DescriptionReference to previous prescriptions.

Referenced Objects


Typepicklist

Priority


DescriptionSpecifies the priority of the request.


• ASAP

• Routine

• Stat

• Urgent

Typereference

ReasonCodeId


DescriptionThe code for why the medicine was requested.

Referenced Objects

• CodeSetBundle


ReasonReferenceId


269


DetailsField

DescriptionReference to the condition or obbservation that warranted this medicine.

Referenced Objects

• HealthCondition

• CareObservation

Typedouble

RefillDuration


DescriptionHow long the refill is expected to last.

Typedouble

RefillQuantity


DescriptionThe quantity in each refill.

Typeint

RefillsAllowed


DescriptionThe number of refills that are allowed.

Typereference

RelatedRequestId


DescriptionA plan or request that is fulfilled in whole or in part by this medication request.

Referenced Objects



RequesterId


270


DetailsField

DescriptionThe person who raised the request.

Referenced Objects

• Account




SecondarySourceId


DescriptionReferences the person who gave the information for the request. This field can’t be selectedif the IsSecondarySource field is set to true.

Referenced Objects

• Account


Typestring

SourceSystem



Typestring




TypedateTime




Typepicklist

Status

271


DetailsField


DescriptionThe status of the medication request.


• Active

• Cancelled

• Completed

• Draft

• Entered-in-Error

• On-Hold

• Stopped

• Unknown

Typereference

StatusReasonCodeId


DescriptionThe system-defined code that specifies the reason for the status.

Referenced Objects

• CodeSetBundle

Typereference

SubstitutionReasonCodeId


DescriptionSpecifies why a subsitution is required.

Referenced Objects

• CodeSetBundle

Typepicklist

TherapyDuration


DescriptionThe description of the overall pattern of the administration of the medication to the patient.For instance, Continuos, Acute, Seasonal.


272


DetailsField

• Continuous

• Seasonal

• Short Term

Typepicklist

Type


DescriptionThe type of the request.


• Filler Order

• Instance Order

• Option

• Order

• Original Order

• Plan

• Proposal

• Reflex Order

Additional Information for MedicationRequest in Other ObjectsIn addition to creating a record using these fields, you can add more details to your MedicationRequest record by creating records incertain other objects, and referencing your MedicationRequest record as the parent record. Here’s the list of objects you can associateto MedicationRequest in this way, the type of information they add, and the field they use to reference MedicationRequest.


ParentRecordIdAssociates an identifier value to themedication request.

Identifier

ParentRecordIdAssociates dosage related information forthe medication in the medication requestrecord.



MedicationRequestFeedFeed tracking is available for the object.

MedicationRequestHistoryHistory is available for tracked fields of the object.

273


MedicationStatementRepresents a record of medication that the patient is currently taking or has taken in the past. This object is available in API version 51.0and later.


Fields

DetailsField

TypedateTime

AssertionDateTime


DescriptionThe date and time the medication statement was made.

Typereference

CareObservationId


DescriptionThe observation that warranted this medication.

Referenced Objects

• CareObservation

Typereference

ClinicalEncounterId


DescriptionThe encounter related to the medication statement.

Referenced Objects


Typepicklist

DeliverySetting


274


DetailsField

DescriptionSpecifies the setting in which the medication was administered.


• Community

• Inpatient

• Outpatient

• PatientSpecified

TypedateTime

EndDateTime


DescriptionThe stated end date and time for the medication.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedicationCodeId


DescriptionThe system-defined code that identifies a medication. A record can select either aMedicationId or a MedicationCodeId, but not both.

Referenced Objects

• CodeSetBundle

Typereference

MedicationId

275


DetailsField


DescriptionThe medication associated with this medication statement. A record can select either aMedicationId or a MedicationCodeId, but not both.

Referenced Objects

• Medication

Typereference

MedicationReasonCodeId


DescriptionThe system-defined code that specifies the reason this medication was taken.

Referenced Objects

• CodeSetBundle


MedicationReasonId


DescriptionThe observation, condition, or diagnostic report that warranted the medication.

Referenced Objects

• HealthCondition

• CareObservation

Typereference

MedicationRequestId


DescriptionA medication request associated with the medication statement.

Referenced Objects


Typestring

Name


276


DetailsField

DescriptionThe system-generated name of the medication statement record.

Typereference

ParentMedicationStatementId


DescriptionThe parent medication statement associated with the medication statement.

Referenced Objects



PatientId


DescriptionA patient that the medication statement refers to.

Referenced Objects

• Account

Typereference

ProcedureId


DescriptionThe procedure associated with this medication statement.

Referenced Objects


Typestring

SourceSystem



Typestring


277


DetailsField



TypedateTime




TypedateTime

StartDateTime


DescriptionThe stated start date and time for the medication.

Typereference

StatementSourceId


DescriptionThe person who made the medication statement.

Typepicklist

Status


DescriptionSpecifies the status of the medication in this statement.


• Active

• Completed

• Entered-in-error

• Intended

• Not-taken

• On-hold

• Stopped

278


DetailsField

• Unknown

Typereference

StatusReasonCodeId



Referenced Objects

• CodeSetBundle

Additional Information for MedicationStatement in Other ObjectsIn addition to creating a record using these fields, you can add more details to your MedicationStatement record by creating records incertain other objects, and referencing your MedicationStatement record as the parent record. Here’s the list of objects you can associateto MedicationStatement in this way, the type of information they add, and the field they use to reference MedicationStatement.


ParentRecordIdAssociates an identifier value to themedication statement.

Identifier

ParentRecordIdAssociates dosage related information forthe medication in the medication statementrecord.



MedicationStatementFeedFeed tracking is available for the object.

MedicationStatementHistoryHistory is available for tracked fields of the object.

MedicationStatementDetail

Represents additional information associated with MedicationStatement records. This object is available in API version 54.0 and later.

MedicationStatementDetailRepresents additional information associated with MedicationStatement records. This object is available in API version 54.0 and later.

279


Supported Calls


Fields

DetailsField

TypePolymorphic Master-Detail reference

DetailCodeId


DescriptionReferences a code set or code set bundle that adds information to a MedicationStatementrecord.

Referenced Objects

• CodeSet

• CodeSetBundle


DetailRecordId


DescriptionReferences a record that adds information to a MedicationStatement record

Refers To

• CareObservation



• HealthCondition

• MedicationDispense




Typepicklist

DetailType


DescriptionSpecifies the type of information added to the MedicationStatement record.


280


DetailsField

• Based On

• Part Of

• Status Reason

• Reason Code

• Reason Reference

• Derived From

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate




MedicationStatementId


DescriptionThe parent MedicationStatement record to which additional information is being added.


Refers To


Typestring

Name


DescriptionThe name of the record.

281


Usage

• Use the MedicationStatementId field to reference the parent MedicationStatement record that the additional information is beingassociated to.

• Use the DetailType picklist to specify the type of detail that’s being associated to the MedicationStatement record. Here's how theassociated record types are mapped to values in the DetailType field.

– Based On - MedicationRequest, ServiceRequest

– Part Of - MedicationDispense, MedicationStatement, PatientMedicalProcedure, CareObservation

– Status Reason - CodeSet, CodeSetBundle

– Reason Code - CodeSet, CodeSetBundle

– Reason Reference - HealthCondition, CareObservation, DiagnosticSummary

– Derived From - CareObservation, ClinicalServiceRequest, DiagnosticSummary, HealthCondition, MedicationDispense,MedicationRequest, MedicationStatement, PatientMedicalProcedure

• Use the DetailCodeId and DetailRecordId fields to reference the records with the associated information.

PatientHealthReactionRepresents a patient’s adverse reaction to an allergy, intolerance, or immunization. This object is available in API version 51.0 and later.



Fields

DetailsField

Typereference

CausativeSubstanceId


DescriptionThe system-defined code that represents the substance that triggered the reaction.

Referenced Objects

• CodeSetBundle

Typestring

Details


282


DetailsField

DescriptionAdditional information about the reaction and, if required, the manifested symptoms.

Typereference

ExposureRouteId


DescriptionThe system-defined code that represents the route of exposure related to the reaction.

Referenced Objects

• CodeSetBundle

Typeboolean

IsSelfReported


DescriptionIndicates whether the reaction was reported by the patient.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

ManifestedSymptomId


DescriptionThe system-defined code that represents the manifested symptom.

Referenced Objects

• CodeSetBundle

283


DetailsField

Typestring

Name


DescriptionThe system-generated name of the PatientHealthReaction record.

Typereference

ObservationId


DescriptionThe observation that provides additional information about the reaction.

Referenced Objects

• CareObservation


ParentId


DescriptionThe imm unization or allergy intolerance that this reaction is a result of.

Referenced Objects



TypedateTime

ReactionDateTime


DescriptionThe date and time of the reaction.

Typepicklist

Severity


DescriptionSpecifies the severity of the reaction.


284


DetailsField

• Mild

• Moderate

• Severe

UsagePatientHealthReaction records are used to add more information to AllergyIntolerance and PatientImmunization records in the eventof the patient experiencing an adverse reaction related to those events. The PatientHealthReaction record is associated to theAllergyIntolerance or PatientImmunization records using the ParentId field.


PatientHealthReactionFeedFeed tracking is available for the object.

PatientHealthReactionHistoryHistory is available for tracked fields of the object.

PatientImmunizationRepresents information about a patient’s immunizations. This object is available in API version 51.0 and later.


Fields

DetailsField

Typereference

CareObservationId


DescriptionThe observation that determined the need for the immunization.

Referenced Objects

• CareObservation

Typereference

ClinicalEncounterId

285


DetailsField


DescriptionThe clinical encounter that the immunization was a part of.

Referenced Objects


Typestring

CurrentDose


DescriptionThe current dose the patient is on in the total number of doses recommended forimmunization.

Typereference

DiagnosticSummaryId


DescriptionThe diagnostic summary that determined the need for the immunization.

Referenced Objects


Typedouble

Dose


DescriptionThe amount of vaccine that was administered.

Typereference

DoseUnitId


DescriptionThe unit of the amount of vaccine that was administered.


286


DetailsField

TypedateTime

ExpirationDate


DescriptionThe date and time when the immunization is expected to expire.

Typereference

FacilityId


DescriptionThe healthcare facility where the immunization was performed.

Referenced Objects


Typereference

HealthConditionId


DescriptionThe health condition that determined the need for the immunization.

Referenced Objects

• HealthCondition

Typestring

ImmunizationRecommendation


DescriptionThe protocol that was followed for the immunzation.

Typereference

InformationSourceId


DescriptionThe system-defined code that represents the source that provided information about theimmunization.

287


DetailsField

Referenced Objects

• CodeSetBundle

Typeboolean

IsRecordedByVaccinator


DescriptionIndicates whether the immunization record was recorded by the vaccinator.

Typeboolean

IsSubpotent


DescriptionIndicates whether the vaccination dose was sub-potent.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LotNumber


DescriptionThe lot number of the vaccine.

Typestring

Manufacturer

288


DetailsField


DescriptionThe name of the vaccine’s manufacturer.

Typereference

ManufacturerAccountId


DescriptionReferences the organization that manufactured the vaccine.


Typestring

Name


DescriptionThe system-generated name of the patient immunization record.


PatientId


DescriptionThe patient who was immunized.

Referenced Objects

• Account

Typereference

ReasonCodeId


DescriptionThe system-defined code that represents the reason for the immunization.

Referenced Objects

• CodeSetBundle

Typestring

RecommendedDoses

289


DetailsField


DescriptionTotal number of doses recommended to achieve immunity.

Typestring

RecommendingAuthority


DescriptionThe authority or organization that recommended the vaccination protocol that was followed.

TypedateTime



DescriptionThe date and time when the patient immunization record was created.

Typereference

RouteId


DescriptionThe system-defined code that represents the route followed in the vaccine administration.

Referenced Objects

• CodeSetBundle

Typereference

SiteId


DescriptionThe system-defined code that represents the site of the vaccine administration on the patient’sbody.

Referenced Objects

• CodeSetBundle

Typestring

SourceSystem

290


DetailsField


DescriptionThe source system from where the immunization record was brought into Health Cloud.

Typestring



DescriptionThe identifier of the immunization record in its source system.

TypedateTime



DescriptionThe date and time when the immunization record was last modified in its source system.

Typepicklist

Status


DescriptionSpecifies the status of the vaccination.


• Completed

• Entered in Error

• Not Done

Typereference

StatusReasonCodeId


DescriptionThe system-defined code that represents the reason for the status of the vaccination.

Referenced Objects

• CodeSetBundle

Typereference

SubpotencyReasonCodeId

291


DetailsField


DescriptionThe system-defined code that represents the reason for why the vaccination was sub-potent.

Referenced Objects

• CodeSetBundle

Typereference

TargetDiseaseCodeId


DescriptionThe system-defined code that represents the disease that was targeted in the immunization.

Referenced Objects

• CodeSetBundle

TypedateTime

VaccinationDate


DescriptionThe date and time of the vaccination. If you specify a vaccination date, you can’t specifiy avaccination period.

Typestring

VaccinationPeriod


DescriptionThe period of time during which the vaccination happened. If you specify a vaccinationperiod, you can’t specify a vaccination date.

Typereference

VaccineCodeId


DescriptionThe system-defined code that represents vaccine that was administered in the immunization.

Referenced Objects

• CodeSetBundle

292


Additional Information for PatientImmunization in Other ObjectsIn addition to creating a record using these fields, you can add more details to your PatientImmunization record by creating records incertain other objects, and referencing your PatientImmunization record as the parent record. Here’s the list of objects you can associateto PatientImmunization in this way, the type of information they add, and the field they use to reference PatientImmunization.


ParentRecordIdAssociates an identifier value to the patientimmunization.

Identifier

ParentIdAdds information about a patient’s adversereaction to an immunization, if any.

Patient Health Reaction

PatientMedicalProcedureRepresents detailed information about a healthcare procedure the patient has undergone, is undergoing or will undergo. This objectis available in API version 51.0 and later.


Fields

DetailsField

TypePolymorphic Reference

AssertionSourceId


DescriptionThe person who made the statement about the procedure.

ExampleThe patient or the provider who assessed the patient’s condition.

Referenced Objects

• Account


Typereference

ClinicalEncounterId


DescriptionThe patient’s clinical encounter that the procedure is a part of.

293


DetailsField

Referenced Objects


TypeReference

CodeId


DescriptionThe system-defined code that identifies a procedure.

ExampleThe SNOMED code for frontal sinusectomy.

Referenced ObjectCodeSetBundle

TypeString

DurationTimeString


DescriptionThe duration of the procedure in string format.

Example2 hours

TypeDateTime

EndDate


DescriptionThe date and time that the procedure ended or the end date of the estimated period withinwhich the procedure was performed.

Example1993-11-09T18:30:00.384Z

Typereference

FacilityId


DescriptionThe heathcare facility where the procedure is performed.

Referenced ObjectHealthcareFacility

294


DetailsField

TypeDateTime

LastReferencedDate


DescriptionThe date and time the last time this record was referenced.

TypeDateTime

LastViewedDate


DescriptionThe date and time the last time this record was viewed.

TypeDtring

Name


DescriptionThe name of the record. This is automatically generated when the record is saved.

ExamplePMP-7396

TypePicklist

Outcome


DescriptionSpecifies the outcome for the procedure.


• Partially successful

• Successful

• Unsuccessful

TypeMaster-Detail Reference

PatientId


DescriptionThe patient on whom the procedure was performed.

295


DetailsField

ExampleCharles Green

Referenced ObjectAccount

Typereference

PerformedAgeRangeUnitId


DescriptionThe unit of measure for the performed at age upper and lower limit fields.


Typedouble

PerformedAtAge


DescriptionThe patient’s age when the procedure was performed.

Typedouble

PerformedAtAgeLowerLimit


DescriptionThe lower limit for the range of the patient’s age when the procedure was performed

Typereference

PerformedAtAgeUnitId


DescriptionThe unit of measure for the PerformedAtAge field.


Typedouble

PerformedAtAgeUpperLimit


296


DetailsField

DescriptionThe upper limit for the range of the patient’s age when the procedure was performed

TypeReference

ReasonCodeId


DescriptionThe system-defined code that specifies the reason for the procedure.

ExampleThe SNOMED code for paraparesis.


TypeReference

ReasonReferenceId


DescriptionThe event that warranted the procedure.

Referenced Objects

• HealthCondition

• CareObservation



ExampleChronic sinusitis, a record in HealthCondition.

TypeReference

RecordCreatorId


DescriptionThe person who created the record.

Referenced Objects

• Account


ExampleDr. Carol Peterson

297


DetailsField

TypeReference

ReportId


DescriptionThe report associated with this procedure..

ExampleCharles Green’s sinusectomy report.

Referenced ObjectDiagnosticSummary

Typestring

SourceSystem



Typestring




TypedateTime




TypeDateTime

StartDate


DescriptionThe date and time that the procedure began or the start date of the estimated period withinwhich the procedure was performed.

This field can be used in two ways to indicate the date and time of the procedure:

298


DetailsField

• If you want to specify a single date as either the actual or estimated date of the procedure,enter that date and time in this field.

• If you want to specify a period in which the procedure was estimated to have happened,use this field to specify that start of the period, and the EndDate field to specify theend of the period.

Example1993-11-09T21:45:00.384Z

TypePicklist

Status


DescriptionSpecifies the status of the procedure.


• Completed


• In Progress

• Not Done

• On Hold

• Preparation

• Stopped

• Unknown

TypeReference

StatusReasonCodeId



ExampleThe SNOMED code for ‘Procedure not ordered’


TypeReference

TypeId


DescriptionThe system-defined code that specifies the procedure's type.

299


DetailsField

ExampleThe SNOMED code for ‘Surgical procedure’


Additional Information for PatientMedicalProcedure in Other ObjectsIn addition to creating a record using these fields, you can add more details to your PatientMedicalProcedure record by creating recordsin certain other objects, and referencing your PatientMedicalProcedure record as the parent record. Here’s the list of objects you canassociate to PatientMedicalProcedure in this way, the type of information they add, and the field they use to referencePatientMedicalProcedure.


ParentRecordIdSpecifies the person who performed theprocedure.

CarePerformer

ParentRecordIdAssociates an identifier value to theprocedure.

Identifier

PatientMedicalProcedureIdAssociates the procedure with various otherrecords and defines the nature of

PatientMedicalProcedureDetail

association. For instance, if the procedure isbased on, part of, or a follow up of theassociated record, and so on.


Associates records from different objects to a patient medical procedure record to add more information to the procedure record.This is a multi-object junction object. This object is available in API version 51.0 and later.

PatientMedicalProcedureDetailAssociates records from different objects to a patient medical procedure record to add more information to the procedure record. Thisis a multi-object junction object. This object is available in API version 51.0 and later.

Supported Calls


300


Fields

DetailsField


DetailCodeId


DescriptionReferences a code set or code set bundle that adds information to a patient medical procedurerecord.

Referenced Objects

• CodeSet

• CodeSetBundle


DetailRecordId


DescriptionReferences a record that adds information to a patient medical procedure record.

Referenced Objects


• CareObservation

• HealthCondition



Typepicklist

DetailType


DescriptionSpecifies the type of information added to the patient medical procedure record.


• Based On

• Body Site

• Complication

• Complication Detail

• Follow Up

• Part Of

301


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the patient medical procedure detail record.


PatientMedicalProcedureId


DescriptionThe patient medical procedure to which details are being added.

Referenced Objects


Usage

PatientMedicalProcedureDetail records add additional information to PatientMedicalProcedure records. This information may be of thefollowing types, referencing the following types of records:

• Based On: Clinical service requests

• Body Site: Code sets or code set bundles

• Complication: Code sets or code set bundles

• Complication Detail: Health conditions

• Follow Up: Code sets or code set bundles

• Part Of: Patient medical procedures or clinical observations

302


The records providing this additional information is selected using either the DetailCodeId or DetailRecordId fields, andthen the type of information is specified using the DetailType field. This information is then connected to the patient medicalprocedure record it belongs to using the PatientMedicalProcedureId field.

One record of PatientMedicalProcedureDetail can specify only one type and piece of information. If multiple detail types or detail instancesare required in the parent procedure record, multiple records of PatientMedicalProcedureDetail are required.

Associated Objects


PatientMedicalProcedureDetailFeedFeed tracking is available for the object.

PatientMedicalProcedureDetailHistoryHistory is available for tracked fields of the object.

PatientMedicationDosageRepresents dosage information for medication. This object is primarily used to add dosage information in MedicationStatement,MedicationRequest, or MedicationDispense records. This object is available in API version 51.0 and later.



Fields

DetailsField

Typetextarea

AdditionalInstruction


DescriptionThe supplemental instructions or warnings associated with the medication for the patient.

Typestring

Comments


DescriptionThe comments associated with the medication dosage for the patient.

303


DetailsField

Typepicklist

DosageDefinitionType


DescriptionSpecifies how the dosage was determined.


• Calculated

• Ordered

Typedouble

DosageQuantityDenominator


DescriptionThe denominator value for the quantity of medication per dose. This field can be used torecord a simple quantity or a quantity range.

Typedouble

DosageQuantityNumerator


DescriptionThe numerator value for the quantity of medication per dose. This field can be used to recorda simple quantity or a quantity range.

TypeStatic picklist

DosageQuantityType


DescriptionSpecifies the type of dosage quantity recorded in DosageQuantityNumerator andDosageQuantityDenominator.


• Dose

• Dose Range

Typedouble

DosageRateDenominator


304


DetailsField

DescriptionThe denominator value for the rate of medication in the dosage. That is, amount of medicationper unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range.

Typedouble

DosageRateNumerator


DescriptionThe numerator value for the rate of medication in the dosage. That is, amount of medicationper unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range.

Typepicklist

DosageRateType


DescriptionSpecifies the type of dosage rate recorded in DosageRateNumerator andDosageRateDenominator.


• Frequency

• Frequency Range

• Frequency Ratio

Typereference

DosageRateUnitId


DescriptionThe unit of the dosage rate recorded using DosageRateNumerator andDosageRateDenominator.

Referenced Objects

• UnitOfMeasure

Typereference

DosageUnitId


DescriptionThe unit of the dosage rate recorded using DosageQuantityNumerator andDosageQuantityDenominator.

305


DetailsField

Referenced Objects

• UnitOfMeasure

Typereference

DosePrerequisiteId


DescriptionThe system-defined code that represents the conditions that are to be met for the dosageto be taken.

Referenced Objects

• CodeSetBundle

Typeboolean

IsAsNeeded


DescriptionIndicates whether the medication is taken on an as-needed basis.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MethodId


DescriptionThe system-defined code that represents the method of dosage adminisitration.

306


DetailsField

Referenced Objects

• CodeSetBundle

Typestring

Name


DescriptionThe system-generated name of the PatientMedicationDosage record.

TypeMaster-detail polymorphic reference

ParentRecordId


DescriptionThe MedicationStatement, MedicationRequest, or the MedicationDispense record that thePatientMedicationDosage record belongs to.

Referenced Objects

• MedicationDispense—This value is available in API version 55.0 and later.



Typetextarea

PatientInstruction


DescriptionThe patient or consumer instructions associated with this medication.

Typereference

RouteId


DescriptionThe system-defined code that represents the route of dosage adminisitration.

Referenced Objects

• CodeSetBundle

Typedouble

Sequence

307


DetailsField


DescriptionThe position of this medication in the sequence of medications prescribed to a patient.

Typereference

SiteId


DescriptionThe system-defined code that represents the site of dosage adminisitration.

Referenced Objects

• CodeSetBundle

Typestring

SourceSystem


DescriptionThe source system from where the dosage record was brought into Health Cloud.

Typestring



DescriptionThe identifier of the dosage record in its source system.

TypedateTime



DescriptionThe date and time when the dosage record was last modified in its source system.

Typereference

TimingId


DescriptionThe timing information for when and how frequent the medication dosage should be taken.

308


DetailsField

Referenced Objects

• ActivityTiming

UsagePatientMedicationDosage records are used to add more dosage-related information to MedicationStatement, MedicationRequest, andMedicationDispense records. The PatientMedicationDosage record is associated to the MedicationStatement, MedicationRequest, andMedicationDispense records using the ParentRecordId field.

PersonLanguageRepresents the use and preference information about a person’s language. This object is available in API version 51.0 and later.



Fields

DetailsField


IndividualId


DescriptionThe person who speaks the language.

Referenced Objects

• Individual

• Account

• Contact

Typepicklist

Language


DescriptionSpecifies the language spoken by the person.

309


DetailsField


• English

• Spanish

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionA system-generated name for the PersonLanguage record.

Typeint

Rank


DescriptionThe preference rank for a particular langauge for a particular person.

UsagePersonLanguage is a data type-like object that’s associated to different objects representing people. The language a person speaksis associated to that person by referencing their account, contact, or individual records using the IndividualId field onPersonLanguage.

PersonNameRepresents detailed information about a person’s name. This object is available in API version 51.0 and later.

310




Fields

DetailsField

Typedate

EffectiveDate


DescriptionThe date from when the name is in effect.

Typedate

EndDate


DescriptionThe date from when the name is no longer in use.

Typestring

FirstName


DescriptionThe first name of the person.

Typestring

FullName


DescriptionThe combination of the first and last names of the person.

Typeboolean

IsPrimary


311


DetailsField

DescriptionIndicates whether the name is the person’s primary name.

Typestring

LastName


DescriptionThe person’s last name. In case the person’s name has more than just a first name and a lastname, this field stores the combination of all names except the first name.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the PersonName record.

Typepicklist

NameUsageType


DescriptionSpecifies the usage context of the name.


• Anonymous

• Maiden

312


DetailsField

• Nickname

• Official

• Old

• Temp

• Usual


ParentRecordId


DescriptionReferences the person the name belongs to.

Referenced Objects

• Account

• Contact

Typestring

Prefix


DescriptionThe prefix of the person’s name.

Typestring

SourceSystem


DescriptionThe source system from where the PersonName record was brought into Health Cloud.

Typestring



DescriptionThe identifier of the person name record in its source system.

TypedateTime



313


DetailsField

DescriptionThe date and time when the person name record was last modified in its source system.

Typestring

Suffix


DescriptionThe suffix of the person’s name.

UsagePersonName is a data type-like object that’s associated to different objects representing people. The names and name-related informationof a person are associated to them by referencing their account, contact, or individual records using the ParentRecordId field onPersonName.

Code Sets for Diagnosis and Procedure

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.

314

Code Sets for Diagnosis and ProcedureHealth Cloud Developer Guide

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.


Fields

DetailsField Name

Typepicklist

Category


Description

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

Typestring

Code


Description

Industry-standard diagnosis code.

Typestring

CodeDescription


Description

Description of the diagnosis code.

Typepicklist

CodeType


315


DetailsField Name

Description

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

Typedate

EffectiveDate


Description

Start date for the code.

Typedate

EndDate


Description

End date for the code.

Typepicklist

Gender


Description

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

Typeboolean

IsActive


Description

Indicates whether the diagnosis code is available for use.

Typeboolean

IsComplicationOrComorbidity


Description

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

316


DetailsField Name

Typeboolean

IsHospitalAcquiredCondition


Description

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

Typeboolean

IsMajorComplicationOrComorbidity


Description

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

Typeboolean

IsPresentOnAdmissionExempt


Description

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

Typeboolean

IsPrimaryDiagnosis


Description

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

Typeboolean

IsUnacceptablePrincipalDxIpAdmit


Description

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

317


DetailsField Name

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


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 as(E08.37X9 - Diabetes mellitus due to underlying condition).

Typereference

OwnerId






Refers ToGroup, User

318


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.


Fields

DetailsField Name

Typepicklist

Category


Description

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

Typestring

Code


Description

Industry standard procedure code such as CPT or HCPCS.

Typestring

CodeDescription


Description

Description of the procedure code.

319


https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm

DetailsField Name

Typestring

CodeShortDescription


Description

Short description of the procedure code.

Typepicklist

CodeType


Description

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

Typedate

EffectiveDate


Description

Start date for the code.

Typedate

EndDate


Description

End date for the code.

Typeboolean

IsActive


Description

Indicates whether the diagnosis code is available for use.

TypedateTime

LastReferencedDate


320


DetailsField Name

Description

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

TypedateTime

LastViewedDate


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


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


Description

The ID of the user who owns this record.






321

HealthCareProcedureHistoryHistory is available for tracked fields of the object.

HealthCareProcedureOwnerSharingRuleSharing rules are available for the object.

HealthCareProcedureShareSharing is available for the object.

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

Note:

• Starting with the Winter ’23 release, new customers won’t be able to create records in the packaged EHR objects that havecounterpart standard objects in the FHIR R4-aligned data model.

• All future development in Health Cloud will be built on the FHIR R4-aligned data model. The packaged objects in the EHR datamodel won’t be used for future development.

Mapping the EHR Data Model to the Clinical Data Model

Certain objects in the EHR data model are succeeded by objects in the Clinical data model. Here 's how those objects in the EHRdata model map to objects and fields in the Clinical data model.

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.

322

Electronic Health RecordsHealth Cloud Developer Guide




EhrDosageInstruction__c

Represents instructions for how a medication is to be used by a patient.

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.

323


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.

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:


Mapping the EHR Data Model to the Clinical Data ModelCertain objects in the EHR data model are succeeded by objects in the Clinical data model. Here 's how those objects in the EHR datamodel map to objects and fields in the Clinical data model.

EhrAllergyIntolerance__c to AllergeyIntolerance

Fields in EhrAllergyIntolerance__c map to AllergyIntolerance and PatientHealthReaction in the Clinical data model.

EhrCondition__c to HealthCondition

Fields in EhrCondtion__c map to HealthCondition in the Clinical data model. Certain fields are mapped to HealthConditionDetailand other child objects.

EhrDevice__c to CareRegisteredDevice and Asset

Fields in EhrDevice__c map to CareRegisteredDevice and Asset in the Clinical data model.

EhrDosageInstruction__c to PatientMedicationDosage

Fields in EhrDosageInstruction__c map to PatientMedicationDosage in the Clinical data model.

EhrEncounter__c to ClinicalEncounter

Fields in EhrEncounter__c map to ClinicalEncounter and its child objects in the Clinical data model.

EhrEncounterParticipant__c to ClinicalEncounterProvider

Fields in EhrEncounterParticipant__c map to ClinicalEncounterProvider and its child objects in the Clinical data model.

EhrImmunization__c to PatientImmunization

Fields in EhrImmunization__c map to PatientImmunization in the Clinical data model.

324


EhrVaccinationProtocol__c to Patient Immunization

Fields in EhrVaccinationProtocol__c map to PatientImmunization in the Clinical data model.

EhrImmunizationReaction__c to PatientHealthReaction

Fields in EhrImmunizationReaction__c map to PatientHealthReaction in the Clinical data model.

EhrMedicationPrescription__c to MedicationRequest

Fields in EhrMedicationPrescription__c map to MedicationRequest in the Clinical data model.

EhrMedicationStatement__c to MedicationStatement

Fields in EhrMedicationStatement__c map to MedicationStatement in the Clinical data model.

EhrObservation__c to CareObservation

Fields in EhrObservation__c map to CareObservation in the Clinical data model.

EhrRelatedObservation__c to CareOberservationComponent

Fields in EhrRelatedObservation__c map to CareOberservationComponent in the Clinical data model.

EhrPatient__c to Person Account

Fields in EhrPatient__c map to Account and Contact in the Clinical data model.

EhrPatientCareProvider__c to ContactContactRelation__c

Fields in EhrPatientCareProvider__c map to ContactContactRelation__c in the Clinical data model.

EhrPatientContact__c to ContactContactRelation__c

Fields in EhrPatientContact__c map to Account and Contact (Person Accounts) through ContactContactRelation__c in the Clinicaldata model. EhrRelatedPerson__c is also mapped this way.

EhrPractitioner__c to PersonAccount and HealthcareProvider and PersonAccount

Fields in EhrPractitioner__c map to Person Accounts and HealthcareProvider in the Clinical data model.

EhrPractitionerQualification__c to BoardCertification

Fields in EhrPractitionerQualification__c map to BoardCertification in the Clinical data model.

EhrPractitionerRole__c to HealthcarePractitionerFacility

Fields in EhrPractitionerRole__c map to HealthcarePractitionerFacility and CareProviderFacilitySpecialty in the Clinical data model.

EhrProcedure__c to PatientMedicalProcedure

Fields in EhrProcedure__c map to PatientMedicalProcedure and its child object in the Clinical data model.

EhrProcedurePerformer__c to CarePerformer

Fields in EhrProcedurePerformer__c map to CarePerformer in the Clinical data model. CarePerformer referencesPatientMedicalProcedure as its parent.

EhrProcedureRequest__c to ClinicalServiceRequest

Fields in EhrProcedureRequest__c map to ClinicalServiceRequest and its child object in the Clinical data model.

EhrAllergyIntolerance__c to AllergeyIntoleranceFields in EhrAllergyIntolerance__c map to AllergyIntolerance and PatientHealthReaction in the Clinical data model.

NotesClinical Data Model FieldDescriptionEhrAllergyIntolerance__cField

N/AAllergyIntolerance.PatientId

The individual account thatrepresents the patient inLightning Platform.

Account__c

325



While EhrAllergyIntolerance__cuses a flattened code field that’s

AllergyIntolerance.Severity

The system-defined codethat represents an estimateof the potential clinical harm

CriticalityCode__c

split into a set of three text fields,or seriousness of the AllergyIntolerance uses a single

picklist field instead.reaction to the identifiedsubstance.

The human-readable labelthat represents an estimate

CriticalityLabel__c

of the potential clinical harmor seriousness of thereaction to the identifiedsubstance.

The system that defines anestimate of the potential

CriticalitySystem__c

clinical harm or seriousnessof the reaction to theidentified substance.

N/ANot SupportedIndicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

N/ANot SupportedIndicates whether or not thisfield appears on the patientcard.

IsVisibleOnPatientCard__c

N/AAllergyIntolerance.Name

The EHR allergy intoleranceID. Limit: 255 characters.

Name

N/AAllergyIntolerance.PatientId

The patient who has thesensitivity. Lookup toEhrPatient__c.

Patient__c

N/APatientHealthReaction.Details

A description of the allergicreaction, including details ofthe manifestation if

Reaction255__c

required. Limit: 255characters.

The clinical data model fieldsupports only up to 255characters.

Not supported.A long text description ofthe allergic reaction,including details of themanifestation if required.

Reaction__c

326



N/AAllergyIntolerance.RecordCreationDateTime

The date when thesensitivity was recorded.

RecordedDate__c

The PersonName recordassociated to the person

PersonName.FullNameThe name of the individualwho recorded the record

RecorderName255__c

account representing theindividual.

and takes responsibility forits content. Limit: 255characters.

The long text description ofthe name of the individual

RecorderName__c

who recorded the recordand takes responsibility forits content.

EhrAllergyIntolerance referencesEhrPractitioner, Allergy

AllergyIntolerance.RecordCreatorId

The individual who takesresponsibility for the contentand can reference its source.

Recorder__c

Intolerance references Accountand HealthcareProvider.Lookup to

EhrPractitioner__c.

Sensitivity is not specified as perFHIR R4. Consider creating a

Not SupportedAn observation thatconfirms or refutes the

SensitivityTest1__c

custom field that references Carepatient’s sensitivity. Lookupto EhrObservation__c. Observation if your organization

needs to record this information.An observation thatconfirms or refutes the

SensitivityTest2__c

patient’s sensitivity. Lookupto EhrObservation__c.

An observation thatconfirms or refutes the

SensitivityTest3__c

patient’s sensitivity. Lookupto EhrObservation__c.

Sensitivity is not specified as perFHIR R4. Consider creating a

Not SupportedThe system-defined codethat represents the patient’ssensitivity.

SensitivityTypeCode__c

custom field that referencesCodeSetBundle if your

The human-readable labelthat represents the patient’ssensitivity

SensitivityTypeLabel__c

organization needs to record thisinformation.

The system that defines thepatient’s sensitivity

SensitivityTypeSystem__c

327



N/AAllergyIntolerance.SourceSystem

The external system ofrecord for the allergyintolerance.

SourceSystem__c

N/AAllergyIntolerance.SourceSystemIdentifier

The ID of the record in thesource system.

SourceSystemId__c

N/AAllergyIntolerance.SourceSystemModified

The date and time when therecord was last modified inthe source system.


While EhrAllergyIntolerance__cuses a flattened code field that’s

AllergyIntolerance.Status

The system-defined codethat represents the level ofcertainty associated with the

StatusCode__c

split into a set of three text fields,potential risk of a reaction tothe identified substance.

AllergyIntolerance uses a singlepicklist field instead.

The human-readable labelthat represents the level of

StatusLabel__c

certainty associated with thepotential risk of a reaction tothe identified substance.

The system that defines thelevel of certainty associated

StatusSystem__c

with the potential risk of areaction to the identifiedsubstance.

AllergyIntolerance uses a lookupto CodeSetBundle to represent

AllergyIntolerance.CausativeSubstanceId

The substance or class ofsubstances that’s consideredresponsible for the adverse

Substance255__c

substances as CodeableConceptdata.reaction risk. Limit: 255

characters.

The long text description ofthe substance or class of

SubstanceLong__c

substances that’s consideredresponsible for the adversereaction risk.

The system-defined codethat represents the

SubstanceCode__c

substance responsible forthe reaction.

328



The system that defines thecode that represents the

SubstanceCodeSystem__c

substance that caused thereaction.

EhrCondition__c to HealthConditionFields in EhrCondtion__c map to HealthCondition in the Clinical data model. Certain fields are mapped to HealthConditionDetail andother child objects.

Mapping

NotesClinical Data Model FieldDetailsField

EhrCondition__c uses a textfield, HealthCondition uses a set

HealthCondition.AbatementStartDateTime

The date or estimated datewhen the condition wasresolved or went intoremission. Limit: 255characters.

AbatementDetail255__c

of two date time fields to specifyeither a date or a period.

HealthCondition.AbatementEndDateTime

EhrCondition__c uses a textfield, HealthCondition uses a set

HealthCondition.AbatementStartDateTime

The long text description ofthe date or estimated datewhen the condition wasresolved or went intoremission.

AbatementDetail__c

of two date time fields to specifyeither a date or a period.

HealthCondition.AbatementEndDateTime

N/AHealthCondition.PatientId

The individual account thatrepresents the patient inLightning Platform.

Account__c

AllergyIntolerance uses apolymorphic lookup that can

HealthCondition.AssertionSourceId

The person who asserts thecondition.

AsserterPatient__c

reference either a personThe person reporting thecondition.

AsserterPractitioner__c

account (a patient) or ahealthcare provider(practitioner) record.

While EhrCondition__c uses aflattened code field that’s split

HealthCondition.TypeThe system-defined codethat represents the category

CategoryCode__c

into a set of three text fields,that’s assigned to theHealthCondition uses a singlepicklist field instead.

condition. Examples ofcategories are complaint,symptom, and diagnosis.

The human-readable labelthat represents the category

CategoryLabel__c

329



that’s assigned to thecondition. Examples ofcategories are complaint,symptom, and diagnosis.

The system that defines thecategory that’s assigned to

CategorySystem__c

the condition. Examples ofcategories are complaint,symptom, and diagnosis.


HealthCondition.DiagnosticStatus

The system-defined codethat represents level ofconfidence that thecondition is correct.

CertaintyCode__c

into a set of three text fields,HealthCondition uses a singlepicklist field instead.

The human-readable labelthat represents the certaintyof a correct condition.

CertaintyLabel__c

The system that defines thecertainty.

CertaintySystem__c


HealthCondition.ConditionCodeId

The system-defined codethat represents thecondition, problem, ordiagnosis.

Code__c

into a set of three text fields,HealthCondition uses a singlepicklist field instead.

The human-readable labelthat represents the

CodeLabel__c

condition, problem, ordiagnosis.

The system that defines thecondition, problem, ordiagnosis.

CodeSystem__c

N/AHealthCondition.RecordCreationDateTime

The estimated or actual datewhen the condition,problem, or diagnosis wasfirst detected or suspected.

DateAsserted__c

While EhrCondition__creference EhrEncounter__c,

HealthCondition.ClinicalEncounterId

The encounter during whichthe condition was firstasserted. Lookup toEhrEncounter__c.

Encounter__c

HealthCondition referencesClinicalEncounter.

330



FHIR R4 says that evidences forconditions can be representedusing observations.

Can be supported by adding areference to CareObservation.

The system-defined codethat represents themanifestation or symptomthat led to the recording of

EvidenceCode__c

this condition. Evidence canbe a simple list of codedsymptoms ormanifestations, or referencesto observations or formalassessments, or both.

A long text description ofsupporting information suchas pathology reports.

EvidenceDetail__c


EvidenceLabel__c

manifestation or symptomthat led to the recording ofthis condition. Evidence canbe a simple list of codedsymptoms ormanifestations, or referencesto observations or formalassessments, or both.

The system that defines themanifestation or symptom

EvidenceSystem__c

that led to the recording ofthis condition. Evidence canbe a simple list of codedsymptoms ormanifestations, or referencesto observations or formalassessments, or both.

Abatement is a subset of thepotential statuses of a condition.

HealthCondition.ConditionStatus

Whether the condition isresolved or in remission(true) or not (false). The

IsAbated__c

default checkbox value isdeselected.

N/ANot supported.Indicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

331



N/ANot supported.Indicates whether or not thisfield appears on the patientcard.


Supported through the childobject HealthConditionDetail

HealthConditionDetailThe system-defined codethat represents the

LocationCode__c

that associates HealthConditionanatomical location wherethe condition is manifested. records with codes that

represent body sites.A long text description withprecise details about the

LocationDetail__c

anatomical location wherethe condition is manifested.


LocationLabel__c

anatomical location wherethe condition is manifested.

The system that defines theanatomical location wherethe condition is manifested.

LocationSystem__c

N/AHealthCondition.NameThe EHR condition ID. Limit:255 characters.

Name

Supported through the childobject AuthorNote.

AuthorNoteAdditional informationabout the condition,including general comments

Notes__c

about the description of thecondition, its diagnosis, andprognosis.

HealthCondition supportsspecifying either a specific date,or a period.

HealthCondition.OnsetStartDateTime

The estimated or actual dateor date-time when thecondition began, in theclinician’s opinion. Age is

Onset__c

HealthCondition.OnsetEndDateTimetypically used when the

patient reports an age whenthe condition began.

N/AHealthCondition.PatientId

The patient’s name. Lookupto EhrPatient__c.

Patient__c


HealthCondition.Severity

The system-defined codethat represents a subjectiveassessment of the

SeverityCode__c

into a set of three text fields,condition’s severity as

332



evaluated by the clinician.Where possible, coding of

HealthCondition uses a singlepicklist field instead.

the severity with aterminology is preferred.

The human-readable labelthat represents a subjective

SeverityLabel__c

assessment of thecondition’s severity asevaluated by the clinician.Where possible, coding ofthe severity with aterminology is preferred.

The system that defines asubjective assessment of the

SeveritySystem__c

condition’s severity asevaluated by the clinicianWhere possible, coding ofthe severity with aterminology is preferred.

N/AHealthCondition.SourceSystem

The external system ofrecord.

SourceSystem__c

N/AHealthCondition.SourceSystemIdentifier


SourceSystemId__c

N/AHealthCondition.SourceSystemModified



HealthCondition uses a lookupto CodeSetBundle to represent

HealthCondition.StageId

A condition’s clinical stageor grade, including asummary (such as “Stage 3”)

Stage__c

the stage as CodeableConceptdata.or assessment (a reference

to a formal record of theevidence on which thestaging assessment isbased). The determinationof the stage isdisease-specific. Can includeformal severity assessments.


HealthCondition.ConditionStatus

The system-defined codethat represents thecondition’s clinical status.

StatusCode__c

into a set of three text fields,

333



HealthCondition uses a singlepicklist field instead.

The human-readable labelthat represents thecondition’s clinical status.

StatusLabel__c

The system that defines thecondition’s clinical status.

StatusSystem__c

EhrDevice__c to CareRegisteredDevice and AssetFields in EhrDevice__c map to CareRegisteredDevice and Asset in the Clinical data model.

Fields


The field in the Clinical datamodel is a lookup to Account,

Asset.AssetServicedByDescriptionA long text description ofthe contact details for an

Contact__c

while the EHR data model fieldis a text field.organization or person

who’s responsible forsupport for the device.

N/AAsset.Product2Id.DisplayUrl

DescriptionA long text description ofthe network address on

DeviceURL__c

which the device can bedirectly contacted.

Asset.UsageEndDateDescriptionThe date and time afterwhich this device is not validor should not be used.

Expiry__c

N/ANot SuppotedDescriptionIndicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

N/ANot SuppotedDescriptionIndicates whether or not thisfield appears on the patientcard.


334



N/ANot SuppotedDescriptionWhere the device is found.Can be a literal location (for

Location255__c

example, GPS coordinates),a logical place (for example,“with the patient”), or acoded location. Limit: 255characters.

N/ANot SuppotedDescriptionA long text description ofwhere the device is found.

Location__c

Can be a literal location (forexample, GPS coordinates),a logical place (for example,“with the patient”), or acoded location.

Even though lot number is notsupported, the Clinical data

Not SuppotedDescriptionA lot number assigned bythe manufacturer.

LotNumber__c

model supports serial numbersusing the Asset.SerialNumber field.

The Clinical data model field is alookup to Account while the EHRdata model field is a stringn field.

Asset.AssetProviderByDescriptionThe name of the device’smanufacturer.

Manufacturer__c

N/AAsset.ProductCodeDescriptionAn identifier that’s assignedby the manufacturer to

Model__c

identify the product by itstype. This number is sharedby the all devices that aresold as the same type.

ID values are recommended tobe stored using the Identifierobject.

CareRegisteredDevice.Name

DescriptionThe EHR device ID. Limit: 255characters.

Name


Asset.AssetServicedByDescriptionThe organization that’sresponsible for the provision

Owner255__c

while the EHR data model fieldis a text field.and maintenance of the

device. Limit: 255 characters.

335




Asset.AssetServicedByDescriptionThe long text description ofthe organization that’s

Owner__c

while the EHR data model fieldis a text field.responsible for the provision

and maintenance of thedevice.

The clinical data model fieldreferences a Person Account.

CareRegisteredDevice.PatientId

DescriptionThe patient’s name. Lookupto EhrPatient__c.

Patient__c

N/ACareRegisteredDevice.SourceSystemIdentifier


SourceSystemId__c

N/ANot supportedThe date and time when therecord was last modified inthe source system.


The Clinical data model field is areference to a code set while the

CareRegisteredDevice.DeviceTypeId

DescriptionThe type of device.

Type__c

EHR data model field is a stringfield.

The Clinical data model supportsspecifying up to 3 UDIs for a

CareRegisteredDevice.UniqueDeviceId1, Care

DescriptionThe United States Food andDrug

Udi__c

device, with the supportedmetadata types being the deviceidentifier and device issuer.

RegisteredDevice.UniqueDeviceId2, andCareRegisteredDevice.UniqueDeviceId3

Administration-mandatedUnique Device Identifier(UDI). Use the

CareRegisteredDevice.UniqueDeviceId1

human-readableinformation (the contentthat the user sees, which Issuer, CareRegisteredsometimes differs from the Device.UniqueDevicesyntax in the barcode). The Id2Issuer, and Careunique identifier can identify RegisteredDevicean instance of a device .UniqueDevice

Id3Issueruniquely or just identify thetype of the device. The DIpart can be extracted fromthe UDI when required andused to find informationabout the device throughthe GUDID.

336



N/ANot supportedDescriptionThe version of the device, ifthe device has multiple

Version__c

releases under the samemodel, is software, or carriesfirmware.

EhrDosageInstruction__c to PatientMedicationDosageFields in EhrDosageInstruction__c map to PatientMedicationDosage in the Clinical data model.

Mapping


N/APatientMedicationDosage.AdditionalInstruction

DescriptionAdditional dosageinstructions such as “Takewith food.”

AdditionalInstruction__c

N/ANot SupportedDescriptionThe system-defined codethat represents additionaldosage instructions.

AdditionalInstructionCode__c

DescriptionThe human-readable labelthat represents additionaldosage instructions.

AdditionalInstructionLabel__c

DescriptionThe system that definesadditional dosageinstructions.

AdditionalInstructionSystem__c

N/APatientMedicationDosage.IsAsNeeded

DescriptionWhether a medication istaken only when needed

AsNeeded__c

within the specifiedschedule (true) or at everyscheduled dose (false).The default checkbox valueis deselected.

337



N/ANot SupportedDescriptionThe system-defined codethat represents whether a

AsNeededCode__c

medication is taken onlywhen needed within thespecified schedule ratherthan at every scheduleddose.

DescriptionThe human-readable labelthat represents whether a

AsNeededLabel__c

medication is taken onlywhen needed within thespecified schedule ratherthan at every scheduleddose.

DescriptionThe system that defineswhether a medication is

AsNeededSystem__c

taken only when neededwithin the specifiedschedule rather than atevery scheduled dose.

N/APatientMedicationDosage.DosageUnitId

DescriptionThe unit of measurement inthe amount of medicationthat was dispensed.

DoseQuantityUnit__c

N/APatientMedicationDosage.DosageQuantityNumerator

DescriptionThe amount of medicationthat was dispensed.

DoseQuantityValue__c

PatientMedicationDosage.DosageQuantityDenominator

In the clinical data model andFHIR R4, dosage is defined for a

Not SupportedDescriptionThe individual receivinghealthcare services.

EhrPatient__c

medication statement, and thenthat statement is connected tothe patient. There is no directreference between a dosage anda patient.

338



N/APatientMedicationDosage.PatientInstruction

DescriptionA long text description ofhow a medication is to beused by a patient.

Instruction__c

N/ANot SupportedDescriptionIndicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

N/ANot SupportedDescriptionIndicates whether or not thisfield appears on the patientcard.


N/APatientMedicationDosage.DosageUnitId

DescriptionThe unit of measurement inthe maximum total quantity

MaxDosePerPeriodAmountUnit__c

of a therapeutic substancethat can be administered toa subject over a period oftime.

N/ANot SupportedDescriptionThe maximum total quantityof a therapeutic substance

MaxDosePerPeriodAmountValue__c

that can be administered toa subject over a period oftime.

N/ANot SupportedDescriptionThe unit of measurement inthe denominator of the

MaxDosePerPeriodDenominatorUnit__c

maximum total quantity ofa therapeutic substance thatcan be administered to asubject over a period oftime.

N/ANot SupportedDescriptionThe denominator in themaximum total quantity of

MaxDosePerPeriodDenominatorValue__c

a therapeutic substance thatcan be administered to a

339



subject over a period oftime.

N/ANot SupportedDescriptionThe unit of measurement inthe numerator of the

MaxDosePerPeriodNumeratorUnit__c

maximum total quantity ofa therapeutic substance thatcan be administered to asubject over a period oftime.

N/ANot SupportedDescriptionThe numerator in themaximum total quantity of

MaxDosePerPeriodNumeratorValue__c

a therapeutic substance thatcan be administered to asubject over a period oftime.

N/ANot SupportedDescriptionThe unit of measurement oftime in the maximum total

MaxDosePerPeriodTimeUnit__c

quantity of a therapeuticsubstance that can beadministered to a subjectover a period of time.

N/ANot SupportedDescriptionThe time value in themaximum total quantity of

MaxDosePerPeriodTimeValue__c

a therapeutic substance thatcan be administered to asubject over a period oftime.

N/APatientMedicationDosage.ParentRecordId

DescriptionAn order for supply of amedication and the

MedicationPrescription__c

instructions foradministration of themedicine to a patient.Lookup toEhrMedicationPrescription__c.

340



N/APatientMedicationDosage.ParentRecordId

DescriptionA record of the medicationthat the patient takes or that

MedicationStatement__c

was given to the patient,where the record is theresult of a report from thepatient or another clinician.Lookup toEhrMedicationStatement__c.

The clinical data model uses acode set reference to specifymethod.

PatientMedicationDosage.MethodId

DescriptionThe system-defined codethat represents the method

MethodCode__c

by which a medication isintroduced into or onto thebody, most commonly usedfor injections.

DescriptionThe human-readable labelthat represents the method

MethodLabel__c

by which a medication isintroduced into or onto thebody, most commonly usedfor injections.

DescriptionThe system that defines themethod by which a

MethodSystem__c

medication is introducedinto or onto the body, mostcommonly used forinjections.

In the clinical data model, thename field is an autonumberfield.

PatientMedicationDosage.Name

DescriptionThe EHR dosage instructionID. Limit: 255 characters.

Name

N/APatientMedicationDosage.DosageRateDenominator

DescriptionThe denominator in thespeed at which the

RateDenominator__c

substance is introduced intothe subject, typically the ratefor an infusion. An examplerate is 200ml in 2 hours.

341



N/APatientMedicationDosage.DosageRateNumerator

DescriptionThe numerator in the speedat which the substance is

RateNumerator__c

introduced into the subject,typically the rate for aninfusion. An example rate is200ml in 2 hours.

The clinical data model uses acode set reference to specifyroute.

PatientMedicationDosage.RouteId

DescriptionThe system-defined codethat represents the route or

RouteCode__c

physiological path ofadministration of atherapeutic agent into oronto a subject.

DescriptionThe human-readable labelthat represents the route or

RouteLabel__c

physiological path ofadministration of atherapeutic agent into oronto a subject.

DescriptionThe system that defines theroute or physiological path

RouteSystem__c

of administration of atherapeutic agent into oronto a subject.

The clinical data model uses acode set reference to specify site.

PatientMedicationDosage.SiteId

DescriptionThe system-defined codethat specifies the anatomic

SiteCode__c

site where the medicationfirst enters the body.

DescriptionThe human-readable labelthat specifies the anatomic

SiteLabel__c

site where the medicationfirst enters the body.

342



DescriptionThe system that defines theanatomic site where the

SiteSystem__c

medication first enters thebody.

N/APatientMedicationDosage.SourceSystem


SourceSystem__c

N/APatientMedicationDosage.SourceSystem



N/APatientMedicationDosage.SourceSystemIdentifier


SupplementalInstructions__c

Timing information specifiedusing ActivityTiming

ActivityTimingDescriptionThe defined period of time.

TimingPeriod__c

records that reference the

DescriptionThe last day of the timeperiod.

TimingPeriodEnd__c PatientMedicationDosage record as their parentrecord.

DescriptionThe first day of the timeperiod.

TimingPeriodStart__c

EhrEncounter__c to ClinicalEncounterFields in EhrEncounter__c map to ClinicalEncounter and its child objects in the Clinical data model.

Mapping


N/AClinicalEncounter.PatientId

DescriptionThe individual account thatrepresents the patient inLightning Platform.

Account__c

N/AClinicalEncounter.Category

DescriptionThe classification of theencounter. Examples include

Class__c

inpatient, outpatient,ambulatory, and emergency.

343



N/AClinicalEncounter.RelatedClinicalEncounterId

DescriptionThe name of the interactionduring which services are

Encounter__c

provided to the patient.Lookup to EhrEncounter__c.

While the EHR data modaldefines this information as a

ClinicalEncounter.AdmissionSource

DescriptionThe system-defined codethat represents the source

HospitalizeAdmitSourceCode__c

code, the Clinical data modelimplementation is a picklist.from which the patient was

admitted. Examples ofsources include physicianreferral and transfer.

DescriptionThe human-readable labelthat represents the source

HospitalAdmitSourceLabel__c

from which the patient wasadmitted. Examples ofsources include physicianreferral and transfer.

DescriptionThe system that defines thesource from which the

HospitalizeAdmitSourceSystem__c

patient was admitted.Examples of sources includephysician referral andtransfer.

The Clinical data modelimplementations supports

ClinicalEncounter.DestinationFacilityId,

DescriptionThe location to which thepatient is discharged.

HospitalizeDestination__c

references to bothHealthcareFacility and Accountfor this value.ClinicalEncounter.



ClinicalEncounter.DietPreference

DescriptionThe system-defined codethat represents diet

HospitalizeDietCode__c

code, the Clinical data modelimplementation is a multi-selectpicklist.

preferences that the patientreports.

344



DescriptionThe human-readable labelthat represents diet

HospitalizeDietLabel__c

preferences that the patientreports. Diet preferencesinclude medical, cultural,and ethical food preferencesto help with cateringrequirements.

DescriptionThe system that defines dietpreferences that the patient

HospitalizeDietSystem__c

reports. Diet preferencesinclude medical, cultural,and ethical food preferencesto help with cateringrequirements.

N/ANot supportedDescriptionA long text description ofthe final diagnosis that a

HospitalizeDischargeDiagnosis__c

patient receives beforerelease from the hospitalafter all testing, surgery, andworkup are completed.


ClinicalEncounter.DischargeDispositionId

DescriptionThe system-defined codethat represents the category

HospitalizeDischargeDispositionCode__c

code, the Clinical data modelimplementation is a picklist.or kind of patient location

after discharge.

DescriptionThe human-readable labelthat represents the category

HospitalizeDischargeDispositionLabel__c

or kind of patient locationafter discharge.

DescriptionThe system that defines thecategory or kind of patientlocation after discharge.

HospitalizeDischargeDispositionSystem__c

345



The Clinical data modelimplementations supports

ClinicalEncounter.PreviousFacilityId

DescriptionThe location from which thepatient came beforeadmission.

HospitalizeOrigin__c

references to bothHealthcareFacility and Accountfor this value.

ClinicalEncounter.PreviousOrganizationId

N/AClinicalEncounter.EndDate

DescriptionThe last day when thespecified participant was

HospitalizePeriodEnd__c

present during theencounter. Periods canoverlap or be subsets of theoverall encounters period.

N/AClinicalEncounter.StartDate

DescriptionThe first day when thespecified participant was

HospitalizePeriodStart__c

present during theencounter. Periods canoverlap or be subsets of theoverall encounters period.

Identifier values are representedas child records in Clinical


DescriptionAn identifier forhospitalizationpre-admission.

HospitalizePreAdmissionId__c

EncounterIdentifierthat reference the ClinicalEncounter record as theparent record.

N/AClinicalEncounter.ReadmissionCodeId

DescriptionWhether this hospitalizationis a readmission (true) or

HospitalizeReadmission__c

not (false). The defaultcheckbox value isdeselected.

N/ANot supportedDescriptionThe system-defined codethat represents special

HospitalizeSpecialArrangementCode__c

arrangements such as awheelchair, translator, orstretcher.

DescriptionThe human-readable labelthat represents special

HospitalizeSpecialArrangementLabel__c

346



arrangements such as awheelchair, translator, orstretcher.

DescriptionThe system that definesspecial arrangements such

HospitalizeSpecialArrangementSystem__c

as a wheelchair, translator,or stretcher.


ClinicalEncounter.SpecialCourtesy

DescriptionThe system-defined codethat represents a special

HospitalizeSpecialCourtesyCode__c

code, the Clinical data modelimplementation is a picklist.courtesy such as a courtesy

that’s extended to a boardmember or VIP.

DescriptionThe human-readable labelthat represents a special

HospitalizeSpecialCourtesyLabel__c

courtesy such as a courtesythat’s extended to a boardmember or VIP.

DescriptionThe system that defines aspecial courtesy such as a

HospitalizeSpecialCourtesySystem__c

courtesy that’s extended toa board member or VIP.

N/ANot supportedDescriptionThe reason that theencounter occurs, as

Indication__c

specified by usinginformation from anotherresource. For admissions,this is the admissiondiagnosis. Typically theindication is a condition ora procedure.

N/ANot supportedDescriptionIndicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

347



N/ANot supportedDescriptionIndicates whether or not thisfield appears on the patientcard.


N/AClinicalEncounter.DurationUnitId

DescriptionA unit of measurement oftime that the encounter

LengthUnit__c

lasted, excluding the timeduring leaves of absence.

N/AClinicalEncounter.Duration

DescriptionThe length of time that theencounter lasted, excluding

LengthValue__c

the time during leaves ofabsence.

Location values are supportedwith child records in the

HealthcareFacilityDescriptionThe city where a patientencounter occurs.

Location{1-5}City__c

ClinicalEncounterFacility object that

DescriptionThe country where a patientencounter occurs.

Location{1-5}Country__c

connect an encounter with itslocations. While the EHR datamodel could only support fivelocations for each encounter, theClinical data model can support

DescriptionThe description of thelocation where a patientencounter occurs.

Location{1-5}Description__c

a much higher numberlocations.

DescriptionThe last date when thislocation is valid as a patientencounter location.

Location{1-5}EndDate__c

DescriptionAn external identifier for thelocation where a patientencounter occurs.

Location{1-5}Id__c

DescriptionThe first line in the addressof the location where apatient encounter occurs.

Location{1-5}Line1__c

348



DescriptionThe second line in theaddress of the location


where a patient encounteroccurs.

DescriptionThe name of the locationwhere a patient encounteroccurs.

Location{1-5}Name__c

DescriptionThe postal code in theaddress of the location

Location{1-5}PostalCode__c


DescriptionThe first date when thelocation is valid as the

Location{1-5}StartDate__c

location where a patientencounter occurs.

DescriptionThe state in the address ofthe location where a patientencounter occurs.

Location{1-5}State__c

DescriptionThe last date when a contactdetail is valid for this

Location{1-5}TelecomPeriodEnd__c

location. Communicationdevices available at thelocation can include phonenumbers, fax numbers,mobile numbers, emailaddresses, and websites.

DescriptionThe first date when acontact detail is valid for this

Location{1-5}TelecomPeriodStart__c

location. Communicationdevices available at thelocation can include phonenumbers, fax numbers,

349



mobile numbers, emailaddresses, and websites.

DescriptionThe system that defines acontact detail for this

Location{1-5}TelecomSystem__c


DescriptionDetails such as home, office,or mobile related to contact

Location{1-5}TelecomUse__c

information for this location.Communication devicesavailable at the location caninclude phone numbers, faxnumbers, mobile numbers,email addresses, andwebsites.

DescriptionThe contact detail such as aphone number for this

Location{1-5}TelecomValue__c


DescriptionThe complete address of thelocation where a patientencounter occurs.

Location{1-5}Text__c

DescriptionThe system-defined codethat represents the type of

Location{1-5}TypeCode__c

location where the patientencounter occurs.

350



DescriptionThe human-readable labelthat represents the type of

Location{1-5}TypeLabel__c

location where the patientencounter occurs.

DescriptionThe system that defines thetype of location where thepatient encounter occurs.

Location{1-5}TypeSystem__c

DescriptionThe type of location wherethe patient encounteroccurs.

Location{1-5}Type__c

DescriptionDetails such as home oroffice related to a location

Location{1-5}Use__c


Identifier values are representedas child records in Clinical


DescriptionThe EHR encounter ID. Limit:255 characters.

Name

EncounterIdentifierthat reference the ClinicalEncounter record as theparent record.

N/AClinicalEncounter.PatientId

DescriptionThe patient’s name. Lookupto EhrPatient__c.

Patient__c

N/AClinicalEncounter.EndDate

DescriptionThe last date and time whenthe period is valid for thispatient encounter.

PeriodEnd__c

N/AClinicalEncounter.StartDate

DescriptionThe first date and time whenthe period is valid for thispatient encounter.

PeriodStart__c

351



This code value is specified as areference to a code set bundlerecord.

ClinicalEncounter.PriorityId

DescriptionThe system-defined codethat represents the urgencyof the patient encounter.

PriorityCode__c

DescriptionThe human-readable labelthat represents the urgencyof the patient encounter.

PriorityLabel__c

DescriptionThe system that defines theurgency of the patientencounter.

PrioritySystem__c

DescriptionAn indication of the urgencyof the patient encounter.

Priority__c

Examples includeimmediate, emergency,urgent, semi-urgent, andnon-urgent.


ClinicalEncounterReason.ReasonCodeId

DescriptionThe system-defined codethat represents the reason

ReasonCode__c

why the patient encounteroccurs. For admissions, thereason can be used for acoded admission diagnosis.

DescriptionThe human-readable labelthat represents the reason

ReasonLabel__c

why the patient encounteroccurs. For admissions, thereason can be used for acoded admission diagnosis.

DescriptionThe system that defines thereason why the patient

ReasonSystem__c

encounter occurs. Foradmissions, the reason can

352



be used for a codedadmission diagnosis.

N/AClinicalEncounter.Status

DescriptionAn indication of the statusof the patient encounter.

Status__c

Examples include planned,arrived, in-progress, onleave,finished, and cancelled.


ClinicalEncounter.TypeId

DescriptionThe system-defined codethat represents the specific

TypeCode__c

type of patient encounter.Examples of types includee-mail consultation, surgicalday-care, skilled nursing, andrehabilitation.

DescriptionThe human-readable labelthat represents the specific

TypeLabel__c

type of patient encounter.Examples of types includee-mail consultation, surgicalday-care, skilled nursing, andrehabilitation.

DescriptionThe system that defines thespecific type of patient

TypeSystem__c

encounter. Examples oftypes include e-mailconsultation, surgicalday-care, skilled nursing, andrehabilitation.

EhrEncounterParticipant__c to ClinicalEncounterProviderFields in EhrEncounterParticipant__c map to ClinicalEncounterProvider and its child objects in the Clinical data model.

353


Mapping


N/AClinicalEncounterProvider.ClinicalEncounterId

DescriptionAn interaction between apatient and one or more

Encounter__c

healthcare providers for thepurpose of providing thepatient with healthcareservices or assessing apatient’s health status.

N/AClinicalEncounterProvider.EndDate

DescriptionThe last date when thespecified participant was

EndDate__c

present during the patientencounter. Periods canoverlap or be subsets of theoverall encounters period.


IsRestricted__c



N/AClinicalEncounterProvider.Name

DescriptionThe EHR encounterparticipant ID. Limit: 255characters.

Name

N/AClinicalEncounterProvider.PractitionerId

DescriptionA person who’s involved inthe providing of healthcare

Practitioner__c

services. Lookup toEhrPractitioner__c.

N/ANot supportedDescriptionA person who’s involved ina patient’s healthcare but

RelatedPerson__c

isn’t the target of care anddoesn’t have a formalresponsibility in the process.

354



Lookup to EhrRelatedPerson__c.

A child record shares its sourcesystem details with its parentrecord.

ClinicalEncounter.SourceSystem


SourceSystem__c

ClinicalEncounter.SourceSystemIdentifier


SourceSystemId__c

ClinicalEncounter.SourceSystemModified



N/AClinicalEncounterProvider.StartDate

DescriptionThe last date when thespecified participant was

StartDate__c

present during the patientencounter. Periods canoverlap or be subsets of theoverall encounters period.


ClinicalEncounterProvider.PractitionerTypeId

DescriptionThe system-defined codethat represents the role of

TypeCode__c

the participant in the patientencounter. The typeindicates how an individualparticipates in a patientencounter. It includesnonpractitioner participantsand differs from practitionerroles. Examples includeadmitting doctor, attendingdoctor, translator, andconsulting doctor.

DescriptionThe human-readable labelthat represents the role of

TypeLabel__c

the participant in the patientencounter. The typeindicates how an individualparticipates in a patientencounter. It includesnonpractitioner participantsand differs from practitioner

355



roles. Examples includeadmitting doctor, attendingdoctor, translator, andconsulting doctor.

DescriptionThe system that defines therole of the participant in the

TypeSystem__c

patient encounter. The typeindicates how an individualparticipates in a patientencounter. It includesnonpractitioner participantsand differs from practitionerroles. Examples includeadmitting doctor, attendingdoctor, translator, andconsulting doctor.

EhrImmunization__c to PatientImmunizationFields in EhrImmunization__c map to PatientImmunization in the Clinical data model.

Mapping


N/APatientImmunization.PatientId

DescriptionThe individual account thatrepresents the patient inLightning Platform

Account__c

Date in DateTime format.PatientImmunization.VaccinationDate

DescriptionThe date when a vaccinewas administered or was tobe administered.

DateAdministered__c

Date as a string.PatientImmunization.VaccinationPeriod

DoseQuantity__c andDoseQuantityValue__c

PatientImmunization.Dose

DescriptionThe quantity of vaccineproduct that wasadministered.

DoseQuantity__c

are duplicare fields in EhrImmunization__c

N/APatientImmunization.DoseUnitId

DescriptionThe unit of measurement inthe quantity of vaccine

DoseQuantityUnits__c

356



product that wasadministered.

DoseQuantity__c andDoseQuantityValue__c

PatientImmunization.Dose

DescriptionThe quantity of vaccineproduct that wasadministered.


are duplicare fields in EhrImmunization__c

N/APatientImmunization.ExpirationDate

DescriptionThe date when a vaccinebatch expires.

ExpirationDate__c


IsRestricted__c



Location for an immunization isspecified in the Clinical data

PatientImmunization.FacilityId

DescriptionThe city where the vaccinewas administered.

LocationCity__c

model as a reference to aHealthcareFacility record.

DescriptionThe country where thevaccine was administered.

LocationCountry__c

DescriptionAn external identifier for theservice delivery location

LocationId__c

where the vaccine wasadministered.

DescriptionThe first line of the addresswhere the vaccine wasadministered.

LocationLline1__c

DescriptionThe second line of theaddress where the vaccinewas administered.

LocationLline2__c

357



DescriptionThe name of the locationwhere the vaccine wasadministered.

LocationName__c

DescriptionThe postal code in theaddress where the vaccinewas administered.

LocationPostalCode__c

DescriptionThe first date when thevaccination location is valid.

LocationStartDate__c

DescriptionThe state where the vaccinewas administered.

LocationState__c

DescriptionA contact detail for thelocation where the vaccinewas administered.

LocationTelecom__c

DescriptionThe complete address of thelocation where the vaccinewas administered.

LocationText__c

DescriptionA type of location where thevaccine was administered.

LocationType__c

DescriptionDetails such as home oroffice related to the location

LocationUse__c


N/APatientImmunization.LotNumber

DescriptionThe lot number of thevaccine product that wasadministered.

LotNumber__c

358



The identifier information for animmunization is represented as

IdentifierDescriptionThe name of the vaccineproduct that was

Name

Identifier records thatreference the Patientadministered. Limit: 255

characters. Immunization record using theirIdentifier.ParentRecordId field.

N/APatientImmunization.PatientId

DescriptionThe patient who received orwas to receive the vaccine.Lookup to EhrPatient__c.

Patient__c

The performer information foran immunization is represented

CarePerformerDescriptionThe clinician whoadministered the vaccine.

Performer__c

as CarePerformer recordsthat reference the PatientLookup to EhrPractitioner

__c. Immunization record usingtheir CarePerformer.ParentRecordId field.

DescriptionThe clinician whoadministered the vaccine.Limit: 255 characters.

PerformerName255__c

DescriptionThe long text description ofthe name of the clinician

PerformerName__c

who administered thevaccine.


PatientImmunization.ReasonCodeId


ReasonCode__c

why a vaccination wasadministered.


ReasonLabel__c

why a vaccination wasadministered.

DescriptionThe system that defines thereason why a vaccinationwas administered.

ReasonSystem__c

359



N/ANot supportedDescriptionThe human-readable labelthat indicates that thevaccine wasn’t administered.

RefusalLabel__c

Refusal reason is a subset ofstatus reason, since refused is astatus.

PatientImmunization.StatusReasonCodeId


RefusalReasonCode__c

why a vaccine wasn’tadministrated.


RefusalReasonLabel__c

why a vaccine wasn’tadministrated.

DescriptionThe system that defines thereason why a vaccine wasn’tadministrated.

RefusalReasonSystem__c

The clinical data model has nodedicated field to indicate

Not supportedDescriptionWhether the vaccine wasrefused (true) or not

RefusedIndicator__c

whether a vaccine was refusedor not. But the status field can(false). The defaultbe used to indicate if a vaccinecheckbox value is

deselected. was refused, among the otherpossible statuses.

Use the CarePerformerobject to connect the

CarePerformerDescriptionThe clinician who orderedthe vaccine. Lookup toEhrPractitioner__c.

Requestor__c

immunization record with theperson who requested theimmunnization. Specify

DescriptionThe clinician who orderedthe vaccine. Limit: 255characters.

RequestorName255__c Requestor as the role type in theCarePerformer record.

DescriptionThe long text description ofthe name of the clinicianwho ordered the vaccine.

RequestorName__c

360




PatientImmunization.RouteId

DescriptionThe system-defined codethat represents the path

RouteCode__c

through which the vaccineis taken into the body.

DescriptionThe human-readable labelthat represents the path

RouteLabel__c

through which the vaccineis taken into the body.

DescriptionThe system that defines thepath through which the

RouteSystem__c

vaccine is taken into thebody.

N/ANot supportedDescriptionWhether the vaccine isself-reported (true) or not

SelfReported__c

(false). The defaultcheckbox value isdeselected.


PatientImmunization.SiteId

DescriptionThe system-defined codethat represents the body site

SiteCode__c


DescriptionThe human-readable labelthat represents the body site

SiteLabel__c


DescriptionThe system that defines thebody site where the vaccinewas administered.

SiteSystem__c

N/APatientImmunization.SourceSystem


SourceSystem__c

361



N/APatientImmunization.SourceSystemIdentifier


SourceSystemId__c

N/APatientImmunization.SourceSystemModified




PatientImmunization.VaccineCodeId


VaccineTypeCode__c

vaccine that wasadministered or was to beadministered.


VaccineTypeLabel__c

vaccine that wasadministered or was to beadministered.

DescriptionThe system that defines thetype of vaccine that was

VaccineTypeSystem__c

administered or was to beadministered.

EhrVaccinationProtocol__c to Patient ImmunizationFields in EhrVaccinationProtocol__c map to PatientImmunization in the Clinical data model.

Fields

NotesClinical Data Model FieldsDetailsField

N/APatientImmunization.RecommendingAuthority

DescriptionThe authority whopublished the protocol.Limit: 255 characters.

Authority255__c

N/ANot supportedDescriptionThe long text description ofthe authority who published

Authority__c

362



the protocol. Limit: 255characters.

N/ANot supportedDescriptionThe long text description ofthe protocol under which avaccine is administered.

Description__c

N/APatientImmunization.StatusReasonCodeId

DescriptionThe human-readable labelthat represents an

DoseReasonLabel__c

explanation as to why animmunization event countsor doesn’t count against theprotocol.

DescriptionThe system-defined codethat represents an

DoseStatusReasonCode__c

explanation as to why animmunization event countsor doesn’t count against theprotocol.

DescriptionThe system that defines anexplanation as to why an

DoseStatusReasonSystem__c

immunization event countsor doesn’t count against theprotocol.

N/APatientImmunization.CurrentDose

DescriptionThe dose number within aseries of doses.

DoseSequence__c

N/ANot supportedDescriptionThe system-defined codethat indicates whether the

DoseStatusCode__c


DescriptionThe human-readable labelthat indicates whether the

DoseStatusLabel__c

363




DescriptionThe system that defineswhether an immunization

DoseStatusSystem__c

event counts or doesn’tcount against the protocol.

N/APatientImmunization.TargetDiseaseCodeId

DescriptionThe system-defined codethat represents the diseasethat the dose targets.

DoseTargetCode__c

N/ADescriptionThe human-readable labelthat represents the diseasethat the dose targets.

DoseTargetLabel__c

N/ADescriptionThe system that defines thedisease that the dosetargets.

DoseTargetSystem__c

Vaccination protocol is part ofthe immunization record in theClinical data model.

Not requiredDescriptionInformation about animmunization event.

Immunization__c


IsRestricted__c




Not requiredDescriptionThe EHR vaccinationprotocol ID. Limit: 255characters.

Name

364



N/APatientImmunization.ImmunizationRecommendation

DescriptionThe name of the vaccineseries: a possible path to

Series__s

achieve presumed immunityagainst a disease, within thecontext of an authority.

N/APatientImmunization.RecommendedDoses

DescriptionThe recommended numberof doses for achievingimmunity.

SeriesDoses__s


PatientImmunization.SourceSystem


SourceSystem__c

PatientImmunization.SourceSystemIdentifier


SourceSystemId__c

PatientImmunization.SourceSystemModified



EhrImmunizationReaction__c to PatientHealthReactionFields in EhrImmunizationReaction__c map to PatientHealthReaction in the Clinical data model.

Mapping


The reaction is connected to animmunization record, and that

N/ADescriptionThe individual account thatrepresents the patient inLightning Platform.

Account__c

immunization record isconnected to a patient record.


DescriptionAdditional informationabout the reaction.

Details__c

N/APatientHealthReaction.ObservationId

DescriptionMeasurements andassertions made regarding

EhrObservation__c

a patient or device. Lookupto EhrObservation__c.

365



N/APatientHealthReaction.ParentId

DescriptionInformation about theadministration of vaccines

Immunization__c

to patients. Lookup toEhrImmunization__c.


IsRestricted__c



N/APatientHealthReaction.Name

DescriptionThe EHR immunizationreaction ID. Limit: 255characters.

Name


DescriptionDetails about a reaction thatfollows an immunization.Limit: 255 characters.

Reaction255__c

N/ANot supportedDescriptionThe long text description ofa reaction that follows animmunization.

Reaction__c

N/APatientHealthReaction.ReactionDateTime

DescriptionThe date when the reactionto the immunization firstoccurred.

ReactionStartDate__c

N/APatientHealthReaction.IsSelfReported

DescriptionWhether the reaction wasself-reported (true) or not

SelfReported__c


N/ANot supportedThe external system ofrecord.

SourceSystem__c

366



N/ANot supportedThe ID of the record in thesource system.

SourceSystemId__c

N/ANot supportedThe date and time when therecord was last modified inthe source system.


EhrMedicationPrescription__c to MedicationRequestFields in EhrMedicationPrescription__c map to MedicationRequest in the Clinical data model.

Mapping


N/AMedicationRequest.PatientId


Account__c

N/AMedicationRequest.PrescribedDate

DescriptionThe date (and optionallytime) when the prescriptionwas written.

DateWritten__c

N/ANot SupportedDescriptionThe period of time overwhich the supplied product

DispenseExpectedSupplyDuration__c

is expected to be used, orthe length of time thedispense is expected to last.

N/ANot supportedDescriptionThe human-readable labelthat identifies and defines amedication.

DispenseMedicationLabel__c

DescriptionThe system-defined codethat identifies the

DispenseMedicationCode__c

medication beingadministered.

367



DescriptionThe system that defines thecode that identifies thismedication.

DispenseMedicationCodeSystem__c

N/ANot SupportedDescriptionThe date when a specificbatch of product expires.

DispenseMedicationExpiration__c

N/ANot SupportedDescriptionWhether the item isattributable to a specific

DispenseMedicationIsBrand__c

manufacturer (true) or not(false). The defaultcheckbox value isdeselected.

Note: Themanufacture doesn’thave to be known.

N/ANot supportedDescriptionThe system-defined codethat represents the kind of

DispenseMedicationKindCode__c

medication. Medications areeither a single administrableproduct or a package thatcontains one or moreproducts.

DescriptionThe human-readable labelthat represents the kind of

DispenseMedicationKindLabel__c


DescriptionThe system that defines thekind of medication.

DispenseMedicationKindSystem__c

Medications are either asingle administrable productor a package that containsone or more products.

368



N/ANot SupportedDescriptionThe assigned lot number ofa batch of the specifiedproduct.

DispenseMedicationLotNumber__c

N/ANot supportedDescriptionA common commercialname for the medication.

DispenseMedicationName__c

Medication form is specified inthe linked Medication record.

Not SupportedDescriptionThe system-defined codethat represents the form of

DispenseMedicationProductFormCode__c

the product: powder, tablet,or carton + code.

DescriptionThe human-readable labelthat represents the form of

DispenseMedicationProductFormLabel__c

the product: powder, tablet,or carton + human-readablelabel.

DescriptionThe system that defines theform of the product:

DispenseMedicationProductFormSystem__c

powder, tablet, or carton +system.

N/ANot SupportedDescriptionThe number of allowedrepeats of the medication

DispenseNumberOfRepeatedAllowed__c

dispense. For example, thenumber of times theprescribed quantity is to besupplied, including theinitial standard fill.

N/ANot SupportedDescriptionA unit of measurement inthe amount to be dispensedfor one fill.

DispenseQuantityUnit__c

N/ANot SupportedDescriptionThe amount of medicationto supply per dispense.

DispenseQuantityValue__c

369



N/ANot SupportedDescriptionThe last date when theprescription is considered

DispenseValidityPeriodEnd__c

valid (not stale) by theprescriber. Dispenses mustnot be made against theprescription after this date.

N/ANot SupportedDescriptionThe earliest date when theprescription can be filled for

DispenseValidityPeriodStart__c

the first time. If not specified,the prescription isopen-ended or defaults to astale date based onregulations.

N/AMedicationRequest.ClinicalEncounterId

DescriptionAn interaction between apatient and one or more

Encounter__c

healthcare providers for thepurpose of providing thepatient with healthcareservices or assessing apatient’s health status.Lookup to EhrEncounter__c.


IsRestricted__c




MedicationRequest.MedicationCodeId

DescriptionThe system-defined codethat identifies a medication.

MedicationCode__c

DescriptionThe human-readable labelthat identifies a medication.

MedicationCodeLabel__c

370



DescriptionThe system that defines amedication.

MedicationCodeSystem__c

This information is specified inthe Medication record.

Medication.ExpirationDateTime

DescriptionThe date when a specificbatch of product expires.

MedicationExpiration__c

If the medication is a brandname medication, then the

Medication.ManufacturerId

DescriptionWhether the item isattributable to a specific

MedicationIsBrand__c

manufacturer is specified in thisfield on the linked medicationrecord.


Note: Themanufacturer doesn’thave to be known.


MedicationKindCode__c



MedicationKindLabel__c



MedicationKindSystem__c


371




Medication.BatchNumber

DescriptionThe assigned lot number ofa batch of the specifiedproduct.

MedicationLotNumber__c


Medication.NameDescriptionA common commercialname for the medication.

MedicationName__c

Medication form is specified inthe linked Medication record.

Medication.MedicationFormId

DescriptionThe system-defined codethat represents the form of

MedicationProductFormCode__c

the medication: powder,tablet, or carton + code.


MedicationProductFormLabel__c

the medication: powder,tablet, or carton +human-readable label.

DescriptionThe system that defines theform of the medication:

MedicationProductFormSystem__c


The identifier information for amedication request is

IdentifierDescriptionThe EHR medicationprescription ID. Limit: 255characters.

Name

represented as Identifierrecords that reference themedication request record usingtheir Identifier.ParentRecordId field.

N/AMedicationRequest.PatientId

DescriptionThe person to whom amedication will be given.Lookup to EhrPatient__c.

Patient__c

N/AMedicationRequest.RequesterId

DescriptionThe healthcare professionalwho’s responsible for

Prescriber__c

authorizing the prescription.

372



Lookup to EhrPractitioner__c.

N/ANot supportedDescriptionThe long text description ofthe name of the healthcare

PrescriberName__c

professional who’sresponsible for authorizingthe prescription.

N/AMedicationRequest.ReasonCodeId


ReasonCode__c

or indication for writing theprescription.


ReasonLabel__c

or indication for writing theprescription.

DescriptionThe system that defines thereason or indication forwriting the prescription.

ReasonSystem__c

N/AMedicationRequest.ReasonReferenceId

DescriptionLookup to EhrCondition__c.

ReasonCondition__c

N/AMedicationRequest.SourceSystem


SourceSystem__c

N/AMedicationRequest.SourceSystemIdentifier


SourceSystemId__c

N/AMedicationRequest.SourceSystemModified



The clinical data modelimplementation is a picklist.

MedicationRequest.Status

DescriptionThe code that specifies thestate of the order, typicallyactive or completed.

StatusCode__c

373



DescriptionThe human-readable labelthat specifies the state of the

StatusLabel__c

order, typically active orcompleted.

DescriptionThe system that defines thestate of the order, typicallyactive or completed.

StatusSystem__c

While the SubstituteRestrictReasonCode

MedicationRequest.SubstitutionReasonCodeId

DescriptionThe system-defined codethat indicates the reason

SubstituteRestrictReasonCode__c

__c field records why asubstitution is restricted, thewhy a substitution can’t be

performed. MedicationRequest.SubstitutionReason

DescriptionThe human-readable labelthat indicates the reason

SubstituteRestrictReasonLabel__c

CodeId field records why asubstitution is allowed.

why a substitution can’t beperformed.

DescriptionThe system that defines thereason why a substitutioncan’t be performed.

SubstituteRestrictReasonSystem__c

While the MedicationRequest.Substitution

MedicationRequest.AllowedSubstitutionTypeCodeId

DescriptionThe system-defined codethat indicates whether a

SubstituteRestrictTypeCode__c

ReasonCodeId field recordswhat type of substitution isdifferent drug can berestricted, the Medicationdispensed from what was

prescribed. Request.AllowedSubstitutionTypeCode

DescriptionThe human-readable labelthat indicates whether a

SubstituteRestrictTypeLabel__c

Id field records what type ofsubstitution is allowed.

different drug can bedispensed from what wasprescribed.

DescriptionThe system that defineswhether a different drug can

SubstituteRestrictTypeSystem__c

374



be dispensed from what wasprescribed.

EhrMedicationStatement__c to MedicationStatementFields in EhrMedicationStatement__c map to MedicationStatement in the Clinical data model.

Mapping


N/AMedicationStatement.PatientId

DescriptionThe individual account thatrepresents the patient inLightning Platform

Account__c

N/ANot supportedDescriptionA manufactured item that’sused in the providing of

Device__c

healthcare without beingsubstantially changedthrough that activity.Lookup to EhrDevice__c.


IsRestricted__c



N/AMedicationStatement.MedicationCodeId

DescriptionThe system-defined codethat identifies a medication.

MedicationCode__c

DescriptionThe human-readable labelthat identifies a medication.


375



DescriptionThe system that defines amedication.


The expiration date is recordedon the medication record linkedto the medication statement.

Medication.ExpirationDateTime

DescriptionThe date when a specificbatch of product expires.


If the medication is a brandname medication, then the


DescriptionWhether the item isattributable to a specific


manufacturer is specified in thisfield on the linked medicationrecord.


Note: Themanufacturer doesn’thave to be known.










376



The lot number is specified inthe linked medication record.

Medication.BatchNumber

DescriptionThe assigned lot number ofa batch of the specifiedproduct.



Medication.NameDescriptionA common commercialname for the medication.

MedicationName__c



DescriptionThe system-defined codethat represents the form of


the medication: powder,tablet, or carton + code.



the medication: powder,tablet, or carton +human-readable label.

DescriptionThe system that defines theform of the medication:



The identifier information for anmedication statement is

IdentifierDescriptionThe EHR medicationstatement ID. Limit: 255characters.

Name

represented as Identifierrecords that reference themedication statement recordusing their Identifier.ParentRecordId field.

N/AMedicationStatement.PatientId

DescriptionThe person who’s taking themedication. Lookup toEhrPatient__c.

Patient__c

This information can be specifiedusing the Medication

MedicationStatement.StatusReasonCodeId

DescriptionThe system-defined codethat indicates why themedication wasn’t taken.

ReasonNotGivenCode__c

Statement.StatusReasonCodeId field becauseit’s a subset of status reason.

377



DescriptionThe human-readable labelthat indicates why themedication wasn’t taken.

ReasonNotGivenLabel__c

DescriptionThe system that indicateswhy the medication wasn’ttaken.

ReasonNotGivenSystem__c

N/AMedicationStatement.SourceSystem


SourceSystem__c

N/AMedicationStatement.SourceSystemIdentifier


SourceSystemId__c

N/AMedicationStatement.SourceSystemModified



This information can be specifiedusing the Medication

MedicationStatement.Status

DescriptionWhether the medicationwasn’t taken (true) or was

WasNotGiven__c

Statement.Status fieldbecause it’s a subset of status.taken (false). The default

checkbox value isdeselected.

N/AMedicationStatement.StartDateTime

DescriptionThe date when themedication was taken.

WhenGiven__c

EhrObservation__c to CareObservationFields in EhrObservation__c map to CareObservation in the Clinical data model.

Mapping


N/ACareObservation.ObservedSubjectId


Account__c

378



N/ACareObservation.EffectiveDateTime

DescriptionThe time or time periodwhen the observed value is

AppliesDateTime__c

asserted as being true,usually the time of aprocedure or specimencollection. Often the sourceof the date or time isn’tknown. Unless thisobservation is a historicalreport, a date is required.

N/ACareObservation.EndDateTime

DescriptionThe last day when theobserved value is assertedas being true.

AppliesPeriodEndDate__c

N/ACareObservation.EffectiveDateTime

DescriptionThe first day when theobserved value is assertedas being true.

AppliesPeriodStartDate__c


CareObservation.BodySiteId

DescriptionThe system-defined codethat represents the site on

BodySiteCode__c

the patient’s body wherethe observation was made(also called the target site).

DescriptionThe human-readable labelthat represents the site on

BodySiteLabel__c

the patient’s body wherethe observation was made(also called the target site).

DescriptionThe system that defines thesite on the patient’s body

BodySiteSystem__c

where the observation wasmade (also called the targetsite).

379



AuthorNote recordsreference Care

AuthorNoteDescriptionStatements aboutsignificant, unexpected, or

Comments__c

Observation records to addnotes to the observation.unreliable values—or

information about thesource of the observedvalue—that can be relevantto the interpretation of theresult.

N/ACareObservation.DeviceId

DescriptionThe device that’s used togenerate the observation

Device__c

data. Lookup to EhrDevice__c.

The Clinical data modelimplementation is a picklist.

CareObservation.ValueInterpretation

DescriptionThe system-defined codethat represents the

InterpretationCode__c

assessment that’s madebased on the observationresults. For some results,especially numeric results,an interpretation isnecessary to fullyunderstand the significanceof a result.

DescriptionThe human-readable labelthat represents the

InterpretationLabel__c

assessment that’s madebased on the result of theobservation. For someresults, especially numericresults, an interpretation isnecessary to fullyunderstand the significanceof a result.

DescriptionThe system that defines theassessment that’s made

InterpretationSystem__c

based on the result of theobservation. For someresults, especially numeric

380



results, an interpretation isnecessary to fullyunderstand the significanceof a result.


IsRestricted__c

N/ACareObservation.IssuedDateTime

DescriptionThe date and time when theobservation was made

IssuedDate__c

available. Updated when theresult is updated.



N/ACareObservation.MethodId


MethodCode__c

mechanism that’s used toperform the observation. Insome cases, method canimpact results and istherefore used to determinewhether results can becompared or to determinethe significance of results.


MethodLabel__c

mechanism that’s used toperform the observation. Insome cases, method canimpact results and istherefore used to determinewhether results can becompared or to determinethe significance of results.

381



DescriptionThe system that defines themechanism that’s used to

MethodSystem__c

perform the observation. Insome cases, method canimpact results and istherefore used to determinewhether results can becompared or to determinethe significance of results.

The identifier information for anobservation is represented as

IdentifierDescriptionThe EHR observation ID.Limit: 255 characters.

Name

Identifier records thatreference the observation recordusing their Identifier.ParentRecordId field.

The clinical data model supportsspecifying up to three code sets.

CareObservation.CodeId, CareObservation

DescriptionThe system-defined codethat represents the name ofthe observation.

NameCode__c

.AdditionalCode1Id,and CareObservation.AdditionalCode2Id

DescriptionThe human-readable labelthat represents the name ofthe observation.

NameLabel__c

DescriptionThe system that defines thename of the observation.

NameSystem__c

N/ACareObservation.ObservedSubjectId

DescriptionThe patient’s name. Lookupto Ehr_Patient__c.

Patient__c

N/ACareObservation.ObserverId

DescriptionA person with a formalresponsibility in the

Practitioner__c

providing of healthcareservices. Lookup toEhrPractitioner__c.

N/ACareObservation.UpperBaselineValue

DescriptionThe age at the high end ofthe applicable reference

ReferenceRangeAgeHigh__c

382


range. Can be a neonatalage (for example, number ofweeks at term). If thiselement is omitted, the highvalue of the reference rangeis assumed to bemeaningless (for example,the reference range is > 5).If the low comparator ismissing , it’s assumed to be“<”.

N/ACareObservation.LowerBaselineValue

DescriptionThe age at the low end ofthe applicable reference

ReferenceRangeAgeLow__c

range. Can be a neonatalage (for example, number ofweeks at term). If thiselement is omitted, the lowvalue of the reference rangeis assumed to bemeaningless (for example,the reference range is < 2).If the high comparator ismissing, it’s assumed to be“>”.

N/ACareObservation.BaselineUnitId

DescriptionThe unit of measurement inthe applicable referencerange.

ReferenceRangeHighUnit__c

N/ACareObservation.UpperBaselineValue

DescriptionThe value at the high end ofthe applicable reference

ReferenceRangeHighValue__c

range. If this element isomitted, the high value ofthe reference range isassumed to be meaningless.(for example, the referencerange is > 5). If the lowcomparator is missing, it’sassumed to be “<”.

383

DescriptionThe unit of measurement inthe applicable referencerange.

ReferenceRangeLowUnit__c

N/ACareObservation.LowerBaselineValue

DescriptionThe value at the low end ofthe applicable reference

ReferenceRangeLowValue__c

range. If this element isomitted, the low value ofthe reference range isassumed to be meaningless.(for example, the referencerange is < 2). If the highcomparator is missing, it’sassumed to be “>”.

The Clinical data modelimplementation is a text field.

CareObservation.BaselineValueText

DescriptionThe human-readable labelthat represents the meaning

ReferenceMeaningLabel__c

of the applicable referencerange, which providesguidance on how tointerpret the observed valueby comparison to a normalor recommended range.Specify what kind ofreference range it is (forexample, normal,recommended, ortherapeutic), or what statethis reference range appliesto (for example, age orhormonal cycles).

DescriptionThe system-defined codethat represents the meaning

ReferenceRangeMeaningCode__c

of the applicable referencerange. Specify what kind ofreference range it is (forexample, normal,recommended, ortherapeutic), or what statethis reference range applies

384


to (for example, age orhormonal cycles).

DescriptionThe system that defines themeaning of the applicablereference range.

ReferenceRangeMeaningSystem__c


DescriptionA unit of measurementwithin the applicablereference range.

ReferenceRangeUnit__c

N/ANot supportedDescriptionAn estimate of the degreeto which quality issues have

Reliability__c

impacted the reportedvalue. Picklist values:calibrating, early, error, ok,ongoing, and questionable.

N/ANot supportedDescriptionThe system-defined codethat represents the estimate

ReliabilityCode__c

of the degree to whichquality issues have impactedthe reported value.

N/ANot supportedDescriptionData that comes from aseries of measurements that

SampledData__c

were taken by a device, withupper and lower limits. Caninclude multipledimensions.

N/ACareObservation.SourceSystem


SourceSystem__c

N/ACareObservation.SourceSystemIdentifier


SourceSystemId__c

N/ACareObservation.SourceSystemModified



385



The Clinical data modelimplementation of Status is apicklist.

CareObservation.ObservationStatus

DescriptionThe status of theobservation’s result value.

Status__c

Picklist values: amended,final, preliminary, andregistered.

DescriptionThe system-defined codethat represents the status of

StatusCode__c

the observation’s resultvalue.

N/ANot supportedDescriptionAn attachment related tothe observed value.

ValueAttachment__c

Attachments includeadditional data contentdefined in other formatssuch as PDF, typicallyimages or reports.

N/ACareObservation.ObservedValueCodeId,


ValueCode__c

CareObservationComponent.ObservedValueCodeId

information determined bymaking the observation, ifthe information has a simplevalue.


ValueLabel__c

information determined bymaking the observation, ifthe information has a simplevalue.

DescriptionThe system that defines theinformation determined by

ValueSystem__c

making the observation, ifthe information has a simplevalue.

386



Supported using thecombination of start time andend time fields.

CareObservation.ObservationStartTime,CareObservation.ObservationEndTime

DescriptionThe period during which theobserved value is valid.

ValuePeriod__c

N/ACareObservation.ObservationEndTime,

DescriptionThe last date when theobserved value is valid.

ValuePeriodEndDate__c

CareObservationComponent.ObservationEndTime

N/ACareObservation.ObservationStartTime,

DescriptionThe first date when theobserved value is valid.

ValuePeriodStartDate__c

CareObservationComponent.ObservationStartTime

N/ACareObservation.NumericValue, Care

DescriptionA measured or potentiallymeasurable amount relatedto the observed value.

ValueQuantity__c

ObservationComponent.NumericValue

N/ACareObservation.ObservedValueUnitId,

DescriptionA unit of measurementrelated to the observedvalue.

ValueQuantityUnit__c

CareObservationComponent.ObservedValueUnitId

Supported using thecombination of numerator anddenominator fields.

CareObservation.ObservedValueNumerator, CareObservation.ObservedValueDenominator

DescriptionA relationship between twoquantities, expressed as anumerator and adenominator, related to theobserved value.

ValueRatio__c

N/ACareObservation.ObservedValue

DescriptionThe denominator in therelationship between two

ValueRatioDenominator__c

Denominator, CareObservationComponentquantities related to the

observed value. .ObservedValueDenominator

N/ACareObservation.ObservedValue

DescriptionThe numerator in therelationship between two

ValueRatioNumerator__c

Numerator, CareObservationComponentquantities related to the

observed value. .ObservedValueNumerator

387



N/ANot supportedDescriptionData that comes from aseries of measurements

ValueSampledData__c

taken by a device, related tothe observed value.

N/ANot supportedDescriptionThe number of samplepoints at each time point in

ValueSampledDataDimensions__c

the sampled data. If thisvalue is greater than one, allsample points for a point intime are recorded at thesame time.

N/ANot supportedDescriptionA correction factor that’sapplied to the sampled data

ValueSampledDataFactor__c

points before they’re addedto the origin.

N/ANot supportedDescriptionThe lower limit of detectionof the measured points in

ValueSampledDataLowerLimit__c

the sampled data. Requiredif any data points have thevalue L (lower thandetection limit).

N/ANot supportedDescriptionThe base quantity that ameasured value of zero

ValueSampledDataOrigin__c

represents in the sampleddata. This value provides theunits of the entiremeasurement series.

N/ANot supportedDescriptionThe system-defined codethat represents the base

ValueSampledDataOriginCode__c

quantity that a measuredvalue of zero represents inthe sampled data.

388



N/ANot supportedDescriptionThe human-readable labelthat represents the base

ValueSampledDataOriginCodeLabel__c

quantity that a measuredvalue of zero represents inthe sampled data.

N/ANot supportedDescriptionThe system that defines thebase quantity that a

ValueSampledDataOriginCodeSystem__c

measured value of zerorepresents in the sampleddata.

N/ANot supportedDescriptionA comparator used with thebase quantity that a

ValueSampledDataOriginComparator__c


N/ANot supportedDescriptionThe system that defines thebase quantity that a

ValueSampledDataOriginSystem__c


N/ANot supportedDescriptionUnits of measurement in thebase quantity that a

ValueSampledDataOriginUnits__c


N/ANot supportedDescriptionThe human-readable valueused in the base quantity

ValueSampledDataOriginValue__c

that a measured value ofzero represents in thesampled data.

N/ANot supportedDescriptionA time period defined by astart and end date and

ValueSampledDataPeriodMili__c

389



optionally time, related tothe sampled data.

N/ANot supportedDescriptionThe upper limit in data thatcomes from a series of

ValueSampledDataUpperLimit__c

measurements taken by adevice.

EhrRelatedObservation__c to CareOberservationComponentFields in EhrRelatedObservation__c map to CareOberservationComponent in the Clinical data model.

Fields



IsRestricted__c



N/ANot supportedDescriptionThe EHR related observationname. Limit: 255 characters.

Name

Observation value in code.CareObservationComponent.ObservedValueCodeId

DescriptionThe measurements andassertions made, regarding

Observation__c

Observation value in period.CareObservationComponent.ObservationStartTime

a patient or device, that thisobservation is related to.

CareObservationComponent.ObservationEndTime

Observation value in integer andquantity.

CareObservationComponent.NumericValue

390




Observation value in range andratio.

CareObservationComponent.ObservedValueNumerator

CareObservationComponent.ObservedValueDenominator

N/ACareObservationComponent.CareObservationId

DescriptionThe related observation.Lookup to EhrObservation__c.

RelatedObservation__c

N/ACareObservation.SourceSystem


SourceSystem__c

N/ACareObservation.SourceSystemIdentifier


SourceSystemId__c

N/ACareObservation.SourceSystemModified



N/ANot supportedDescriptionThe type of relationship thatexists with the target

Type__c

observation. Picklist values:derived-from,has-component,has-member, interfered-by,qualified-by, replaces, andsequel-to.

N/ACareObservationComponent.ComponentTypeCodeId


TypeCode__c

relationship that exists withthe target observation.


TypeLabel__c

391



relationship that exists withthe target observation.

DescriptionThe system that defines thetype of relationship that

TypeSystem__c

exists with the targetobservation.

EhrPatient__c to Person AccountFields in EhrPatient__c map to Account and Contact in the Clinical data model.

Mapping


In the clinical data model,patient records are the same

Not requiredDescriptionThe individual account thatrepresents the patient inLightning Platform.

Account__c

person account records thatrepresent them.

The address information for apatient is represented as

ContactPointAddressDescriptionThe city in an address for thepatient.

Address{1-5}City__c

ContactPointAddressrecords that reference the

DescriptionThe country in an addressfor the patient.

Address{1-5}Country__c

patient record using theirContactPointAddress.ParentId field. The EHRdata model could store only fiveaddress values, while the Clinical

DescriptionThe last date when anaddress for the patient isvalid.

Address{1-5}EndDate__c

data model supports a muchhigher number.

DescriptionThe first line of a streetaddress for the patient.

Address{1-5}Line1__c

DescriptionThe second line of a streetaddress for the patient.


392



DescriptionThe postal code of anaddress for the patient.

Address{1-5}PostalCode__c

DescriptionThe first date when anaddress for the patient isvalid.

Address{1-5}StartDate__c

DescriptionThe state in an address forthe patient.

Address{1-5}State__c

DescriptionA complete address for thepatient.

Address{1-5}Text__c

DescriptionDetails such as home oroffice related to an addressfor the patient.

Address{1-5}Use__c

N/AContact.BirthdateDescriptionThe patient’s birth date.

BirthDate__c

The language information for apatient is represented as

PersonLanguageDescriptionThe system-defined codethat represents a language

Communication{1-5}Code__c

PersonLanguage recordsthat reference the patient recordthat can be used tousing their Personcommunicate with theLanguagepatient about his or her

health. .IndividualId field. TheEHR data model could store only

DescriptionThe human-readable labelthat represents a language

Communication{1-5}Label__c

five languages spoken by apatient, while the Clinical datamodel supports a much highernumber.

that can be used tocommunicate with thepatient about his or herhealth.

DescriptionThe system that defines alanguage that can be used

Communication{1-5}System__c

to communicate with the

393



patient about his or herhealth.

N/ANot supportedDescriptionWhether the patient isdeceased (true) or not

Deceased__c


This code value is implementedas a picklist in the Clinical datamodel.

Contact.GenderDescriptionThe system-defined codethat represents the gender

GenderCode__c

that the patient isconsidered to have foradministration andrecord-keeping purposes.

DescriptionThe human-readable labelthat represents the gender

GenderLabel__c

that the patient isconsidered to have foradministration andrecord-keeping purposes.

DescriptionThe system that defines thegender that the patient is

GenderSystem__c

considered to have foradministration andrecord-keeping purposes.

The name information for apatient is represented as

PersonNameDescriptionThe patient’s given name.(Lisa Marie is the givenname of Lisa Marie Smith.)

GivenName{1-5}__c

PersonName records thatreference the patient recordusing their PersonName.ParentRecordId field.

DescriptionThe patient’s family name(Smith in Carol SmithRodgers Andrews).

FamilyName{1-3}__c

394



DescriptionThe long text description ofa name associated with thepatient.

Name__c

DescriptionThe first prefix in thepatient’s name.

PrefixName{1-3}__c

DescriptionThe first suffix in thepatient’s name.

SuffixName{1-3}__c

N/Anot supportedDescriptionWhether integration is active(true) or not (false). The

IntegrationIsActive__c

default checkbox value isselected.

N/Anot supportedDescriptionIndicates whether or not thisfield has restricted visibilitybased on sharing rules.

IsRestricted__c

N/Anot supportedDescriptionIndicates whether or not thisfield appears on the patientcard.



Contact.MaritalStatusDescriptionThe system-defined codethat represents the patient’s


most recent civil maritalstatus.

DescriptionThe human-readable labelthat represents the patient’s


most recent civil maritalstatus.

DescriptionThe system that defines thepatient’s most recent civilmarital status.


395



N/AAccount.MedicalRecordNumber__c

DescriptionThe medical record numberused to identify a patient.


You can still indicate theoccurrence of a multiple birth by

Not supportedDescriptionWhether the patient is partof a multiple birth (true)

MultipleBirth__c

assigning an appropriatesequence number in theor not (false). The defaultContact.SequenceInMultipleBirth field.

checkbox value isdeselected.

The identifier information for apatient is represented as

IdentifierDescriptionThe EHR patient ID. Limit:255 characters.

Name

Identifier records thatreference the patient’s accountrecord using theirIdentifier.ParentRecordId field.

Use the AccountContactRelation junction object to

AccountContactRelation.AccountId

DescriptionThe organization on behalfof which the patient contact

Organization255__c

connect the patient’s personaccount record to theiris acting, for which theorganization’s business accountrecord.

patient contact is working,or that’s the custodian of thepatient record. Limit: 255characters.

DescriptionThe long text description ofthe organization on behalf

Organization__c

of which the patient contactis acting, for which thepatient contact is working,or that’s the custodian of thepatient record.

N/ANot supportedDescriptionThe URL for a photo of thepatient.

PhotoUrl__c

N/AAccount.SourceSystemThe external system ofrecord.

SourceSystem__c

N/AAccount.SourceSystemIdentifier


SourceSystemId__c

396



N/AAccount.SourceSystemModified



The telecom information for apatient is represented as

ContactPointPhoneDescriptionThe last date when a contactdetail (for example, a phone

Telecom{1-5}PeriodEndDate__c

ContactPointPhonerecords that reference thenumber or email address)patient record using theircan be used to contact the

patient. ContactPointPhone.ParentId field.

DescriptionThe first date when acontact detail (for example,

Telecom{1-5}PeriodStartDate__c

a phone number or emailaddress) can be used tocontact the patient.

DescriptionThe system that defines acontact detail that can be

Telecom{1-5}System__c

used to contact the patient,such as fax or phone.

DescriptionDetails such as home, office,or mobile related to the

Telecom{1-5}Use__c

patient’s contactinformation.

DescriptionThe content details, such asthe phone number, that can

Telecom{1-5}Value__c

be used to contact thepatient.

EhrPatientCareProvider__c to ContactContactRelation__cFields in EhrPatientCareProvider__c map to ContactContactRelation__c in the Clinical data model.

397


Mapping



IsRestricted__c



N/ANot supportedDescriptionThe EHR patient careprovider ID. Limit: 255characters.

Name

This information is specified inthe HealthcareProvider

HealthcareProviderDescriptionThe organization on behalfof which the patient contact

Organization255__c

record of the associatedpractitioner.is acting, for which the

patient contact is working,or that’s the custodian of thepatient record. Limit: 255characters.


Organization__c

of which the patient contactis acting, for which thepatient contact is working,or that’s the custodian of thepatient record.

N/AContactContactRelation__c.Contact__c

DescriptionThe patient’s name.

Patient__c

N/AContactContactRelation__c.RelatedContact__c

DescriptionThe practitioner’s name.Lookup to EhrPractitioner__c.

Practitioner__c

398



This information is specified inthe HealthcareProvider

HealthcareProviderDescriptionThe practitioner’s name.Limit: 255 characters.

PractitionerName255__c

record of the associatedpractitioner.

N/ANot supportedDescriptionThe long text description ofthe practitioner’s name.

PractitionerName__c

The source system informationis recorded on the parent patientrecord.

Account.SourceSystemThe external system ofrecord.

SourceSystem__c

Account.SourceSystemIdentifier


SourceSystemId__c

Account.SourceSystemModified



EhrPatientContact__c to ContactContactRelation__cFields in EhrPatientContact__c map to Account and Contact (Person Accounts) through ContactContactRelation__c in the Clinical datamodel. EhrRelatedPerson__c is also mapped this way.

Mapping


The address information for apatient’s contact person is

ContactPointAddressDescriptionThe city in an address for thepatient contact.

Address{1-5}City__c

represented as ContactPointAddress records that

DescriptionThe country in an addressfor the patient contact.


reference the patient contactperson’s record using theirContactPointAddress.ParentId field. The EHRdata model could store only five

DescriptionThe last date when anaddress for the patientcontact is valid.


address values, while the Clinicaldata model supports a muchhigher number.

DescriptionThe first line of a streetaddress for the patientcontact.


399



DescriptionThe second line of a streetaddress for the patientcontact.


DescriptionThe postal code of anaddress for the patientcontact.


DescriptionThe first date when anaddress for the patientcontact is valid.


DescriptionThe state in an address forthe patient contact.


DescriptionA complete address for thepatient contact.

Address{1-5}Text__c

DescriptionDetails such as home oroffice related to an addressfor the patient contact.

Address{1-5}Use__c


Contact.GenderDescriptionThe system-defined codethat represents the gender

GenderCode__c

that the patient contact isconsidered to have foradministration andrecord-keeping purposes.

DescriptionThe human-readable labelthat represents the gender

GenderLabel__c

that the patient contact isconsidered to have foradministration andrecord-keeping purposes.

400



DescriptionThe system that defines thegender that the patient

GenderSystem__c

contact is considered tohave for administration andrecord-keeping purposes.

The name information for apatient’s contact person is

PersonNameDescriptionThe first name in the patientcontact’s given name. {Lisa

GivenName{1-5}__c

represented as PersonNamerecords that reference theMarie is the given name of

Lisa Marie Smith.) patient contact person’s recordusing their PersonName.ParentRecordId field.

DescriptionThe first name in the patientcontact’s family name

FamilyName{1-3}__c

{Smith in Carol SmithRodgers Andrews)

DescriptionThe long text description ofthe name of the patientcontact.

Name__c

DescriptionThe first prefix in a patientcontact name.

PrefixName{1-3}__c

DescriptionThe first suffix in a patientcontact name.

SuffixName{1-3}__c


IsRestricted__c



The identifier information for apatient’s contact person is

IdentifierDescriptionThe EHR patient contact ID.Limit: 255 characters.

Name

represented as Identifier

401



records that reference thepatient contact person’s accountrecord using theirIdentifier.ParentRecordId field.

Use the AccountContactRelation junction object to


DescriptionThe organization on behalfof which the contact is

Organization255__c

connect the patient contactperson’s person account recordacting, for which the contactto their organization’s businessaccount record.

is working, or that’s thecustodian of the patientrecord. Limit: 255 characters.


Organization__c

of which the contact isacting, for which the contactis working, or that’s thecustodian of the patientrecord.

Contact persons are connectedto patients using the Contact

ContactRelation__c.Contact__c


Patient__c

ContactRelation__cjunction object. The ContactContactRelation__c.Contact__c fieldreferences the contact record ofthe patient’s person account,and the ContactContactRelation__c.RelatedContact__c field referencesthe contact record of the contactperson’s person account.

N/AContactContactRelation__c.EndDate__c

DescriptionThe last day when thecontact or organization is

PeriodEnd__c

valid and can be contactedregarding the patient.

N/AContactContactRelation__c.StartDate__c

DescriptionThe first day when thecontact or organization is

PeriodStart__c

402



valid and can be contactedregarding the patient.

While the EHR data modeldefines relationship as a code,

ContactContactRelation__c.Role__c

DescriptionThe system-defined codethat represents the nature

RelationshipCode__c

the Clinical data modelimplementation is a referenceto ReicprocalRole__c.

of the relationship betweenthe patient and the patientcontact.

DescriptionThe human-readable labelthat represents the nature

RelationshipLabel__c

of the relationship betweenthe patient and the patientcontact.

DescriptionThe system that defines thenature of the relationship

RelationshipSystem__c

between the patient and thepatient contact.

The source system informationis recorded on the parent patientrecord.

Account.SourceSystemThe external system ofrecord.

SourceSystem__c

Account.SourceSystemIdentifier


SourceSystemId__c

Account.SourceSystemModified



The telecom information for apatient’s contact person is

ContactPointPhoneDescriptionThe last date when a contactdetail {for example, a phone


represented as ContactPointPhone records thatnumber or email address)reference the patient contactcan be used to contact the

patient contact. person’s account record usingtheir ContactPointPhone.ParentId field.

DescriptionThe first date when acontact detail {for example,


a phone number or emailaddress) can be used tocontact the patient contact.

403



DescriptionThe system that defines acontact detail that can be


used to contact the patient,such as fax or phone.


Telecom{1-5}Use__c

information {for example, aphone number or emailaddress) that can be used tocontact the patient contact.



be used to contact thepatient.

EhrPractitioner__c to PersonAccount and HealthcareProvider and PersonAccountFields in EhrPractitioner__c map to Person Accounts and HealthcareProvider in the Clinical data model.

Mapping


The address information for apractitioner is represented as

ContactPointAddressDescriptionThe city in a postal addresswhere the practitioner can

Address{1-5}City__c

ContactPointAddressrecords that reference thebe found or visited or to

which mail can be delivered. account record of thepractitioner’s person account

DescriptionThe country in a postaladdress where the


using the ContactPointAddress.ParentId field.If your Health Cloudimplementation models

practitioner can be found orproviders as Contacts instead of

visited or to which mail canbe delivered.

Person Accounts, then you can’tmap addresses to your providers.

DescriptionThe last date when anaddress is valid as a postal


address where the

404



practitioner can be found orvisited or to which mail canbe delivered.

DescriptionThe first line of a postaladdress where the



DescriptionThe second line of a postaladdress where the



DescriptionThe postal code in a postaladdress where the



DescriptionThe first date when anaddress is valid as a postal


address where thepractitioner can be found orvisited or to which mail canbe delivered.

DescriptionThe state in a postal addresswhere the practitioner can


be found or visited or towhich mail can be delivered.

DescriptionA complete postal addresswhere the practitioner can

Address{1-5}Text__c

be found or visited or towhich mail can be delivered.

405



DescriptionDetails such as home oroffice related to a postal

Address{1-5}Use__c

address where thepractitioner can be found orvisited or to which mail canbe delivered.

N/AContact.BirthdateDescriptionThe practitioner’s birth date,needed for identification.

BirthDate__c

The language information for apractitioner is represented as

PersonLanguageDescriptionThe system-defined codethat represents a language

Communication{1-5}Code__c

PersonLanguage recordsthat reference the practitioner’sthat the practitioner can useperson account record usingto communicate with thetheir PersonLanguagepatient about the patient’s

health. .IndividualId field. TheEHR data model could store only

DescriptionThe human-readable labelthat represents a language

Communication{1-5}Label__c

five languages spoken by apractitioner, while the Clinicaldata model supports a muchhigher number.

that the practitioner can useto communicate with thepatient about the patient’shealth.

DescriptionThe system that defines alanguage that the

Communication{1-5}System__c

practitioner can use tocommunicate with thepatient about the patient’shealth.

N/AContact.GenderDescriptionThe gender that thepractitioner is considered to

Gender__c

have for administration andrecord-keeping purposes,needed to address thepractitioner correctly.

406



The name information for apractitioner is represented as

PersonNameDescriptionThe first name in thepractitioner’s given name.

GivenName1__c

PersonName records thatreference the practitioner’s(Lisa Marie is the given

name of Lisa Marie Smith.) person account record usingtheir PersonName.ParentRecordId field.

DescriptionThe first name in thepractitioner’s family name

FamilyName{1-3}__c

(Smith in Carol SmithRodgers Andrews).

DescriptionThe name of thepractitioner. Limit: 255characters.

Name255__c

DescriptionThe long text description ofthe practitioner’s name.

Name__c

DescriptionThe first prefix in thepractitioner’s name.

PrefixName{1-3}__c

DescriptionThe first suffix in thepractitioner’s name.

SuffixName{1-3}__c


IsRestricted__c



In the Clinical data model,location details for a practitioner

HealthcarePractitionerFacility.AccountId

DescriptionThe city associated with alocation where thepractitioner provides care.

Location{1-5}City__c

is defined only when creatingrecords for PractitionerRoles inHealthcare

407



DescriptionThe country associated witha location where thepractitioner provides care.

Location{1-5}Country__c

PractitionerFacilityand CareProviderFacilitySpecialty

The Clinical data modelimplementation references

DescriptionThe description of a locationwhere the practitionerprovides care.

Location{1-5}Description__c

practice locations indirectly. Thisis done by referencing the localbusiness account of the requiredfacility using the HealthcarePractitionerFacility.AccountId field.

DescriptionThe last date when alocation is valid as a location

Location{1-5}EndDate__c The Clinical data model

implementation supports onlyone location reference for eachpractitioner role.

where the practitionerprovides care.

DescriptionAn external identifier for alocation where thepractitioner provides care.

Location{1-5}Id__c

DescriptionThe first line in the addressof a location where thepractitioner provides care.


DescriptionThe second line in theaddress of a location where


the practitioner providescare.

DescriptionThe name of a locationwhere the practitionerprovides care.

Location{1-5}Name__c

DescriptionThe postal code in theaddress of a location where

Location{1-5}PostalCode__c

the practitioner providescare.

408



DescriptionThe first date when alocation is valid as a location

Location{1-5}StartDate__c


DescriptionThe state in the address of alocation where thepractitioner provides care.

Location{1-5}State__c

DescriptionThe last date when a contactdetail is valid for a location

Location{1-5}TelecomPeriodEnd__c


DescriptionThe first date when acontact detail is valid for a

Location{1-5}TelecomPeriodStart__c

location where thepractitioner provides care.

DescriptionThe system that defines acontact detail, such as

Location{1-5}TelecomSystem__c

phone or fax, for a locationwhere the practitionerprovides care.


Location{1-5}TelecomUse__c

information for a locationwhere the practitionerprovides care.

DescriptionThe content details, such asthe phone number, for a

Location{1-5}TelecomValue__c

location where thepractitioner provides care.

409



DescriptionThe complete address of alocation where thepractitioner provides care.

Location{1-5}Text__c

DescriptionThe location type for alocation where thepractitioner provides care.

Location{1-5}Type__c

DescriptionDetails such as home oroffice related to a location

Location{1-5}Use__c


The identifier information for apractitioner is represented as

IdentifierDescriptionThe EHR practitioner ID.Limit: 255 characters.

Name

Identifier records thatreference the practitioner’sHealthcareProviderrecord using theirIdentifier.ParentRecordId field.

Not supportedNot supportedDescriptionThe organization where thepractitioner performs the

Organization255__c

associated roles. Limit: 255characters.

DescriptionThe long text description ofthe organization where the

Organization__c

practitioner performs theassociated roles.

In the Clinical data model, perioddetails for a practitioner’s role is

HealthcarePractitionerFacility.EffectiveFrom

DescriptionThe period during which thepractitioner is authorized to

Period__c

defined only when creating

HealthcarePractitionerFacility.EffectiveTo

records for PractitionerRoles inHealthcarePractitionerFacilityand CareProviderFacilitySpecialty

act as a practitioner in theseroles for the organization.

410



N/ANot supportedDescriptionThe URL for a photo of thepractitioner.

PhotoUrl__c

N/AHealthcareProvider.SourceSystem


SourceSystem__c

N/AHealthcareProvider.SourceSystemIdentifier


SourceSystemId__c

N/AHealthcareProvider.SourceSystemModified




CareProviderFacilitySpecialty.SepcialtyId

DescriptionThe system-defined codethat represents a specialtyof the practitioner’s.

SpecialtyCode__c

DescriptionThe system that defines aspecialty of thepractitioner’s.

SpecialtySystem__c

The telecom information for apractitioner is represented as

ContactPointPhoneDescriptionThe last date when a contactdetail is valid for thepractitioner.


ContactPointPhonerecords that reference thepractitioner’s person account

DescriptionThe first date when acontact detail is valid for thepractitioner.


record using their ContactPointPhone.ParentIdfield.

DescriptionThe system that defines acontact detail, such as


phone or fax, for thepractitioner.


Telecom{1-5}Use__c

information that can be

411



used to contact thepractitioner.



be used to contact thepractitioner.

EhrPractitionerQualification__c to BoardCertificationFields in EhrPractitionerQualification__c map to BoardCertification in the Clinical data model.

Fields



BoardCertification.CertificationType

DescriptionThe system-defined codethat represents apractitioner qualification.

Code__c

DescriptionThe human-readable labelthat represents apractitioner qualification.

CodeLabel__c

DescriptionThe system that defines apractitioner qualification.

CodeSystem__c


IsRestricted__c

N/ABoardCertification.BoardName

DescriptionThe organization thatregulates and issues the

Issuer255__c

qualification. Limit: 255characters.

412



N/ANot supportedDescriptionThe long text description ofthe organization that

Issue__c

regulates and issues thequalification.



Identifier values are recordedusing the Identifier object.

IdentifierDescriptionThe EHR practitionerqualification ID. Limit: 255characters.

Name

N/ABoardCertification.EffectiveTo

DescriptionThe last date when aqualification is valid.

PeriodEnd__c

N/ABoardCertification.EffectiveFrom

DescriptionThe first date when aqualification is valid.

PeriodStart__c

N/ABoardCertification.PractitionerId

DescriptionA person who’s involved inthe providing of healthcare.

Practitioner__c

N/ABoardCertification.SourceSystem


SourceSystem__c

N/ABoardCertification.SourceSystemIdentifier


SourceSystemId__c

N/ABoardCertification.SourceSystemModified



EhrPractitionerRole__c to HealthcarePractitionerFacilityFields in EhrPractitionerRole__c map to HealthcarePractitionerFacility and CareProviderFacilitySpecialty in the Clinical data model.

413


Fields


This field references the contactrecord of the practitioner’sperson account.

HealthcarePractitionerFacility.PractitionerId

DescriptionA person who’s involved inthe providing of healthcare.

EhrPractitioner__c

N/AHealthcarePractitionerFacility.EffectiveTo

DescriptionThe last date when thepractitioner is authorized to

EndDate__c



IsRestricted__c



The identifier information for apractitioner role is represented

IdentifierDescriptionThe EHR practitioner role ID.Limit: 255 characters.

Name

as Identifier records thatreference the practitioner’sHealthcarePractitionerFacilityrecord using theirIdentifier.ParentRecordId field.

The clinical data modelimplementation is a picklist.

CareProviderFacilitySpecialty.SepcialtyRole

DescriptionThe system-defined codethat represents thepractitioner’s role.

RoleCode__c

DescriptionThe human-readable labelthat represents thepractitioner’s role.

RoleLabel__c

DescriptionThe system that defines thepractitioner’s role.

RoleSystem__c

414



N/AHealthcarePractitionerFacility.SourceSystem


SourceSystem__c

N/AHealthcarePractitionerFacility


SourceSystemId__c

.SourceSystemIdentifier

N/AHealthcarePractitionerFacility.SourceSystemModified



Zero-to-many values can beassociated by creating multiple


DescriptionThe system-defined codethat represents a specialtyof the practitioner.

Specialty{1-5}Code__c

CareProviderFacilitySpecialty records thatreference a Healthcare

DescriptionThe human-readable labelthat represents a specialtyof the practitioner.

Specialty{1-5}Label__c

PractitionerFacilityrecord. However, a singleCareProviderFacilitySpecialty record can haveonly one combination of roleand specialty.

DescriptionThe system that defines aspecialty of the practitioner.

Specialty{1-5}System__c

N/AHealthcarePractitionerFacility.EffectiveFrom

DescriptionThe first date when thepractitioner is authorized to

StartDate__c


EhrProcedure__c to PatientMedicalProcedureFields in EhrProcedure__c map to PatientMedicalProcedure and its child object in the Clinical data model.

Mapping


N/APatientMedicalProcedure.PatientId

DescriptionThe individual account thatrepresents the patient.

Account__c

415



Body site is specified byselecting the code for the site in

PatientMedicalProcedureDetail.DetailCodeId

DescriptionAnatomical location for theprocedure.

BodySite__c

the PatientMedicalProcedureDetail record,

PatientMedicalProcedureDetail.DetailType

and select Body Site in thePatientMedicalProcedureDetail.DetailCodeId field.

The Clinical data modelimplementation is a code setbundle.

PatientMedicalProcedure.TypeId

DescriptionHigh-level categorization ofthe procedure.

Category__c

The Clinical data modelimplementation is a code setbundle.

PatientMedicalProcedure.CodeId

DescriptionIndustry-standard code forthe procedure.

Code__c

DescriptionIndustry-standard name forthe procedure.

CodeLabel__c

Complication is specified byselecting the code for the


DescriptionCode that identifies anyresulting complication.

Complication__c

complication in the PatientMedicalProcedure


Detail record, and selectComplication in thePatientMedicalProcedureDetail.DetailCodeId field.

PatientMedicalProcedure.ClinicalEncounterId

DescriptionEncounter associated withthe procedure.

Encounter__c

Follow up instructions arespecified by selecting the code


DescriptionInstructions for follow-upcare.

FollowUpInstructions__c

for the follow up instructions inthe PatientMedical


ProcedureDetail record,and select Follow Up in thePatientMedicalProcedureDetail.DetailCodeId field.

416



Items used in a procedure arespecified by selecting the code


DescriptionItems used during theprocedure.

ItemsUsed__c

for the used items in thePatientMedical


ProcedureDetail record,and select Used Item in thePatientMedicalProcedureDetail.DetailCodeId field.

N/APatientMedicalProcedure.FacilityId

DescriptionPhysical location where theprocedure was performed,

Location__c

such as a clinic or medicaloffice.

Notes are added to a procedureby creating AuthorNote

AuthorNoteDescriptionAdditional informationabout the procedure.

Notes__c

records that reference theprocedure record as its parentrecord.

This value can be specified byselecting the appropriate status

PatientMedicalProcedure.Status

DescriptionWhether the procedure wasnot performed as scheduled.

NotPerformed__c

in the PatientMedicalProcedure.Status field.

The Clinical data modelimplementation is a code set.

PatientMedicalProcedure.Outcome

DescriptionResult of the procedure.

Outcome__c

N/APatientMedicalProcedure.StartDate

DescriptionDate and time that theprocedure was performed.

PerformedDateTime__c

The Clinical data modelimplementation supports

PatientMedicalProcedure.Reason

DescriptionReason that the procedurewas requested.

Reason1__c

specifying a code set bundle,condition, observation,

CodeId, PatientMedicalProcedure.ReasonReferenceId


Reason2__c procedure, or diagnosticsummary as the reason for aprocedure.


Reason3__c

417




Reason4__c

This information can be specifiedin a procedure record by

PatientMedicalProcedure.StatusReasonCodeId

DescriptionReason that the procedurewas not performed.

ReasonNotPerformed__c

selecting an appropriate valuein the PatientMedicalProcedure.StatusReasonCodeId field.

N/APatientMedicalProcedure.ReportId

DescriptionName of the report relatedto the procedure.

Report__c

This information can be specifiedfor a procedure by selecting the

PatientMedicalProcedureDetail.DetailRecordId

DescriptionReference to the request forthe procedure.

Request__c

appropriate ClinicalServiceRequest record in


the PatientMedicalProcedureDetail.DetailRecordId field andselecting Based On as thevalue for the PatientMedicalProcedureDetail.DetailType field.

N/APatientMedicalProcedure.SourceSystem

DescriptionRecord ID from a systemoutside of Salesforce.

SourceSystemId__c

N/APatientMedicalProcedure.Status

DescriptionStatus of the procedure.Picklist values: Completed,

Status_c

Entered in Error, In Progress,Not Completed.

EhrProcedurePerformer__c to CarePerformerFields in EhrProcedurePerformer__c map to CarePerformer in the Clinical data model. CarePerformer references PatientMedicalProcedureas its parent.

418


Mapping


N/ACarePerformer.PersonId

DescriptionPractitioner involved in theprocedure. Lookup toPractitioner__c.

EHRPractitioner__c

N/ACarePerformer.ParentRecordId

DescriptionProcedure performed by thepractitioner. Lookup toProcedure__c.

EHRProcedure__c

N/ACarePerformer.RoleIdDescriptionPractitioner’s role during theprocedure.

PerformerRole__c

EhrProcedureRequest__c to ClinicalServiceRequestFields in EhrProcedureRequest__c map to ClinicalServiceRequest and its child object in the Clinical data model.

Mapping


N/AClinicalServiceRequest.PatientId

DescriptionName of the person theprocedure was performedon.

Account__c

Body site is specified byselecting the code for the site in

ClinicalServiceRequestDetail.DetailCodeId

DescriptionAnatomical location for theprocedure.

BodySite__c

the ClinicalServiceRequestDetail.Detail

ClinicalServiceRequestDetail.DetailType

CodeId field, and selectingBody Site in theClinicalServiceRequestDetail.DetailType field.

This field is a reference to a codeset bundle.

ClinicalServiceRequest.CategoryId

DescriptionHigh-level categorization ofthe procedure.

Category__c

419



This field is a reference to a codeset bundle.

ClinicalServiceRequest.RequestCodeId

DescriptionIndustry-standard code forthe procedure.

Code__c

DescriptionIndustry-standard name forthe procedure.

CodeLabel__c

N/AClinicalServiceRequest.ClinicalEncounterId

DescriptionEncounter associated withthe procedure.

Encounter__c

Notes are added to a procedureby creating AuthorNote

AuthorNoteDescriptionAdditional informationabout the procedure.

Notes__c

records that reference theprocedure record as its parentrecord.

N/AClinicalServiceRequest.RequesterId

DescriptionName of the practitionermaking the request.

OrderedBy__c

N/AClinicalServiceRequest.DateSigned

DescriptionDate and time the requestwas created.

OrderedOn__c

N/AClinicalServiceRequest.Priority

DescriptionPriority of the procedure.Picklist values: ASAP,Routine, Stat, Urgent.

Priority__c

To support many-to-one valuesfor reason in a service request,

ClinicalServiceRequest.ReasonCodeId,


Reason1__c

use the ClinicalServiceRequestDetail child

ClinicalServiceRequest.Diagnostic


Reason2__c object. Use the ClinicalServiceRequestDetail.DetailRecordId fieldand select ReasonReference as the value for

ReportId, ClinicalServiceRequest.ConditionId,ClinicalServiceRequest.Observation


Reason3__cthe ClinicalServiceRequestDetail.DetailType field.

Id, ClinicalServiceRequestDetail.DetailRecordId

420




Reason4__c

For point-in-time values, use thestart date field. For periods, use

ClinicalServiceRequest.StartDate

DescriptionScheduled date and time toperform the procedure.

ScheduledDateTime__c

both the start date and end datefields.ClinicalService

Request.EndDate

N/AClinicalServiceRequest.SourceSystem

DescriptionRecord ID from a systemoutside of Salesforce.

SourceSystemId__c

N/AClinicalServiceRequest.Status

DescriptionStatus of the procedurerequest. Picklist values:

Status__c

Accepted, Completed, Draft,In Progress, Not Completed,Proposed, Received,Rejected, Requested,Suspended.

EhrAllergyIntolerance__cRepresents information about the patient’s susceptibility to an adverse reaction upon exposure to a specified substance.


This packaged object has a standard object counterpart in the Clinical Data Model. We recommend using the standard object becauseit’s more closely aligned with FHIR v4.0.

Fields

DetailsField

Typereference

Account__c



421


DetailsField

Typestring

CriticalityCode__c


DescriptionThe system-defined code that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalityLabel__c


DescriptionThe human-readable label that represents an estimate of the potential clinical harm orseriousness of the reaction to the identified substance.

Typestring

CriticalitySystem__c


DescriptionThe system that defines an estimate of the potential clinical harm or seriousness of thereaction to the identified substance.

Typeboolean

IsRestricted__c


DescriptionIndicates whether or not this field has restricted visibility based on sharing rules.

Typeboolean


PropertiesDefaulted on create, Filter, Group

DescriptionIndicates whether or not this field appears on the patient card.

Typedate

LastActivityDate


422


DetailsField




TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

PropertiesAutonumber, Defaulted on create, Filter, idLookupSort

DescriptionThe EHR allergy intolerance ID. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe patient who has the sensitivity. Lookup to EhrPatient__c.

Typestring

Reaction255__c


DescriptionA description of the allergic reaction, including details of the manifestation if required. Limit:255 characters.

423


DetailsField

Typetextarea

Reaction__c


DescriptionA long text description of the allergic reaction, including details of the manifestation ifrequired.

TypedateTime

RecordedDate__c


DescriptionThe date when the sensitivity was recorded.

Typestring

RecorderName255__c


DescriptionThe name of the individual who recorded the record and takes responsibility for its content.Limit: 255 characters.

Typetextarea

RecorderName__c


DescriptionThe long text description of the name of the individual who recorded the record and takesresponsibility for its content.

Typereference

Recorder__c


DescriptionThe individual who takes responsibility for the content and can reference its source. Lookupto EhrPractitioner__c.

Typereference

SensitivityTest1__c

424


DetailsField


DescriptionAn observation that confirms or refutes the patient’s sensitivity. Lookup to EhrObservation__c.

Typereference

SensitivityTest2__c



Typereference

SensitivityTest3__c



Typestring

SensitivityTypeCode__c


DescriptionThe system-defined code that represents the patient’s sensitivity.

Typestring

SensitivityTypeLabel__c


DescriptionThe human-readable label that represents the patient’s sensitivity

Typestring

SensitivityTypeSystem__c


DescriptionThe system that defines the patient’s sensitivity

Typestring

SourceSystem__c

425


DetailsField



Typestring

SourceSystemId__c



TypedateTime




Typestring

StatusCode__c


DescriptionThe system-defined code that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusLabel__c


DescriptionThe human-readable label that represents the level of certainty associated with the potentialrisk of a reaction to the identified substance.

Typestring

StatusSystem__c


DescriptionThe system that defines the level of certainty associated with the potential risk of a reactionto the identified substance.

426


DetailsField

Typestring

Substance255__c


DescriptionThe substance or class of substances that’s considered responsible for the adverse reactionrisk. Limit: 255 characters.

Typetextarea

SubstanceLong__c


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.


Fields

DetailsField

Typereference

Account__c



Typeboolean

IsRestricted__c


427


DetailsField


Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR care plan ID. Limit: 255 characters.

428


DetailsField

Typetextarea

Notes__c


DescriptionNotes about the execution of the activity.

Typereference

Patient__c


DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

TypedateTime

PeriodEnd__c


DescriptionThe last date when the plan is in effect.

TypedateTime

PeriodStart__c


DescriptionThe first date when the plan comes (or is intended to come) into effect.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



429


DetailsField

TypedateTime




Typestring

Status__c


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.


Fields

DetailsField

Typetextarea

ActionsResulting__c


DescriptionResources that describe follow-on actions resulting from the care plan, such as drugprescriptions, encounter records, and appointments.

Typestring

ActivityPeriod__c

430


DetailsField


DescriptionThe period when the described activity is to occur.

Typestring

ActivitySchedule__c


DescriptionWhen the described activity is scheduled to occur.

Typereference

CarePlan__c

PropertiesCreate, Filter, Group, Sort,


Typestring

Category__c


DescriptionA high-level categorization of the type of activity in a care plan.

Typestring

Code__c


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


431


DetailsField

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


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


DescriptionThe quantity expected to be consumed in a given day.

Typetextarea

Details__c


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


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


432


DetailsField


Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LocationId__c


DescriptionAn external identifier for the facility where the activity will occur. Examples of locationsinclude home, hospital, and specific clinic.

433


DetailsField

Typestring

LocationLine1__c


DescriptionThe first line in the address of the facility where the activity will occur.

Typestring

LocationLine2__c


DescriptionThe second line in the address of the facility where the activity will occur.

Typestring

LocationName__c


DescriptionThe name of the facility where the activity will occur. Examples of locations include home,hospital, and specific clinic.

Typestring



DescriptionThe postal code in the address of the facility where the activity will occur.

TypedateTime



DescriptionThe first date when a location is valid as the facility where the activity will occur.

Typestring

LocationState__c


434


DetailsField

DescriptionThe state in the address of the facility where the activity will occur.

Typestring

LocationTelecom__c


DescriptionA contact detail for the facility where the activity will occur.

Typetextarea

LocationText__c


DescriptionThe complete address of the facility where the activity will occur.

Typestring

LocationType__c


DescriptionThe type of location where the activity will occur.

Typestring

LocationUse__c


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


435


DetailsField

DescriptionNotes about the execution of the activity.

Typestring

ProductMedication255__c


DescriptionThe drug to be consumed or supplied in the activity. Limit: 255 characters.

Typetextarea

ProductMedication__c


DescriptionThe long text description of the drug to be consumed or supplied in the activity.

Typestring

ProductSubstance255__c


DescriptionA homogeneous material with a definite composition. Limit: 255 characters.

Typetextarea

ProductSubstance__c


DescriptionThe long text description of a homogeneous material with a definite composition.

Typestring

Quantity__c


DescriptionThe quantity expected to be supplied, administered, or consumed.

Typereference

RelatedCarePlanGoal1__c


436


DetailsField

DescriptionA related intended objective of carrying out the care plan. Lookup to EhrCarePlanGoal__c.

Typereference




Typereference




Typereference




Typereference




Typereference

RelatedEncounter__c


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

437


DetailsField


DescriptionA related order for supply of a medication and the instructions for administration of themedicine to a patient. Lookup to EhrMedicationPrescription__c.

Typestring

SourceSystem__c



TypedateTime




Typestring

Status__c


DescriptionAn indicator of the progress being made by the specific activity.

Typestring

TypeCode__c


DescriptionThe system-defined code that represents the type of activity in a care plan.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the type of activity in a care plan.

438


DetailsField

Typestring

TypeSystem__c


DescriptionThe system that defines the type of activity in a care plan.

EhrCarePlanConcern__cRepresents the conditions, problems, concerns, diagnoses, and so on, whose management and mitigation are handled by this plan.


Fields

DetailsField

Typereference

CarePlan__c



Typereference

CarePlanGoal__c


DescriptionThe intended objectives of carrying out the care plan.

Typereference

Condition__c


DescriptionThe problems and diagnoses recognized by a clinician. Lookup to EhrCondition__c.

439


DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR care plan concern ID. Limit: 255 characters.

Typestring

SourceSystem__c



TypedateTime



440


DetailsField


EhrCarePlanGoal__cRepresents the intended objectives of carrying out the care plan.


Fields

DetailsField

Typereference

CarePlan__c



Typetextarea

Description__c


DescriptionA description of the care plan goal.

Typeboolean

IsRestricted__c



Typeboolean



441


DetailsField


Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR care plan goal ID. Limit: 255 characters.

Typetextarea

Notes__c


DescriptionComments about the care plan goal.

442


DetailsField

Typestring

SourceSystem__c



TypedateTime




Typestring

Status__c


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.


Fields

DetailsField

Typereference

CarePlan__c



443


DetailsField

Typereference

CarePlanActivity__c


DescriptionA planned action to occur as part of the plan. Examples include a medication to be used, labtests to perform, and education.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

444


DetailsField



Typestring

Name


DescriptionThe EHR care plan participant ID. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe patient or subject whose intended care is described by the plan. Lookup to EhrPatient__c.

Typestring

Practitioner255__c


DescriptionA person who’s involved in the providing of healthcare. Limit: 255 characters.

Typereference

Practitioner__c


DescriptionA person who’s involved in the providing of healthcare. Lookup to EhrPractitioner__c.

Typetextarea

PractitionerName__c


DescriptionThe long text description of the name of a person who’s involved in the providing ofhealthcare.

445


DetailsField

Typereference

RelatedPerson__c


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

RoleCode__c


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


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


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



Typestring

SourceSystemId__c

446


DetailsField



TypedateTime




EhrCondition__cRepresents detailed information about conditions, problems, and diagnoses recognized by a clinician.



Fields

DetailsField

Typestring

AbatementDetail255__c


DescriptionThe date or estimated date when the condition was resolved or went into remission. Limit:255 characters.

Typestring

AbatementDetail__c


DescriptionThe long text description of the date or estimated date when the condition was resolved orwent into remission.

447


DetailsField

Typereference

Account__c

PropertiesCreate, Filter, Group, Sort,


Typestring

AsserterPatient__c


DescriptionThe person who asserts the condition.

Typestring

AsserterPractitioner__c


DescriptionThe person reporting the condition.

Typestring

CategoryCode__c


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


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


448


DetailsField

DescriptionThe system that defines the category that’s assigned to the condition. Examples of categoriesare complaint, symptom, and diagnosis.

Typestring

CertaintyCode__c


DescriptionThe system-defined code that represents level of confidence that the condition is correct.

Typestring

CertaintyLabel__c


DescriptionThe human-readable label that represents the certainty of a correct condition.

Typestring

CertaintySystem__c


DescriptionThe system that defines the certainty.

Typestring

Code__c


DescriptionThe system-defined code that represents the condition, problem, or diagnosis.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents the condition, problem, or diagnosis.

Typestring

CodeSystem__c

449


DetailsField


DescriptionThe system that defines the condition, problem, or diagnosis.

TypedateTime

DateAsserted__c


DescriptionThe estimated or actual date when the condition, problem, or diagnosis was first detectedor suspected.

Typereference

Encounter__c


DescriptionThe encounter during which the condition was first asserted. Lookup to EhrEncounter__c.

Typestring

EvidenceCode__c


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


DescriptionA long text description of supporting information such as pathology reports.

Typestring

EvidenceLabel__c


450


DetailsField

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


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


DescriptionWhether the condition is resolved or in remission (true) or not (false). The defaultcheckbox value is deselected.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate



451


DetailsField



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LocationCode__c


DescriptionThe system-defined code that represents the anatomical location where the condition ismanifested.

Typetextarea

LocationDetail__c


DescriptionA long text description with precise details about the anatomical location where the conditionis manifested.

Typestring

LocationLabel__c


DescriptionThe human-readable label that represents the anatomical location where the condition ismanifested.

452


DetailsField

Typestring

LocationSystem__c


DescriptionThe system that defines the anatomical location where the condition is manifested.

Typestring

Name


DescriptionThe EHR condition ID. Limit: 255 characters.

Typetextarea

Notes__c


DescriptionAdditional information about the condition, including general comments about thedescription of the condition, its diagnosis, and prognosis.

Typestring

Onset__c


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


DescriptionThe patient’s name. Lookup to EhrPatient__c.

Typestring

SeverityCode__c


453


DetailsField

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


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


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



Typestring

SourceSystemId__c



TypedateTime




454


DetailsField

Typestring

Stage__c


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.

Typestring

StatusCode__c


DescriptionThe system-defined code that represents the condition’s clinical status.

Typestring

StatusLabel__c


DescriptionThe human-readable label that represents the condition’s clinical status.

Typestring

StatusSystem__c


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.


455


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents the item related to the patient’s condition.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents the item related to the patient’s condition.

Typestring

CodeSystem__c


DescriptionThe system that defines the item related to the patient’s condition.

Typereference

Condition__c


DescriptionThe patient’s problem or diagnosis recognized by a clinician.

Typeboolean

IsRestricted__c



Typeboolean



456


DetailsField


Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference



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


DescriptionThe EHR condition name. Limit: 255 characters.

457


DetailsField

Typetextarea

Notes__c


DescriptionAdditional information about the item related to the patient’s condition.

Typestring

SourceSystem__c



TypedateTime




Typestring

TargetCondition__c



Typetextarea

TargetDetail__c


Description

Typereference

TargetImmunization__c


DescriptionLookup to EhrImmunization__c.

458


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.


Fields

DetailsField

Typetextarea

Contact__c


DescriptionA long text description of the contact details for an organization or person who’s responsiblefor support for the device.

Typetextarea

DeviceURL__c


DescriptionA long text description of the network address on which the device can be directly contacted.

Typedate

Expiry__c


DescriptionThe date and time after which this device is not valid or should not be used.

Typeboolean

IsRestricted__c



459


DetailsField

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Location255__c


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

460


DetailsField


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


DescriptionA lot number assigned by the manufacturer.

Typestring

Manufacturer__c


DescriptionThe name of the device’s manufacturer.

Typestring

Model__c


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


DescriptionThe EHR device ID. Limit: 255 characters.

Typestring

Owner255__c


DescriptionThe organization that’s responsible for the provision and maintenance of the device. Limit:255 characters.

461


DetailsField

Typetextarea

Owner__c


DescriptionThe long text description of the organization that’s responsible for the provision andmaintenance of the device.

Typereference

OwnerId



Typereference

Patient__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

Type__c


462


DetailsField

DescriptionThe type of device.

Typestring

Udi__c


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


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.



463


Fields

DetailsField

Typestring

AdditionalInstruction__c


DescriptionAdditional dosage instructions such as “Take with food.”

Typestring

AdditionalInstructionCode__c


DescriptionThe system-defined code that represents additional dosage instructions.

Typestring

AdditionalInstructionLabel__c


DescriptionThe human-readable label that represents additional dosage instructions.

Typestring

AdditionalInstructionSystem__c


DescriptionThe system that defines additional dosage instructions.

Typeboolean

AsNeeded__c


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


464


DetailsField

DescriptionThe system-defined code that represents whether a medication is taken only when neededwithin the specified schedule rather than at every scheduled dose.

Typestring

AsNeededLabel__c


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


DescriptionThe system that defines whether a medication is taken only when needed within the specifiedschedule rather than at every scheduled dose.

Typestring

DoseQuantityUnit__c


DescriptionThe unit of measurement in the amount of medication that was dispensed.

Typestring



DescriptionThe amount of medication that was dispensed.

Typereference

EhrPatient__c


DescriptionThe individual receiving healthcare services.

465


DetailsField

Typetextarea

Instruction__c


DescriptionA long text description of how a medication is to be used by a patient.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


466


DetailsField


Typestring

MaxDosePerPeriodAmountUnit__c


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


DescriptionThe maximum total quantity of a therapeutic substance that can be administered to a subjectover a period of time.

Typestring

MaxDosePerPeriodDenominatorUnit__c


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


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


467


DetailsField

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


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


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


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


DescriptionAn order for supply of a medication and the instructions for administration of the medicineto a patient. Lookup to EhrMedicationPrescription__c.

Typereference



468


DetailsField

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


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


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


DescriptionThe system that defines the method by which a medication is introduced into or onto thebody, most commonly used for injections.

Typestring

Name


DescriptionThe EHR dosage instruction ID. Limit: 255 characters.

Typestring

RateDenominator__c


469


DetailsField

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


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


DescriptionThe system-defined code that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

Typestring

RouteLabel__c


DescriptionThe human-readable label that represents the route or physiological path of administrationof a therapeutic agent into or onto a subject.

Typestring

RouteSystem__c


DescriptionThe system that defines the route or physiological path of administration of a therapeuticagent into or onto a subject.

Typestring

SiteCode__c


470


DetailsField

DescriptionThe system-defined code that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteLabel__c


DescriptionThe human-readable label that specifies the anatomic site where the medication first entersthe body.

Typestring

SiteSystem__c


DescriptionThe system that defines the anatomic site where the medication first enters the body.

Typestring

SourceSystem__c



TypedateTime




Typetextarea

SupplementalInstructions__c


DescriptionAny additional instructions.

TypedateTime

TimingPeriod__c

471


DetailsField


DescriptionThe defined period of time.

TypedateTime

TimingPeriodEnd__c


DescriptionThe last day of the time period.

TypedateTime

TimingPeriodStart__c


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.



Fields

DetailsField

Typereference

Account__c



472


DetailsField

Typestring

Class__c


DescriptionThe classification of the encounter. Examples include inpatient, outpatient, ambulatory, andemergency.

Typereference

Encounter__c


DescriptionThe name of the interaction during which services are provided to the patient. Lookup toEhrEncounter__c.

Typestring

HospitalizeAdmitSourceCode__c


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


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


DescriptionThe system that defines the source from which the patient was admitted. Examples of sourcesinclude physician referral and transfer.

Typestring

HospitalizeDestination__c

473


DetailsField


DescriptionThe location to which the patient is discharged.

Typestring

HospitalizeDietCode__c


DescriptionThe system-defined code that represents diet preferences that the patient reports.

Typestring

HospitalizeDietLabel__c


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


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


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


474


DetailsField

DescriptionThe system-defined code that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionLabel__c


DescriptionThe human-readable label that represents the category or kind of patient location afterdischarge.

Typestring

HospitalizeDischargeDispositionSystem__c


DescriptionThe system that defines the category or kind of patient location after discharge.

Typetextarea

HospitalizeOrigin__c


DescriptionThe location from which the patient came before admission.

TypedateTime

HospitalizePeriodEnd__c


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


DescriptionThe first day when the specified participant was present during the encounter. Periods canoverlap or be subsets of the overall encounters period.

475


DetailsField

Typestring

HospitalizePreAdmissionId__c


DescriptionAn identifier for hospitalization pre-admission.

Typeboolean

HospitalizeReadmission__c


DescriptionWhether this hospitalization is a readmission (true) or not (false). The default checkboxvalue is deselected.

Typestring

HospitalizeSpecialArrangementCode__c


DescriptionThe system-defined code that represents special arrangements such as a wheelchair,translator, or stretcher.

Typestring

HospitalizeSpecialArrangementLabel__c


DescriptionThe human-readable label that represents special arrangements such as a wheelchair,translator, or stretcher.

Typestring

HospitalizeSpecialArrangementSystem__c


DescriptionThe system that defines special arrangements such as a wheelchair, translator, or stretcher.

Typestring

HospitalizeSpecialCourtesyCode__c


476


DetailsField

DescriptionThe system-defined code that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesyLabel__c


DescriptionThe human-readable label that represents a special courtesy such as a courtesy that’s extendedto a board member or VIP.

Typestring

HospitalizeSpecialCourtesySystem__c


DescriptionThe system that defines a special courtesy such as a courtesy that’s extended to a boardmember or VIP.

Typetextarea

HospitalizationOrigin__c


DescriptionThe location from which the patient came before admission.

Typestring

HospitalizationPreAdmissionId__c


DescriptionAn identifier for hospitalization pre-admission.

Typestring

Indication__c


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.

477


DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

LengthUnit__c

478


DetailsField


DescriptionA unit of measurement of time that the encounter lasted, excluding the time during leavesof absence.

Typestring

LengthValue__c


DescriptionThe length of time that the encounter lasted, excluding the time during leaves of absence.

Typestring

Location1City__c


DescriptionThe city where a patient encounter occurs.

Typestring

Location1Country__c


DescriptionThe country where a patient encounter occurs.

Typestring

Location1Description__c


DescriptionThe description of the location where a patient encounter occurs.

TypedateTime

Location1EndDate__c


DescriptionThe last date when this location is valid as a patient encounter location.

479


DetailsField

Typestring

Location1Id__c


DescriptionAn external identifier for the location where a patient encounter occurs.

Typestring

Location1Line1__c


DescriptionThe first line in the address of the location where a patient encounter occurs.

Typestring

Location1Line2__c


DescriptionThe second line in the address of the location where a patient encounter occurs.

Typestring

Location1Name__c


DescriptionThe name of the location where a patient encounter occurs.

Typestring

Location1PostalCode__c


DescriptionThe postal code in the address of the location where a patient encounter occurs.

TypedateTime

Location1StartDate__c


DescriptionThe first date when the location is valid as the location where a patient encounter occurs.

480


DetailsField

Typestring

Location1State__c


DescriptionThe state in the address of the location where a patient encounter occurs.

TypedateTime

Location1TelecomPeriodEnd__c


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


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


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


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.

481


DetailsField

Typestring

Location1TelecomValue__c


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


DescriptionThe complete address of the location where a patient encounter occurs.

Typestring

Location1TypeCode__c


DescriptionThe system-defined code that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeLabel__c


DescriptionThe human-readable label that represents the type of location where the patient encounteroccurs.

Typestring

Location1TypeSystem__c


DescriptionThe system that defines the type of location where the patient encounter occurs.

Typestring

Location1Type__c

482


DetailsField


DescriptionThe type of location where the patient encounter occurs.

Typestring

Location1Use__c


DescriptionDetails such as home or office related to a location where a patient encounter occurs.

Typestring

Location2City__c



Typestring

Location2Country__c



Typestring




TypedateTime

Location2EndDate__c



Typestring

Location2Id__c

483


DetailsField



Typestring

Location2Line1__c



Typestring

Location2Line2__c



Typestring

Location2Name__c



Typestring




TypedateTime




Typestring

Location2State__c

484


DetailsField



TypedateTime




TypedateTime




Typestring




Typestring




Typestring


485


DetailsField



Typetextarea

Location2Text__c



Typestring




Typestring




Typestring




Typestring

Location2Type__c


486


DetailsField


Typestring

Location2Use__c



Typestring

Location3City__c



Typestring

Location3Country__c



Typestring




TypedateTime

Location3EndDate__c



Typestring

Location3Id__c


487


DetailsField


Typestring

Location3Line1__c



Typestring

Location3Line2__c



Typestring

Location3Name__c



Typestring




TypedateTime




Typestring

Location3State__c


488


DetailsField


TypedateTime




TypedateTime




Typestring




Typestring




Typestring



489


DetailsField


Typetextarea

Location3Text__c



Typestring




Typestring




Typestring




Typestring

Location3Type__c



490


DetailsField

Typestring

Location3Use__c



Typestring

Location4City__c



Typestring

Location4Country__c



Typestring




TypedateTime

Location4EndDate__c



Typestring

Location4Id__c



491


DetailsField

Typestring

Location4Line1__c



Typestring

Location4Line2__c



Typestring

Location4Name__c



Typestring




TypedateTime




Typestring

Location4State__c



492


DetailsField

TypedateTime




TypedateTime




Typestring




Typestring




Typestring



493


DetailsField


Typetextarea

Location4Text__c



Typestring




Typestring




Typestring




Typestring

Location4Type__c



494


DetailsField

Typestring

Location4Use__c



Typestring

Location5City__c



Typestring

Location5Country__c



Typestring




TypedateTime

Location5EndDate__c



Typestring

Location5Id__c



495


DetailsField

Typestring

Location5Line1__c



Typestring

Location5Line2__c



Typestring

Location5Name__c



Typestring




TypedateTime




Typestring

Location5State__c



496


DetailsField

TypedateTime




TypedateTime




Typestring




Typestring




Typestring



497


DetailsField


Typetextarea

Location5Text__c



Typestring




Typestring




Typestring




Typestring

Location5Type__c



498


DetailsField

Typestring

Location5Use__c



Typestring

Name


DescriptionThe EHR encounter ID. Limit: 255 characters.

Typereference

Patient__c



TypedateTime

PeriodEnd__c


DescriptionThe last date and time when the period is valid for this patient encounter.

TypedateTime

PeriodStart__c


DescriptionThe first date and time when the period is valid for this patient encounter.

Typestring

PriorityCode__c


DescriptionThe system-defined code that represents the urgency of the patient encounter.

499


DetailsField

Typestring

PriorityLabel__c


DescriptionThe human-readable label that represents the urgency of the patient encounter.

Typestring

PrioritySystem__c


DescriptionThe system that defines the urgency of the patient encounter.

Typestring

Priority__c


DescriptionAn indication of the urgency of the patient encounter. Examples include immediate,emergency, urgent, semi-urgent, and non-urgent.

Typestring

ReasonCode__c


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


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


500


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


DescriptionAn indication of the status of the patient encounter. Examples include planned, arrived,in-progress, onleave, finished, and cancelled.

Typestring

TypeCode__c


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


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


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.

501


EhrEncounterAccommodation__cRepresents the type of accommodation received by the patient during an encounter.


Fields

DetailsField

Typestring

Bed__c


DescriptionAn indicator for the type of bed that the patient uses during the encounter.

Typereference

Encounter__c


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



Typeboolean




Typedate

LastActivityDate

502


DetailsField





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR encounter accommodation ID. Limit: 255 characters.

Typestring

Period__c


DescriptionThe time period when the accommodation type is valid.

Typestring

SourceSystem__c


503


DetailsField


TypedateTime




EhrEncounterParticipant__cRepresents a person, other than the patient, who’s involved in the patient encounter.


Fields

DetailsField

Typereference

Encounter__c


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


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

504


DetailsField



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


505


DetailsField

DescriptionThe EHR encounter participant ID. Limit: 255 characters.

Typereference

Practitioner__c


DescriptionA person who’s involved in the providing of healthcare services. Lookup to EhrPractitioner__c.

Typereference

RelatedPerson__c


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



Typestring

SourceSystemId__c



TypedateTime




Typedate

StartDate__c

506


DetailsField


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


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


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


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.

507




Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient in Lightning Platform

TypedateTime

DateAdministered__c


DescriptionThe date when a vaccine was administered or was to be administered.

Typestring

DoseQuantity__c


DescriptionThe quantity of vaccine product that was administered.

Typestring

DoseQuantityUnits__c


DescriptionThe unit of measurement in the quantity of vaccine product that was administered.

Typestring



508


DetailsField

DescriptionThe quantity of vaccine product that was administered.

TypedateTime

ExpirationDate__c


DescriptionThe date when a vaccine batch expires.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



509


DetailsField

TypedateTime

LastViewedDate



Typestring

LocationCity__c


DescriptionThe city where the vaccine was administered.

Typestring

LocationCountry__c


DescriptionThe country where the vaccine was administered.

Typestring

LocationId__c


DescriptionAn external identifier for the service delivery location where the vaccine was administered.

Typestring

LocationLline1__c


DescriptionThe first line of the address where the vaccine was administered.

Typestring

LocationLline2__c


510


DetailsField

DescriptionThe second line of the address where the vaccine was administered.

Typestring

LocationName__c


DescriptionThe name of the location where the vaccine was administered.

Typestring



DescriptionThe postal code in the address where the vaccine was administered.

TypedateTime



DescriptionThe first date when the vaccination location is valid.

Typestring

LocationState__c


DescriptionThe state where the vaccine was administered.

Typestring

LocationTelecom__c


DescriptionA contact detail for the location where the vaccine was administered.

Typetextarea

LocationText__c


511


DetailsField

DescriptionThe complete address of the location where the vaccine was administered.

Typestring

LocationType__c


DescriptionA type of location where the vaccine was administered.

Typestring

LocationUse__c


DescriptionDetails such as home or office related to the location where the vaccine was administered.

Typestring

LotNumber__c


DescriptionThe lot number of the vaccine product that was administered.

Typestring

Name


DescriptionThe name of the vaccine product that was administered. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe patient who received or was to receive the vaccine. Lookup to EhrPatient__c.

Typereference

Performer__c


512


DetailsField

DescriptionThe clinician who administered the vaccine. Lookup to EhrPractitioner__c.

Typestring

PerformerName255__c


DescriptionThe clinician who administered the vaccine. Limit: 255 characters.

Typetextarea

PerformerName__c


DescriptionThe long text description of the name of the clinician who administered the vaccine.

Typestring

ReasonCode__c


DescriptionThe system-defined code that represents the reason why a vaccination was administered.

Typestring

ReasonLabel__c


DescriptionThe human-readable label that represents the reason why a vaccination was administered.

Typestring

ReasonSystem__c


DescriptionThe system that defines the reason why a vaccination was administered.

Typestring

RefusalLabel__c


513


DetailsField

DescriptionThe human-readable label that indicates that the vaccine wasn’t administered.

Typestring

RefusalReasonCode__c


DescriptionThe system-defined code that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonLabel__c


DescriptionThe human-readable label that represents the reason why a vaccine wasn’t administrated.

Typestring

RefusalReasonSystem__c


DescriptionThe system that defines the reason why a vaccine wasn’t administrated.

Typeboolean

RefusedIndicator__c


DescriptionWhether the vaccine was refused (true) or not (false). The default checkbox value isdeselected.

Typereference

Requestor__c


DescriptionThe clinician who ordered the vaccine. Lookup to EhrPractitioner__c.

Typestring

RequestorName255__c

514


DetailsField


DescriptionThe clinician who ordered the vaccine. Limit: 255 characters.

Typetextarea

RequestorName__c


DescriptionThe long text description of the name of the clinician who ordered the vaccine.

Typestring

RouteCode__c


DescriptionThe system-defined code that represents the path through which the vaccine is taken intothe body.

Typestring

RouteLabel__c


DescriptionThe human-readable label that represents the path through which the vaccine is taken intothe body.

Typestring

RouteSystem__c


DescriptionThe system that defines the path through which the vaccine is taken into the body.

Typeboolean

SelfReported__c


DescriptionWhether the vaccine is self-reported (true) or not (false). The default checkbox valueis deselected.

515


DetailsField

Typestring

SiteCode__c


DescriptionThe system-defined code that represents the body site where the vaccine was administered.

Typestring

SiteLabel__c


DescriptionThe human-readable label that represents the body site where the vaccine was administered.

Typestring

SiteSystem__c


DescriptionThe system that defines the body site where the vaccine was administered.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort, Update


TypedateTime




516


DetailsField

Typestring

VaccineTypeCode__c


DescriptionThe system-defined code that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeLabel__c


DescriptionThe human-readable label that represents the type of vaccine that was administered or wasto be administered.

Typestring

VaccineTypeSystem__c


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.



517


Fields

DetailsField

Typereference

Account__c



Typetextarea

Details__c


DescriptionAdditional information about the reaction.

Typereference

EhrObservation__c


DescriptionMeasurements and assertions made regarding a patient or device. Lookup toEhrObservation__c.

Typereference

Immunization__c


DescriptionInformation about the administration of vaccines to patients. Lookup to EhrImmunization__c.

Typeboolean

IsRestricted__c



Typeboolean



518


DetailsField


Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR immunization reaction ID. Limit: 255 characters.

Typestring

Reaction255__c


DescriptionDetails about a reaction that follows an immunization. Limit: 255 characters.

519


DetailsField

Typetextarea

Reaction__c


DescriptionThe long text description of a reaction that follows an immunization.

TypedateTime

ReactionStartDate__c


DescriptionThe date when the reaction to the immunization first occurred.

Typeboolean

SelfReported__c


DescriptionWhether the reaction was self-reported (true) or not (false). The default checkbox valueis deselected.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime



520


DetailsField


EhrMedicationPrescription__cRepresents an order for supply of a medication and the instructions for administration of the medicine to a patient.


Fields

DetailsField

Typereference

Account__c



TypedateTime

DateWritten__c


DescriptionThe date (and optionally time) when the prescription was written.

Typedouble

DispenseExpectedSupplyDuration__c


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.

521


DetailsField

Typestring

DispenseMedicationCode__c


DescriptionThe system-defined code that identifies the medication being administered.

Typestring

DispenseMedicationCodeSystem__c


DescriptionThe system that defines the code that identifies this medication.

TypedateTime

DispenseMedicationExpiration__c


DescriptionThe date when a specific batch of product expires.

Typeboolean

DispenseMedicationIsBrand__c


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


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

522


DetailsField


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


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


DescriptionThe human-readable label that identifies and defines a medication.

Typestring

DispenseMedicationLotNumber__c


DescriptionThe assigned lot number of a batch of the specified product.

Typestring

DispenseMedicationName__c


DescriptionA common commercial name for the medication.

Typestring

DispenseMedicationProductFormCode__c


DescriptionThe system-defined code that represents the form of the product: powder, tablet, or carton+ code.

523


DetailsField

Typestring

DispenseMedicationProductFormLabel__c


DescriptionThe human-readable label that represents the form of the product: powder, tablet, or carton+ human-readable label.

Typestring

DispenseMedicationProductFormSystem__c


DescriptionThe system that defines the form of the product: powder, tablet, or carton + system.

Typedouble

DispenseNumberOfRepeatedAllowed__c


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


DescriptionA unit of measurement in the amount to be dispensed for one fill.

Typedouble

DispenseQuantityValue__c


DescriptionThe amount of medication to supply per dispense.

TypedateTime

DispenseValidityPeriodEnd__c


524


DetailsField

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


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


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



Typeboolean




Typedate

LastActivityDate




525


DetailsField


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MedicationCode__c



Typestring



DescriptionThe human-readable label that identifies a medication.

Typestring



DescriptionThe system that defines a medication.

TypedateTime



526


DetailsField


Typeboolean




Note: The manufacturer doesn’t have to be known.

Typestring




Typestring




Typestring




Typestring



527


DetailsField


Typestring

MedicationName__c



Typestring



DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

Typestring



DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring



DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

Typestring

Name


DescriptionThe EHR medication prescription ID. Limit: 255 characters.

Typereference

Patient__c

528


DetailsField


DescriptionThe person to whom a medication will be given. Lookup to EhrPatient__c.

Typereference

Prescriber__c


DescriptionThe healthcare professional who’s responsible for authorizing the prescription. Lookup toEhrPractitioner__c.

Typestring

PrescriberName__c


DescriptionThe long text description of the name of the healthcare professional who’s responsible forauthorizing the prescription.

Typestring

ReasonCode__c


DescriptionThe system-defined code that represents the reason or indication for writing the prescription.

Typereference

ReasonCondition__c



Typestring

ReasonLabel__c


DescriptionThe human-readable label that represents the reason or indication for writing the prescription.

529


DetailsField

Typestring

ReasonSystem__c


DescriptionThe system that defines the reason or indication for writing the prescription.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

StatusCode__c


DescriptionThe code that specifies the state of the order, typically active or completed.

Typestring

StatusLabel__c


DescriptionThe human-readable label that specifies the state of the order, typically active or completed.

530


DetailsField

Typestring

StatusSystem__c


DescriptionThe system that defines the state of the order, typically active or completed.

Typetextarea

SubstituteRestrictReasonCode__c


DescriptionThe system-defined code that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonLabel__c


DescriptionThe human-readable label that indicates the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictReasonSystem__c


DescriptionThe system that defines the reason why a substitution can’t be performed.

Typestring

SubstituteRestrictTypeCode__c


DescriptionThe system-defined code that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeLabel__c


531


DetailsField

DescriptionThe human-readable label that indicates whether a different drug can be dispensed fromwhat was prescribed.

Typestring

SubstituteRestrictTypeSystem__c


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.



Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient in Lightning Platform

Typereference

Device__c


DescriptionA manufactured item that’s used in the providing of healthcare without being substantiallychanged through that activity. Lookup to EhrDevice__c.

532


DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MedicationCode__c

533


DetailsField



Typestring



DescriptionThe human-readable label that identifies a medication.

Typestring



DescriptionThe system that defines a medication.

TypedateTime




Typeboolean




Note: The manufacturer doesn’t have to be known.

Typestring



534


DetailsField


Typestring




Typestring




Typestring




Typestring

MedicationName__c



Typestring



DescriptionThe system-defined code that represents the form of the medication: powder, tablet, orcarton + code.

535


DetailsField

Typestring



DescriptionThe human-readable label that represents the form of the medication: powder, tablet, orcarton + human-readable label.

Typestring



DescriptionThe system that defines the form of the medication: powder, tablet, or carton + system.

Typestring

Name


DescriptionThe EHR medication statement ID. Limit: 255 characters.

Typereference

Patient__c


DescriptionThe person who’s taking the medication. Lookup to EhrPatient__c.

Typestring

ReasonNotGivenCode__c


DescriptionThe system-defined code that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenLabel__c


536


DetailsField

DescriptionThe human-readable label that indicates why the medication wasn’t taken.

Typestring

ReasonNotGivenSystem__c


DescriptionThe system that indicates why the medication wasn’t taken.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typeboolean

WasNotGiven__c


DescriptionWhether the medication wasn’t taken (true) or was taken (false). The default checkboxvalue is deselected.

TypedateTime

WhenGiven__c

537


DetailsField


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.



Fields

DetailsField

Typereference

Account__c



TypedateTime

AppliesDateTime__c


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


538


DetailsField

DescriptionThe last day when the observed value is asserted as being true.

TypedateTime

AppliesPeriodStartDate__c


DescriptionThe first day when the observed value is asserted as being true.

Typestring

BodySiteCode__c


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


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


DescriptionThe system that defines the site on the patient’s body where the observation was made (alsocalled the target site).

Typetextarea

Comments__c


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.

539


DetailsField

Typereference

Device__c


DescriptionThe device that’s used to generate the observation data. Lookup to EhrDevice__c.

Typestring

InterpretationCode__c


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


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


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



540


DetailsField

TypedateTime

IssuedDate__c


DescriptionThe date and time when the observation was made available. Updated when the result isupdated.

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

MethodCode__c

541


DetailsField


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


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


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


DescriptionThe EHR observation ID. Limit: 255 characters.

Typestring

NameCode__c


DescriptionThe system-defined code that represents the name of the observation.

Typestring

NameLabel__c

542


DetailsField


DescriptionThe human-readable label that represents the name of the observation.

Typestring

NameSystem__c


DescriptionThe system that defines the name of the observation.

Typereference

Patient__c


DescriptionThe patient’s name. Lookup to Ehr_Patient__c.

Typereference

Practitioner__c


DescriptionA person with a formal responsibility in the providing of healthcare services. Lookup toEhrPractitioner__c.

Typestring

ReferenceMeaningLabel__c


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


543


DetailsField

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


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


DescriptionThe unit of measurement in the applicable reference range.

Typestring

ReferenceRangeHighValue__c


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


DescriptionThe unit of measurement in the applicable reference range.

Typestring

ReferenceRangeLowValue__c


544

DetailsField

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


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


DescriptionThe system that defines the meaning of the applicable reference range.

Typestring

ReferenceRangeUnit__c


DescriptionA unit of measurement within the applicable reference range.

Typepicklist

Reliability__c


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


545

DetailsField

DescriptionThe system-defined code that represents the estimate of the degree to which quality issueshave impacted the reported value.

Typestring

SampledData__c


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



Typestring

SourceSystemId__c



TypedateTime




Typepicklist

Status__c


DescriptionThe status of the observation’s result value. Picklist values: amended, final, preliminary, andregistered.

546


DetailsField

Typestring

StatusCode__c


DescriptionThe system-defined code that represents the status of the observation’s result value.

Typestring

ValueAttachment__c


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


DescriptionThe system-defined code that represents the information determined by making theobservation, if the information has a simple value.

Typestring

ValueLabel__c


DescriptionThe human-readable label that represents the information determined by making theobservation, if the information has a simple value.

Typestring

ValuePeriod__c


DescriptionThe period during which the observed value is valid.

TypedateTime

ValuePeriodEndDate__c


547


DetailsField

DescriptionThe last date when the observed value is valid.

TypedateTime

ValuePeriodStartDate__c


DescriptionThe first date when the observed value is valid.

Typestring

ValueQuantity__c


DescriptionA measured or potentially measurable amount related to the observed value.

Typestring

ValueQuantityUnit__c


DescriptionA unit of measurement related to the observed value.

Typestring

ValueRatio__c


DescriptionA relationship between two quantities, expressed as a numerator and a denominator, relatedto the observed value.

Typestring

ValueRatioDenominator__c


DescriptionThe denominator in the relationship between two quantities related to the observed value.

Typestring

ValueRatioNumerator__c

548


DetailsField


DescriptionThe numerator in the relationship between two quantities related to the observed value.

Typetextarea

ValueSampledData__c


DescriptionData that comes from a series of measurements taken by a device, related to the observedvalue.

Typestring

ValueSampledDataDimensions__c


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.

Typestring

ValueSampledDataFactor__c


DescriptionA correction factor that’s applied to the sampled data points before they’re added to theorigin.

Typestring

ValueSampledDataLowerLimit__c


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


549


DetailsField

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


DescriptionThe system-defined code that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeLabel__c


DescriptionThe human-readable label that represents the base quantity that a measured value of zerorepresents in the sampled data.

Typestring

ValueSampledDataOriginCodeSystem__c


DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginComparator__c


DescriptionA comparator used with the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginSystem__c


550


DetailsField

DescriptionThe system that defines the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginUnits__c


DescriptionUnits of measurement in the base quantity that a measured value of zero represents in thesampled data.

Typestring

ValueSampledDataOriginValue__c


DescriptionThe human-readable value used in the base quantity that a measured value of zero representsin the sampled data.

Typestring

ValueSampledDataPeriodMili__c


DescriptionA time period defined by a start and end date and optionally time, related to the sampleddata.

Typestring

ValueSampledDataUpperLimit__c


DescriptionThe upper limit in data that comes from a series of measurements taken by a device.

Typestring

ValueSystem__c


DescriptionThe system that defines the information determined by making the observation, if theinformation has a simple value.

551


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.


Fields

DetailsField

Typereference

Account__c



Typestring

Address1City__c



Typestring

Address1Country__c



TypedateTime

Address1EndDate__c



552


DetailsField

Typestring

Address1Line1__c



Typestring

Address1Line2__c



Typestring




TypedateTime




Typestring

Address1State__c



Typetextarea

Address1Text__c


DescriptionA complete address for the patient.

553


DetailsField

Typestring

Address1Use__c



Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



554


DetailsField

Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



555


DetailsField

Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




556


DetailsField

Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



557


DetailsField

Typestring

Address4Line1__c



Typestring

Address4Line2__c



Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



558


DetailsField

Typestring

Address4Use__c



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



559


DetailsField

Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



TypedateTime

BirthDate__c


DescriptionThe patient’s birth date.

560


DetailsField

Typestring




Typestring




Typestring




Typestring




Typestring




Typestring


561


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



562


DetailsField


Typestring




Typestring




Typestring




Typestring




Typeboolean

Deceased__c


563


DetailsField

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

Typestring

FamilyName1__c


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

Typestring

FamilyName2__c


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

Typestring

FamilyName3__c


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

Typestring

GenderCode__c


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

Typestring

GenderLabel__c


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

564


DetailsField

Typestring

GenderSystem__c


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

Typestring

GivenName1__c



Typestring

GivenName2__c



Typestring

GivenName3__c



Typestring

GivenName4__c



Typestring

GivenName5__c


565


DetailsField


Typeboolean

IntegrationIsActive__c


DescriptionWhether integration is active (true) or not (false). The default checkbox value is selected.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



566


DetailsField

TypedateTime

LastViewedDate



Typestring



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

Typestring



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

Typestring



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

Typestring




Typeboolean

MultipleBirth__c


567


DetailsField

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

Typestring

Name


DescriptionThe EHR patient ID. Limit: 255 characters.

Typetextarea

Name__c


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

Typestring

Organization255__c


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


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


DescriptionThe URL for a photo of the patient.

568


DetailsField

Typestring

PrefixName1__c


DescriptionThe first prefix in the patient’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the patient’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in the patient’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




569


DetailsField

Typestring

SuffixName1__c


DescriptionThe first suffix in the patient’s name.

Typestring

SuffixName2__c


DescriptionThe second suffix in the patient’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the patient’s name.

TypedateTime




TypedateTime




Typestring

Telecom1System__c


570


DetailsField

DescriptionThe system that defines a contact detail that can be used to contact the patient, such as faxor phone.

Typestring

Telecom1Use__c


DescriptionDetails such as home, office, or mobile related to the patient’s contact information.

Typestring

Telecom1Value__c



TypedateTime




TypedateTime




Typestring

Telecom2System__c



571


DetailsField

Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c


572


DetailsField


Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



573


DetailsField

Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c


574


DetailsField


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.


Fields

DetailsField

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate




575


DetailsField


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR patient care provider ID. Limit: 255 characters.

Typestring

Organization255__c


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


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

576


DetailsField



Typereference

Practitioner__c


DescriptionThe practitioner’s name. Lookup to EhrPractitioner__c.

Typestring

PractitionerName255__c


DescriptionThe practitioner’s name. Limit: 255 characters.

Typestring

PractitionerName__c


DescriptionThe long text description of the practitioner’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



Typestring


577


DetailsField



EhrPatientContact__cRepresents a contact party (for example, a guardian, partner, or friend) for the patient.


Fields

DetailsField

Typestring

Address1City__c


DescriptionThe city in an address for the patient contact.

Typestring

Address1Country__c


DescriptionThe country in an address for the patient contact.

TypedateTime

Address1EndDate__c


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

Typestring

Address1Line1__c

578


DetailsField


DescriptionThe first line of a street address for the patient contact.

Typestring

Address1Line2__c


DescriptionThe second line of a street address for the patient contact.

Typestring



DescriptionThe postal code of an address for the patient contact.

TypedateTime



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

Typestring

Address1State__c


DescriptionThe state in an address for the patient contact.

Typetextarea

Address1Text__c


DescriptionA complete address for the patient contact.

Typestring

Address1Use__c

579


DetailsField


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

Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



Typestring


580


DetailsField



TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



Typestring

Address3Country__c

581


DetailsField



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




Typestring

Address3State__c

582


DetailsField



Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c

583


DetailsField



Typestring

Address4Line2__c



Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c

584


DetailsField



Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



Typestring


585


DetailsField



TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



Typestring

FamilyName1__c


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

Typestring

FamilyName2__c

586


DetailsField


DescriptionThe second name in the patient contact’s family name (Rodgers in Carol Smith RodgersAndrews)

Typestring

FamilyName3__c


DescriptionThe third name in the patient contact’s family name (Andrews in Carol Smith RodgersAndrews)

Typestring

GenderCode__c


DescriptionThe system-defined code that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

Typestring

GenderLabel__c


DescriptionThe human-readable label that represents the gender that the patient contact is consideredto have for administration and record-keeping purposes.

Typestring

GenderSystem__c


DescriptionThe system that defines the gender that the patient contact is considered to have foradministration and record-keeping purposes.

Typestring

GivenName1__c


587


DetailsField

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

Typestring

GivenName2__c


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

Typestring

GivenName3__c


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

Typestring

GivenName4__c


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

Typestring

GivenName5__c


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

Typeboolean

IsRestricted__c



588


DetailsField

Typeboolean




Typedate

LastActivityDate


Description

TypedateTime

LastReferencedDate





TypedateTime

LastViewedDate


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

Typestring

Name


DescriptionThe EHR patient contact ID. Limit: 255 characters.

Typetextarea

Name__c


589


DetailsField

DescriptionThe long text description of the name of the patient contact.

Typestring

Organization255__c


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


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



TypedateTime

PeriodEnd__c


DescriptionThe last day when the contact or organization is valid and can be contacted regarding thepatient.

TypedateTime

PeriodStart__c


DescriptionThe first day when the contact or organization is valid and can be contacted regarding thepatient.

590


DetailsField

Typestring

PrefixName1__c


DescriptionThe first prefix in a patient contact name.

Typestring

PrefixName2__c


DescriptionThe second prefix in a patient contact name.

Typestring

PrefixName3__c


DescriptionThe third prefix in a patient contact name.

Typestring

RelationshipCode__c


DescriptionThe system-defined code that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipLabel__c


DescriptionThe human-readable label that represents the nature of the relationship between the patientand the patient contact.

Typestring

RelationshipSystem__c


591


DetailsField

DescriptionThe system that defines the nature of the relationship between the patient and the patientcontact.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

SuffixName1__c


DescriptionThe first suffix in a patient contact name.

Typestring

SuffixName2__c


DescriptionThe second suffix in a patient contact name.

Typestring

SuffixName3__c

592


DetailsField


DescriptionThe third suffix in a patient contact name.

TypedateTime



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

TypedateTime



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



Typestring

Telecom1Use__c


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


593


DetailsField


TypedateTime




TypedateTime




Typestring

Telecom2System__c



Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



594


DetailsField

TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c



TypedateTime


595


DetailsField



TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c



Typestring

Telecom4Value__c



TypedateTime



596


DetailsField


TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c



Typestring

Telecom5Value__c



EhrPractitioner__cRepresents a person who’s involved in the providing of healthcare.

597



Fields

DetailsField

Typestring

Address1City__c


DescriptionThe city in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Country__c


DescriptionThe country in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime

Address1EndDate__c


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


DescriptionThe first line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring

Address1Line2__c


598


DetailsField

DescriptionThe second line of a postal address where the practitioner can be found or visited or to whichmail can be delivered.

Typestring



DescriptionThe postal code in a postal address where the practitioner can be found or visited or to whichmail can be delivered.

TypedateTime



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


DescriptionThe state in a postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typetextarea

Address1Text__c


DescriptionA complete postal address where the practitioner can be found or visited or to which mailcan be delivered.

Typestring

Address1Use__c


599


DetailsField

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



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c


600


DetailsField


Typestring




TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c


601


DetailsField


Typestring

Address3City__c



Typestring

Address3Country__c



TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c


602


DetailsField


Typestring




TypedateTime




Typestring

Address3State__c



Typetextarea

Address3Text__c



Typestring

Address3Use__c


603


DetailsField


Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



Typestring

Address4Line2__c


604


DetailsField


Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c


605


DetailsField


Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c


606


DetailsField


Typestring




TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c


607


DetailsField


TypedateTime

BirthDate__c


DescriptionThe practitioner’s birth date, needed for identification.

Typestring



DescriptionThe system-defined code that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring



DescriptionThe human-readable label that represents a language that the practitioner can use tocommunicate with the patient about the patient’s health.

Typestring



DescriptionThe system that defines a language that the practitioner can use to communicate with thepatient about the patient’s health.

Typestring




608


DetailsField

Typestring




Typestring




Typestring




Typestring




Typestring




Typestring


609


DetailsField



Typestring




Typestring




Typestring




Typestring




Typestring



610


DetailsField


Typestring

FamilyName1__c


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

Typestring

FamilyName2__c


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

Typestring

FamilyName3__c


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

Typestring

Gender__c


DescriptionThe gender that the practitioner is considered to have for administration and record-keepingpurposes, needed to address the practitioner correctly.

Typestring

GivenName1__c


DescriptionThe first name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

611


DetailsField

Typestring

GivenName2__c


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

Typestring

GivenName3__c


DescriptionThe third name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typestring

GivenName4__c


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

Typestring

GivenName5__c


DescriptionThe fifth name in the practitioner’s given name. (Lisa Marie is the given name of Lisa MarieSmith.)

Typeboolean

IsRestricted__c



Typeboolean


612


DetailsField



Typestring

Location1City__c


DescriptionThe city associated with a location where the practitioner provides care.

Typestring

Location1Country__c


DescriptionThe country associated with a location where the practitioner provides care.

Typestring



DescriptionThe description of a location where the practitioner provides care.

TypedateTime

Location1EndDate__c


DescriptionThe last date when a location is valid as a location where the practitioner provides care.

Typestring

Location1Id__c


DescriptionAn external identifier for a location where the practitioner provides care.

Typestring

Location1Line1__c

613


DetailsField


DescriptionThe first line in the address of a location where the practitioner provides care.

Typestring

Location1Line2__c


DescriptionThe second line in the address of a location where the practitioner provides care.

Typestring

Location1Name__c


DescriptionThe name of a location where the practitioner provides care.

Typestring



DescriptionThe postal code in the address of a location where the practitioner provides care.

TypedateTime



DescriptionThe first date when a location is valid as a location where the practitioner provides care.

Typestring

Location1State__c


DescriptionThe state in the address of a location where the practitioner provides care.

TypedateTime


614


DetailsField


DescriptionThe last date when a contact detail is valid for a location where the practitioner providescare.

TypedateTime



DescriptionThe first date when a contact detail is valid for a location where the practitioner providescare.

Typestring



DescriptionThe system that defines a contact detail, such as phone or fax, for a location where thepractitioner provides care.

Typestring



DescriptionDetails such as home, office, or mobile related to contact information for a location wherethe practitioner provides care.

Typestring



DescriptionThe content details, such as the phone number, for a location where the practitioner providescare.

Typetextarea

Location1Text__c


615


DetailsField

DescriptionThe complete address of a location where the practitioner provides care.

Typestring

Location1Type__c


DescriptionThe location type for a location where the practitioner provides care.

Typestring

Location1Use__c


DescriptionDetails such as home or office related to a location where the practitioner provides care.

Typestring

Location2City__c



Typestring

Location2Country__c



Typestring




TypedateTime

Location2EndDate__c


616


DetailsField


Typestring

Location2Id__c



Typestring

Location2Line1__c



Typestring

Location2Line2__c



Typestring

Location2Name__c


DescriptionThe name of a location where the practitioner provides care

Typestring




TypedateTime



617


DetailsField


Typestring

Location2State__c



TypedateTime




TypedateTime




Typestring




Typestring




618


DetailsField

Typestring




Typetextarea

Location2Text__c



Typestring

Location2Type__c



Typestring

Location2Use__c



Typestring

Location3City__c



Typestring

Location3Country__c


619


DetailsField


Typestring




TypedateTime

Location3EndDate__c



Typestring

Location3Id__c



Typestring

Location3Line1__c



Typestring

Location3Line2__c



Typestring

Location3Name__c


620


DetailsField


Typestring




TypedateTime




Typestring

Location3State__c



TypedateTime




TypedateTime




Typestring


621


DetailsField



Typestring




Typestring




Typetextarea

Location3Text__c



Typestring

Location3Type__c



Typestring

Location3Use__c


DescriptionDetails such as home or office about a location where the practitioner provides care.

622


DetailsField

Typestring

Location4City__c



Typestring

Location4Country__c



Typestring




TypedateTime

Location4EndDate__c



Typestring

Location4Id__c



Typestring

Location4Line1__c



623


DetailsField

Typestring

Location4Line2__c



Typestring

Location4Name__c



Typestring




TypedateTime




Typestring

Location4State__c



TypedateTime



624


DetailsField


TypedateTime




Typestring




Typestring




Typestring




Typetextarea

Location4Text__c



625


DetailsField

Typestring

Location4Type__c



Typestring

Location4Use__c



Typestring

Location5City__c



Typestring

Location5Country__c



Typestring




TypedateTime

Location5EndDate__c



626


DetailsField

Typestring

Location5Id__c



Typestring

Location5Line1__c



Typestring

Location5Line2__c



Typestring

Location5Name__c



Typestring




TypedateTime




627


DetailsField

Typestring

Location5State__c



TypedateTime




TypedateTime




Typestring




Typestring




Typestring


628


DetailsField



Typetextarea

Location5Text__c



Typestring

Location5Type__c



Typestring

Location5Use__c



Typestring

Name


DescriptionThe EHR practitioner ID. Limit: 255 characters.

Typestring

Name255__c


DescriptionThe name of the practitioner. Limit: 255 characters.

629


DetailsField

Typetextarea

Name__c


DescriptionThe long text description of the practitioner’s name.

Typestring

Organization255__c


DescriptionThe organization where the practitioner performs the associated roles. Limit: 255 characters.

Typetextarea

Organization__c


DescriptionThe long text description of the organization where the practitioner performs the associatedroles.

Typereference

OwnerId



Typestring

Period__c


DescriptionThe period during which the practitioner is authorized to act as a practitioner in these rolesfor the organization.

Typetextarea

PhotoUrl__c


630


DetailsField

DescriptionThe URL for a photo of the practitioner.

Typestring

PrefixName1__c


DescriptionThe first prefix in the practitioner’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the practitioner’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in the practitioner’s name.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime



631


DetailsField


Typestring

SpecialtyCode__c


DescriptionThe system-defined code that represents a specialty of the practitioner’s.

Typestring

SpecialtySystem__c


DescriptionThe system that defines a specialty of the practitioner’s.

Typestring

SuffixName1__c


DescriptionThe first suffix in the practitioner’s name.

Typestring

SuffixName2__c


DescriptionThe second suffix in the practitioner’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the practitioner’s name.

TypedateTime



632


DetailsField

DescriptionThe last date when a contact detail is valid for the practitioner.

TypedateTime



DescriptionThe first date when a contact detail is valid for the practitioner.

Typestring

Telecom1System__c


DescriptionThe system that defines a contact detail, such as phone or fax, for the practitioner.

Typestring

Telecom1Use__c


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

Typestring

Telecom1Value__c


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

TypedateTime




TypedateTime


633


DetailsField



Typestring

Telecom2System__c



Typestring

Telecom2Use__c



Typestring

Telecom2Value__c



TypedateTime




TypedateTime




634


DetailsField

Typestring

Telecom3System__c



Typestring

Telecom3Use__c



Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c


635


DetailsField


Typestring

Telecom4Use__c



Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c

636


DetailsField



Typestring

Telecom5Value__c



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.


Fields

DetailsField

Typestring

Description__c


DescriptionThe description of the identifier.

Typereference

EhrPractitioner__c


637


DetailsField

DescriptionA person who’s involved in the providing of healthcare.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR practitioner identity name. Limit: 255 characters.

Typestring

Organization__c


DescriptionThe organization that the external identifier applies to. Limit: 255 characters.

638


DetailsField

Typedate

PeriodEndDate


DescriptionThe date when the identifier expires.

Typedate

PeriodStartDate


DescriptionThe first date when the identifier is active.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

System__c


DescriptionThe system that defines the practitioner identity.

639


DetailsField

Typestring

TypeCode__c


DescriptionThe system-defined code that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the practitioner identity type: license, registration,or ID.

Typestring

TypeSystem__c


DescriptionThe system that defines the practitioner identity type.

Typestring

Use__c


Description

Typestring

Value__c


DescriptionAn identifier for the external system.

EhrPractitionerQualification__cRepresents qualifications obtained by the practitioner through training and certification.

640



Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents a practitioner qualification.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents a practitioner qualification.

Typestring

CodeSystem__c


DescriptionThe system that defines a practitioner qualification.

Typeboolean

IsRestricted__c



Typestring

Issuer255__c


DescriptionThe organization that regulates and issues the qualification. Limit: 255 characters.

641


DetailsField

Typestring

Issue__c


DescriptionThe long text description of the organization that regulates and issues the qualification.

Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

642


DetailsField


DescriptionThe EHR practitioner qualification ID. Limit: 255 characters.

Typedate

PeriodEnd__c


DescriptionThe last date when a qualification is valid.

Typedate

PeriodStart__c


DescriptionThe first date when a qualification is valid.

Typereference

Practitioner__c



Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime


643


DetailsField



EhrPractitionerRole__cRepresents a list of roles that the practitioner can perform for a given time period.


Fields

DetailsField

Typereference

EhrPractitioner__c



TypedateTime

EndDate__c


DescriptionThe last date when the practitioner is authorized to act as a practitioner in these roles for theorganization.

Typeboolean

IsRestricted__c



Typeboolean


644


DetailsField



Typedate

LastActivityDate





Typestring

Name


DescriptionThe EHR practitioner role ID. Limit: 255 characters.

Typestring

RoleCode__c


DescriptionThe system-defined code that represents the practitioner’s role.

Typestring

RoleLabel__c


DescriptionThe human-readable label that represents the practitioner’s role.

Typestring

RoleSystem__c


DescriptionThe system that defines the practitioner’s role.

645


DetailsField

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

Specialty1Code__c


DescriptionThe system-defined code that represents a specialty of the practitioner.

Typestring

Specialty1Label__c


DescriptionThe human-readable label that represents a specialty of the practitioner.

Typestring

Specialty1System__c


DescriptionThe system that defines a specialty of the practitioner.

646


DetailsField

Typestring

Specialty2Code__c



Typestring

Specialty2Label__c



Typestring

Specialty2System__c



Typestring

Specialty3Code__c



Typestring

Specialty3Label__c



Typestring

Specialty3System__c



647


DetailsField

Typestring

Specialty4Code__c



Typestring

Specialty4Label__c



Typestring

Specialty4System__c



Typestring

Specialty5Code__c



Typestring

Specialty5Label__c



Typestring

Specialty5System__c



648


DetailsField

TypedateTime

StartDate__c


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.



Fields

DetailsField

Typereference

Account__c


DescriptionThe individual account that represents the patient.

Typestring

BodySite__c


DescriptionAnatomical location for the procedure.

Typestring

Category__c

649


DetailsField


DescriptionHigh-level categorization of the procedure.

Typestring

Code__c


DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c


DescriptionIndustry-standard name for the procedure.

Typestring

Complication__c


DescriptionCode that identifies any resulting complication.

Typereference

Encounter__c


DescriptionEncounter associated with the procedure.

Typetextarea

FollowUpInstructions__c


DescriptionInstructions for follow-up care.

Typetextarea

ItemsUsed__c

650


DetailsField

PropertiesCreate, , , Nillable, , Update

DescriptionItems used during the procedure.

Typestring

Location__c


DescriptionPhysical location where the procedure was performed, such as a clinic or medical office.

Typetextarea

Notes__c


DescriptionAdditional information about the procedure.

Typeboolean

NotPerformed__c


DescriptionWhether the procedure was not performed as scheduled.

Typestring

Outcome__c


DescriptionResult of the procedure.

TypedateTime

PerformedDateTime__c

PropertiesCreate, Filter, , Nillable, Sort, Update

DescriptionDate and time that the procedure was performed.

Typestring

Reason1__c

651


DetailsField


DescriptionReason that the procedure was requested.

Typestring

Reason2__c



Typestring

Reason3__c



Typestring

Reason4__c



Typestring

ReasonNotPerformed__c


DescriptionReason that the procedure was not performed.

Typestring

Report__c


DescriptionName of the report related to the procedure.

Typereference

Request__c

652


DetailsField


DescriptionReference to the request for the procedure.

Typestring

SourceSystemId__c


DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status_c


DescriptionStatus of the procedure. Picklist values: Completed, Entered in Error, In Progress, NotCompleted.

EhrProcedurePerformer__cA junction object that relates EhrProcedure__c and EhrPractitioner__c.



Fields

DetailsField

Typereference

EHRPractitioner__c


DescriptionPractitioner involved in the procedure. Lookup to Practitioner__c.

653


DetailsField

Typereference

EHRProcedure__c


DescriptionProcedure performed by the practitioner. Lookup to Procedure__c.

Typestring

PerformerRole__c


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.



Fields

DetailsField

Typereference

Account__c


DescriptionName of the person the procedure was performed on.

Typestring

BodySite__c


654


DetailsField

DescriptionAnatomical location for the procedure.

Typestring

Category__c


DescriptionHigh-level categorization of the procedure.

Typestring

Code__c


DescriptionIndustry-standard code for the procedure.

Typestring

CodeLabel__c


DescriptionIndustry-standard name for the procedure.

Typereference

Encounter__c


DescriptionEncounter associated with the procedure.

Typetextarea

Notes__c


DescriptionAdditional information about the procedure.

Typereference

OrderedBy__c


655


DetailsField

DescriptionName of the practitioner making the request.

TypedateTime

OrderedOn__c


DescriptionDate and time the request was created.

Typepicklist

Priority__c


DescriptionPriority of the procedure. Picklist values: ASAP, Routine, Stat, Urgent.

Typestring

Reason1__c



Typestring

Reason2__c



Typestring

Reason3__c



Typestring

Reason4__c


656


DetailsField


TypedateTime

ScheduledDateTime__c


DescriptionScheduled date and time to perform the procedure.

Typestring

SourceSystemId__c


DescriptionRecord ID from a system outside of Salesforce.

Typepicklist

Status__c


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.


Fields

DetailsField

Typedate

EndDate__c

657


DetailsField


DescriptionThe date when the program ends.

Typeboolean

IsActive__c


DescriptionIndicates whether the program is active.

Typecurrency

Rate__c


DescriptionThe reimbursement rate for the measurement period of a patient’s program.

Typestring

ReportName__c


DescriptionName of the Wave report that uses this information.

Typedate

StartDate__c


DescriptionThe date when the program begins.

Typedouble

Target__c


DescriptionTarget time to be spent with the patient for the measurement period.

Typepicklist

TimeSpan__c

658


DetailsField


DescriptionThe measurement period for the program. Picklist values: Annually, Monthly, Quarterly, andWeekly.

Typepicklist

UnitOfMeasure__c


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


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.



Fields

DetailsField

Typeboolean

IsRestricted__c

659


DetailsField



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


660


DetailsField

DescriptionThe EHR related observation name. Limit: 255 characters.

Typereference

Observation__c


DescriptionThe measurements and assertions made, regarding a patient or device, that this observationis related to.

Typereference

RelatedObservation__c


DescriptionThe related observation. Lookup to EhrObservation__c.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typepicklist

Type__c

661


DetailsField


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


DescriptionThe system-defined code that represents the type of relationship that exists with the targetobservation.

Typestring

TypeLabel__c


DescriptionThe human-readable label that represents the type of relationship that exists with the targetobservation.

Typestring

TypeSystem__c


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.

662



Fields

DetailsField

Typereference

Account__c



Typestring

Address1City__c


DescriptionThe city in an address for the related person.

Typestring

Address1Country__c


DescriptionThe country in an address for the related person.

TypedateTime

Address1EndDate__c


DescriptionThe last date when an address for the related person is valid.

Typestring

Address1Line1__c


DescriptionThe first line of a street address for the related person.

663


DetailsField

Typestring

Address1Line2__c


DescriptionThe second line of a street address for the related person.

Typestring



DescriptionThe postal code of an address for the related person.

TypedateTime



DescriptionThe first date when an address for the related person is valid.

Typestring

Address1State__c


DescriptionThe state in an address for the related person.

Typetextarea

Address1Text__c


DescriptionA complete address for the related person.

Typestring

Address1Use__c


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

664


DetailsField

Typestring

Address2City__c



Typestring

Address2Country__c



TypedateTime

Address2EndDate__c



Typestring

Address2Line1__c



Typestring

Address2Line2__c



Typestring




665


DetailsField

TypedateTime




Typestring

Address2State__c



Typetextarea

Address2Text__c



Typestring

Address2Use__c



Typestring

Address3City__c



Typestring

Address3Country__c



666


DetailsField

TypedateTime

Address3EndDate__c



Typestring

Address3Line1__c



Typestring

Address3Line2__c



Typestring




TypedateTime




Typestring

Address3State__c



667


DetailsField

Typetextarea

Address3Text__c



Typestring

Address3Use__c



Typestring

Address4City__c



Typestring

Address4Country__c



TypedateTime

Address4EndDate__c



Typestring

Address4Line1__c



668


DetailsField

Typestring

Address4Line2__c



Typestring




TypedateTime




Typestring

Address4State__c



Typetextarea

Address4Text__c



Typestring

Address4Use__c



669


DetailsField

Typestring

Address5City__c



Typestring

Address5Country__c



TypedateTime

Address5EndDate__c



Typestring

Address5Line1__c



Typestring

Address5Line2__c



Typestring




670


DetailsField

TypedateTime




Typestring

Address5State__c



Typetextarea

Address5Text__c



Typestring

Address5Use__c



TypedateTime

BirthDate__c


DescriptionThe related person’s birth date.

Typestring

FamilyName1__c


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

671


DetailsField

Typestring

FamilyName2__c


DescriptionThe second name in the related person’s family name (Rodgers in Carol Smith RodgersAndrews).

Typestring

FamilyName3__c


DescriptionThe third name in the related person’s family name (Andrews in Carol Smith RodgersAndrews).

Typestring

Gender__c


DescriptionThe related person’s gender.

Typestring

GivenName1__c



Typestring

GivenName2__c



Typestring

GivenName3__c


672


DetailsField


Typestring

GivenName4__c



Typestring

GivenName5__c



Typeboolean

IsRestricted__c



Typeboolean




Typestring

Language1__c


DescriptionA language that can be used to communicate with the related person about the patient’shealth.

Typestring

Language2__c

673


DetailsField



Typestring

Language3__c



Typestring

Language4__c



Typestring

Language5__c



Typedate

LastActivityDate





TypedateTime

LastReferencedDate

674


DetailsField



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR related person ID. Limit: 255 characters.

Typetextarea

NameFull__c


DescriptionThe long text description of the related person’s full name.

Typereference

Patient__c



Typetextarea

PhotoUrl__c


DescriptionThe URL to a photo of the related person.

675


DetailsField

Typestring

PrefixName1__c


DescriptionThe first prefix in the related person’s name.

Typestring

PrefixName2__c


DescriptionThe second prefix in the related person’s name.

Typestring

PrefixName3__c


DescriptionThe third prefix in the related person’s name.

Typestring

Relationship__c


DescriptionThe nature of the relationship between the patient and the related person.

Typestring

Role255__c


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.

676


DetailsField

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




Typestring

Specialty255__c


DescriptionThe related person’s specialty. Limit: 255 characters.

Typetextarea

Specialty__c


DescriptionThe long text description of the related person’s specialty.

Typestring

SuffixName1__c


DescriptionThe first suffix in the related person’s name.

677


DetailsField

Typestring

SuffixName2__c


DescriptionThe second suffix in the related person’s name.

Typestring

SuffixName3__c


DescriptionThe third suffix in the related person’s name.

TypedateTime



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

TypedateTime



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


DescriptionThe system that defines a contact detail, such as phone or fax, that can be used to contactthe related person.

Typestring

Telecom1Use__c


678


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


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

TypedateTime




TypedateTime




Typestring

Telecom2System__c



Typestring

Telecom2Use__c


679


DetailsField


Typestring

Telecom2Value__c



TypedateTime




TypedateTime




Typestring

Telecom3System__c



Typestring

Telecom3Use__c


680


DetailsField


Typestring

Telecom3Value__c



TypedateTime




TypedateTime




Typestring

Telecom4System__c



Typestring

Telecom4Use__c


681


DetailsField


Typestring

Telecom4Value__c



TypedateTime




TypedateTime




Typestring

Telecom5System__c



Typestring

Telecom5Use__c


682


DetailsField


Typestring

Telecom5Value__c



EhrVaccinationProtocol__cRepresents information about the protocol under which a vaccine is administered.


Fields

DetailsField

Typestring

Authority255__c


DescriptionThe authority who published the protocol. Limit: 255 characters.

Typetextarea

Authority__c


DescriptionThe long text description of the authority who published the protocol. Limit: 255 characters.

Typetextarea

Description__c

683


DetailsField


DescriptionThe long text description of the protocol under which a vaccine is administered.

Typestring

DoseReasonLabel__c


DescriptionThe human-readable label that represents an explanation as to why an immunization eventcounts or doesn’t count against the protocol.

Typedouble

DoseSequence__c


DescriptionThe dose number within a series of doses.

Typestring

DoseStatusCode__c


DescriptionThe system-defined code that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusLabel__c


DescriptionThe human-readable label that indicates whether the immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusReasonCode__c


684


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


DescriptionThe system that defines an explanation as to why an immunization event counts or doesn’tcount against the protocol.

Typestring

DoseStatusSystem__c


DescriptionThe system that defines whether an immunization event counts or doesn’t count againstthe protocol.

Typestring

DoseTargetCode__c


DescriptionThe system-defined code that represents the disease that the dose targets.

Typestring

DoseTargetLabel__c


DescriptionThe human-readable label that represents the disease that the dose targets.

Typestring

DoseTargetSystem__c


DescriptionThe system that defines the disease that the dose targets.

685


DetailsField

Typereference

Immunization__c


DescriptionInformation about an immunization event.

Typeboolean

IsRestricted__c



Typeboolean




TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


686


DetailsField

DescriptionThe EHR vaccination protocol ID. Limit: 255 characters.

Typestring

Series__s


DescriptionThe name of the vaccine series: a possible path to achieve presumed immunity against adisease, within the context of an authority.

Typedouble

SeriesDoses__s


DescriptionThe recommended number of doses for achieving immunity.

Typestring

SourceSystem__c



Typestring

SourceSystemId__c



TypedateTime




687


EhrVirtualDevice__cRepresents a group of related data items.


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents the virtual device.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate

688


DetailsField



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe EHR virtual device ID. Limit: 255 characters.

Typereference

OwnerId



Typestring

SourceSystem__c



Typestring

SourceSystemId__c



689


DetailsField

TypedateTime




EhrVirtualDeviceChannel__cRepresents the channel a virtual device operates on.


Fields

DetailsField

Typestring

Code__c


DescriptionThe system-defined code that represents the virtual device channel.

Typestring

CodeLabel__c


DescriptionThe human-readable label that represents the virtual device channel.

Typestring

CodeSystem__c


DescriptionThe system that defines the virtual device channel.

690


DetailsField

Typereference

EhrVirtualDevice__c


DescriptionA group of related data items. Lookup to EhrVirtualDevice__c.

Typeboolean

IsRestricted__c



Typeboolean




Typedate

LastActivityDate





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


691


DetailsField


Typetextarea

Metric__c


DescriptionThe long text description of a piece of data reported by the device for the channel.

Typestring

Name


DescriptionThe EHR virtual device channel name. Limit: 255 characters.

Typereference

Observation__c


DescriptionThe data for the metric. Lookup to EhrObservation__c.

Typereference

OwnerId



Typestring

SourceSystem__c



Typestring

SourceSystemId__c

692


DetailsField



TypedateTime




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.

CoverageBenefit

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

693

Health InsuranceHealth Cloud Developer Guide

CoverageBenefitItem

Specific service covered by the insurance plan. This object is available in API version 53.0 and later.

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.


Fields

DetailsField Name

Typedate

EffectiveFrom


694


DetailsField Name

DescriptionThe date from which this preauthorization is effective.

Typedate

EffectiveTo


DescriptionThe date after which this preauthorization is no longer effective.

Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate



Typereference

MemberPlanId


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

Typestring

Name


DescriptionThe name of this preauthorization.

695


DetailsField Name

Typetextarea

Notes


DescriptionNotes about this preauthorization.

Typereference

PayerId


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

Typestring

PreauthIdentifier


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

Typestring

ReferringPhysician


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

Typestring

SourceSystem


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

Typestring



DescriptionThe ID of this preauthorization record on its source system.

696


DetailsField Name

TypedateTime



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

Typepicklist

Status


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

• Active

• Inactive


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.


697


Fields

DetailsField Name

Typereference

CarePreauthId


Description

The ID of the care preauthorization this item details.

Typestring

EndingServiceCode


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

Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate


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


DescriptionThe side of the body receiving care.

Typestring

Name


698


DetailsField Name

DescriptionName of this preauthorized care item.

Typetextarea

Notes


DescriptionNotes about this preauthorized care item.

Typereference

OwnerId



Typeint

PreauthitemSequence


DescriptionSequence of this item among the preauthorized care items.

Typeint

Quantity


DescriptionQuantity being preauthorized.

Typestring

SourceSystem


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

Typestring



699


DetailsField Name

DescriptionThe ID of this preauthorization record on its source system.

TypedateTime



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

Typestring

StartingServiceCode


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

Typestring

Unit


DescriptionUnits by which the preauthorized quantity is measured.


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.

700



Fields

DetailsField Name

Typetextarea

BenefitNotes


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

Typedate

BenefitPeriodEndDate


DescriptionLast day of the coverage benefit period.

Typedate

BenefitPeriodStartDate


DescriptionFirst day of the coverage benefit period.

Typetextarea

CoinsuranceNotes


DescriptionAdditional information about the contribution the member makes towardstreatment.

Typetextarea

CopayNotes


DescriptionAdditional information on the copayment amounts members contributes.

701


DetailsField Name

Typepicklist

CoverageType


DescriptionGeneral category of service covered.


• Dental

• Medical

• Vision

Typetextarea

DeductibleNotes


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

Typestring

Disclaimer


Description[DESCRIPTION HERE]

Typestring

Disclaimer


DescriptionOverall plan benefit disclaimers.

Typecurrency

EmergencyDepartmentCopay


DescriptionThe amount the member contributes towards emergency treatment.

Typecurrency

FamilyInNetworkDeductibleApplied

702


DetailsField Name


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

Typecurrency

FamilyInNetworkDeductibleLimit


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


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


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


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.

703


DetailsField Name

Typecurrency

FamilyInNetworkOutofPocketRemaining


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


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

Typecurrency

FamilyOutofNetworkDeductibleLimit


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


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


704


DetailsField Name

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


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


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


DescriptionThe amount the member has paid for health care provided by the health plan’spreferred providers to the most costly family member.

Typecurrency

IndividualInNetworkDeductibleLimit


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.

Typecurrency

IndividualInNetworkDeductibleRemaining

705


DetailsField Name


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


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


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


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


DescriptionThe amount the member has paid for health care provided by non-preferredproviders to the most costly family member.

706


DetailsField Name

Typecurrency

IndividualOutofNetworkDeductibleLimit


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


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


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


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


707


DetailsField Name

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


DescriptionThe amount the member contributes towards treatment undertaken by thehealth plan’s preferred providers.

Typepercent

InNetworkCoinsurancePercentage


DescriptionThe percentage of treatment cost the member pays for treatment undertakenby the health plan’s preferred providers.

Typecurrency

InNetworkLifetimeMaximum


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.

Typeboolean

IsActive




Typeboolean

IsActive

708


DetailsField Name


DescriptionSpecifies whether the coverage benefit is currently in force.


Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate



Typetextarea

LifetimeMaximumNotes


DescriptionAdditional information on the lifetime maximum payments the member Will beexpected to make.

Typereference

MemberId


DescriptionThe ID of the member receiving these benefits.

Typereference

MemberPlanId


709


DetailsField Name

DescriptionThe ID of the member plan receiving these benefits.

Typestring

Name


DescriptionName of these coverage benefits.

Typecurrency

OutofNetworkCoinsuranceAmount


DescriptionThe amount the member contributes towards treatment undertaken bynon-preferred providers.

Typepercent

OutofNetworkCoinsurancPercentage


DescriptionThe percentage of treatment cost the member pays for treatment undertakenby non-preferred providers.

Typecurrency

OutofNetworkLifetimeMaximum


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


DescriptionAdditional information about the out-of-pocket payment the member makes.

710


DetailsField Name

Typereference

OwnerId



Typecurrency

PrimaryCareCopay


DescriptionThe amount the member contributes towards primary care treatment.

Typestring

SourceSystem


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

Typestring



DescriptionThe ID of this benefits record on its source system.

Typedate



DescriptionThe date on which these benefits were last changed on their source system.

Typecurrency

SpecialistCopay


DescriptionThe amount the member contributes towards specialist consultations.

711


DetailsField Name

Typecurrency

UrgentCareCopay


DescriptionThe amount the member contributes towards urgent care.

TypedateTime

VerificationDate


DescriptionDate on which the benefit was verified.


CoverageBenefitFeedFeed tracking is available for the object.

CoverageBenefitHistoryHistory is available for tracked fields of the object.

CoverageBenefitOwnerSharingRuleSharing rules are available for the object.

CoverageBenefitShareSharing is available for the object.

CoverageBenefitItemSpecific service covered by the insurance plan. This object is available in API version 53.0 and later.


Fields

DetailsField

Typestring

BenefitCategory

712


DetailsField


DescriptionName of the category this benefit is in.

Typereference

CodeSetServiceTypeId


DescriptionID of a Code Set Service Type in the Code Set object.


Relationship NameCodeSetServiceType


Refers ToCodeSet

Typereference

CoverageBenefitId


DescriptionThe ID of the covered benefit this item belongs to.


Relationship NameCoverageBenefit


Refers ToCoverageBenefit

Typestring

CoverageLevel


DescriptionDescription of the level of coverage provided by this item.

713


DetailsField

Typeboolean

DoesDeductibleApply


DescriptionSpecifies whether the benefit item requires a prior expenditure by the patient.


Typetextarea

InNetworkCoverage


DescriptionDescription of the in network coverage provided by this item.

Typeboolean

IsActive


DescriptionSpecifies whether the benefit item is currently available.


Typeboolean

IsInPlanNetwork


DescriptionIndicates if the benefit is only available in the plan network.


Typeboolean

IsPreauthorizationRequired


DescriptionSpecifies whether the service must be approved before use.


TypedateTime

LastReferencedDate

714


DetailsField



TypedateTime

LastViewedDate



Typereference

MemberId


DescriptionThe ID of the member receiving this benefit item.


Relationship NameMember


Refers ToAccount

Typestring

Name


DescriptionName of this coverage benefit item.

Typetextarea

Notes


DescriptionAdditional information about this coverage benefit item.

715


DetailsField

Typetextarea

OutofNetworkCoverage


DescriptionDescription of the coverage for non-preferred providers.

Typereference

OwnerId







Typestring

ServiceType


DescriptionThe type of service this plan benefit item provides.

Typestring

ServiceTypeCode


DescriptionThe code for the type of service this plan benefit item provides.

Typestring

SourceSystem


DescriptionThe name of the system this coverage benefits item record came from.

716


DetailsField

Typestring




TypedateTime



DescriptionThe ID of this coverage benefits item record on its source system.

TypedateTime



DescriptionThe date on which this coverage benefits item was last changed on the source system.

Typestring

TimePeriod


DescriptionA description of the period this plan benefit item covers.

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).

See Also:

• Account

• Contact

• Person Accounts

717


https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud.meta/health_cloud/admin_person_account_overview.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_objects_account.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_objects_contact.htm

https://help.salesforce.com/articleView?id=account_person.htm&type=5&language=en_US

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.


Fields

DetailsField Name

Typestring

Affiliation


DescriptionAn affiliation to a government service, such as the army or navy.

Typedate

EffectiveFrom


DescriptionThe date from which this member plan is effective.

Typedate

EffectiveTo


DescriptionThe date on which this member plan ceases to be effective.

Typestring

GroupNumber


DescriptionThe group number or policy number of the primary member.

Typestring

IssuerNumber

718


DetailsField Name


DescriptionReference number for the issuer of the plan.

Typedatetime

LastReferencedDate



Typedate

LastVerification


DescriptionThe date on which this plan was last verified.

Typedatetime

LastViewedDate



Typereference

MemberId


DescriptionThe ID of the member’s record.

Typestring

MemberNumber


DescriptionThe member’s reference number for this plan.

719


DetailsField Name

Typestring

Name


DescriptionThe name by which the member knows this plan.

Typetextarea

Notes


DescriptionNotes about this member plan.

Typereference

OwnerId



Typereference

PayerId


DescriptionThe ID of the payer’s Account object record.

Typereference

PlanId


DescriptionLookup of the Purchaser Plan ID.

Typestring

PrimaryCarePhysician


DescriptionThe name of the physician providing primary care under this plan.

720


DetailsField Name

Typepicklist

PrimarySecondaryTertiary


DescriptionWhether this plan is the primary, secondary, or tertiary plan.

Typepicklist

RelationshipToSubscriber


DescriptionThe relationship of this member to the plan’s subscriber. Valid options are:

• Self

• Spouse

• Child

• Unknown

• Other Relationship

Typestring

SourceSystem


DescriptionThe name of the system this plan record came from.

Typestring



DescriptionThe ID of this plan record on its source system.

TypedateTime



DescriptionThe date on which this plan record was last changed on the source system.

721


DetailsField Name

Typepicklist

Status


DescriptionIndicates whether the plan is active.

Typereference

SubscriberId


DescriptionThe ID of the subscriber’s record.

Typepicklist

VerificationStatus


DescriptionThe status of the plan’s verification. Valid options are:

• Active - Verified

• Rejected

• Not Checked

• Unknown

• Inactive


MemberPlanFeedFeed tracking is available for the object.

MemberPlanHistoryHistory is available for tracked fields of the object.

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.

722


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


DescriptionDescription of the type of payer.

Typestring

TaxId__c


DescriptionThe payer’s tax ID.

Typestring

SourceSystem__c


DescriptionThe name of the system from which the payer’s details are sourced.

See Also:

• Account

• Account Custom Fields

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


723



https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/health_cloud_object_reference/health_account_custom_fields.htm

Fields

DetailsField Name

Typetextarea

BenefitNotes


DescriptionAdditional information about the benefits available to members under this plan’scoverage.

Typetextarea

CoinsuranceNotes


DescriptionInformation about the contribution a member makes towards treatment.

Typetextarea

CopayNotes


DescriptionAdditional information on the copayment amounts that members contribute.

Typetextarea

DeductibleNotes


DescriptionAdditional information about a member’s deductibles.

Typeurl

DocumentLocation


DescriptionHyperlink to internal or external resources.

Typedate

EffectiveDate


724


DetailsField Name

DescriptionThe date on which these benefits are communicated to plan members.

Typedate

EffectiveFrom


DescriptionThe date on which these benefits become effective.

Typedate

EffectiveTo


DescriptionThe date on which these benefits ceased to be effective.

Typecurrency



DescriptionPatient's portion of payment for using emergency department services.

Typecurrency

FamilyInNetworkDeductible


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.

Typecurrency

FamilyInNetworkOutofPocket


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.

725


DetailsField Name

Typecurrency

FamilyOutofNetworkDeductible


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


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


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


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


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.

726


DetailsField Name

Typecurrency

IndividualOutofNetworkOutofPocket


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



DescriptionThe amount a member contributes towards each treatment undertaken by thehealth plan’s preferred providers.

Typedouble



DescriptionThe percentage of treatment cost the member pays for each treatmentundertaken by the health plan’s preferred providers.

Typecurrency



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



727


DetailsField Name

Typedatetime

LastViewedDate



Typetextarea



DescriptionAdditional information about a member’s maximum lifetime payments.

Typestring

Name


DescriptionName of these plan coverage benefits.

Typedouble



DescriptionThe amount a member contributes towards treatment undertaken bynon-preferred providers.

Typedouble

OutofNetworkCoinsurancePercentage



Typecurrency


728


DetailsField Name


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


DescriptionAdditional information about the out-of-pocket payment a member makes.

Typereference

OwnerId



Typecurrency

PrimaryCareCopay


DescriptionThe amount a member contributes towards primary care treatment.

Typereference

PurchaserPlanId


DescriptionThe ID of the purchaser plan offering these benefits.

Typestring

SourceSystem


DescriptionThe name of the system this benefits record came from.

729


DetailsField Name

Typestring




Typedate




Typecurrency

SpecialistCopay


DescriptionThe amount a member contributes towards specialist consultations.

Typepicklist

Status


DescriptionThe status of these benefits. The default the picklist values are:

• Active

• Inactive

Typecurrency

UrgentCareCopay


DescriptionThe amount a member contributes towards urgent care.


730


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.


Fields

DetailsField Name

Typestring

BenefitCategory


DescriptionName of the benefit category this item belongs to.

Typestring

CoverageLevel


DescriptionDescription of the level of coverage provided.

Typecurrency

InNetworkCoverage


DescriptionThe amount available to contribute towards treatment costs for each treatmentundertaken by the health plan’s preferred providers.

731


DetailsField Name

Typeboolean

IsInPlanNetwork



Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate



Typestring

Name


DescriptionName of this benefit item.

Typetextarea

Notes


DescriptionAdditional information about this benefit item.

Typecurrency



732


DetailsField Name

DescriptionThe amount available to contribute towards treatment costs for each treatmentundertaken by non-preferred providers.

Typereference

OwnerId



Typereference

PlanBenefitId


DescriptionThe ID of the benefit this item belongs to.

Typestring

ServiceType


DescriptionThe type of service this plan benefit item provides for.

Typestring

ServiceTypeCode


DescriptionThe code for the type of service this plan benefit item provides for.

Typestring

SourceSystem


DescriptionThe name of the system this benefits item record came from.

Typestring


733


DetailsField Name


DescriptionThe ID of this benefits item record on its source system.

Typedate



DescriptionThe date on which this benefits item was last updated from the source system.

Typestring

TimePeriod


DescriptionA description of the period during which services under this plan benefit itemare to be rendered or continued.


PlanBenefitItemFeedFeed tracking is available for the object.

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:

734


• 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.


Fields

DetailsField Name

Typepicklist

Affiliation



Typedate

EffectiveFrom

735



https://developer.salesforce.com/docs/atlas.en-us.238.0.api.meta/api/sforce_api_objects_account.htm



https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud.meta/health_cloud/admin_install_package.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_objects_accountcontactrelation.htm

DetailsField Name


DescriptionThe date from which this purchaser plan is effective.

Typedate

EffectiveTo


DescriptionThe date on which this purchaser plan ceases to be effective.

Typeboolean

IsVerifiable


DescriptionIndicates whether a benefits verification can be performed on this plan.

Typeboolean

IsVerifiable



Typestring

Name


DescriptionThe name of this plan.

Typetextarea

Notes


DescriptionNotes about this payer.

Typereference

Payer

736


DetailsField Name



Typestring

PlanNumber


DescriptionThe plan’s reference number.

Typepicklist

PlanStatus



Typepicklist

PlanType


DescriptionThe type of plan, with the following default options:

• PPO

• HMO

• Medicare

• Medicaid

• Workers Comp

Typestring

ServiceType


DescriptionThe description of the service type offered by this plan.

Typestring

SourceSystem

737


DetailsField Name



Typestring




TypedateTime





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.


738


Fields

DetailsField Name

Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate



Typestring

Name


DescriptionThe name of this purchaser to purchaser plan association.

Typereference

OwnerId



Typereference

PurchaserId


DescriptionThe ID of the plan purchaser’s Account object record.

Typereference

PurchaserPlanId

739


DetailsField Name


DescriptionThe ID of the associated plan on the Purchaser Plan object.

Typepicklist

Role


DescriptionIndicates whether the purchaser plays a primary or secondary role in the plan.

Typestring

SourceSystem



Typestring



DescriptionThe ID of this record on its source system.

TypedateTime



DescriptionThe date on which this item was last changed on the source system.

Typepicklist

Status


DescriptionIndicates whether this purchaser plan relationship is active.

740



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 Appointment ManagementHealth Cloud integrates with a customer’s appointment management system to provide a patient appointment booking experience inSalesforce for call center agents and care coordinators. The Health Cloud data model for appointments enables you to work with multiplesource systems operating on different electronic health record platforms.

741

Intelligent Appointment ManagementHealth Cloud Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_accountaccountrelation__c.htm



ApptBookingConfig

Represents a collection of fields to set up appointment scheduling. This object is available in API version 52.0 and later.

ApptBookingUrlConfig

Represents a collection of fields to set up the URL paths for appointment scheduling endpoints. This object is available in API version52.0 and later.

ClinicalEncounter

Represents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of apatient’s healthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. This objectis available in API version 51.0 and later.

WorkTypeCareSpecialty

Represents a relationship between a care specialty and a work type. This object is available in API version 52.0 and later.

WorkTypeCodeSetBundle

Represents a relationship between a code set and a work type. This object is available in API version 52.0 and later.

ApptBookingConfigRepresents a collection of fields to set up appointment scheduling. This object is available in API version 52.0 and later.


742


Fields

DetailsField

Typereference

ApexClassId


DescriptionThe Apex class that's used when scheduling an appointment using an external schedulingsystem. If this is not specified, the default Health Cloud-supplied Apex class is used.


Relationship NameApexClass


Refers ToApexClass

Typestring

AssignedProviderRole


DescriptionRole used in a Account Contact Relation record to associate a patient (account) with theirassigned provider (contact).

Typedouble

AttendanceThresholdPct


DescriptionPercentage of attended appointments above which a time slot is highlighted in the schedulingconsole.

Typestring

BestTimeSlotsDefinition


DescriptionID of the attendance prediction taken from Einstein Discovery.

Typestring

DeveloperName

743


DetailsField


Description

Note: Only users with View DeveloperName OR View Setup and Configurationpermission can view, group, sort, and filter this field.

Typepicklist

Language


Description


• af—Afrikaans

• am—Amharic

• ar—Arabic

• ar_AE—Arabic (United Arab Emirates)

• ar_BH—Arabic (Bahrain)

• ar_DZ—Arabic (Algeria)

• ar_EG—Arabic (Egypt)

• ar_IQ—Arabic (Iraq)

• ar_JO—Arabic (Jordan)

• ar_KW—Arabic (Kuwait)

• ar_LB—Arabic (Lebanon)

• ar_LY—Arabic (Libya)

• ar_MA—Arabic (Morocco)

• ar_OM—Arabic (Oman)

• ar_QA—Arabic (Qatar)

• ar_SA—Arabic (Saudi Arabia)

• ar_SD—Arabic (Sudan)

• ar_SY—Arabic (Syria)

• ar_TN—Arabic (Tunisia)

• ar_YE—Arabic (Yemen)

• bg—Bulgarian

• bn—Bengali

• bs—Bosnian

• ca—Catalan

• cs—Czech

• cy—Welsh

744


DetailsField

• da—Danish

• de—German

• de_AT—German (Austria)

• de_BE—German (Belgium)

• de_CH—German (Switzerland)

• de_LU—German (Luxembourg)

• el—Greek

• en_AU—English (Australian)

• en_CA—English (Canadian)

• en_GB—English (UK)

• en_HK—English (Hong Kong)

• en_IE—English (Ireland)

• en_IN—English (Indian)

• en_MY—English (Malaysian)

• en_NZ—English (New Zealand)

• en_PH—English (Phillipines)

• en_SG—English (Singapore)

• en_US—English

• en_ZA—English (South Africa)

• eo—Esperanto (Pseudo)

• es—Spanish

• es_AR—Spanish (Argentina)

• es_BO—Spanish (Bolivia)

• es_CL—Spanish (Chile)

• es_CO—Spanish (Colombia)

• es_CR—Spanish (Costa Rica)

• es_DO—Spanish (Dominican Republic)

• es_EC—Spanish (Ecuador)

• es_GT—Spanish (Guatemala)

• es_HN—Spanish (Honduras)

• es_MX—Spanish (Mexico)

• es_NI—Spanish (Nicaragua)

• es_PA—Spanish (Panama)

• es_PE—Spanish (Peru)

• es_PR—Spanish (Puerto Rico)

• es_PY—Spanish (Paraguay)

• es_SV—Spanish (El Salvador)

• es_US—Spanish (United States)

745


DetailsField

• es_UY—Spanish (Uruguay)

• es_VE—Spanish (Venezuela)

• et—Estonian

• eu—Basque

• fa—Farsi

• fi—Finnish

• fr—French

• fr_BE—French (Belgium)

• fr_CA—French (Canadian)

• fr_CH—French (Switzerland)

• fr_LU—French (Luxembourg)

• ga—Irish

• gu—Gujarati

• haw—Hawaiian

• hi—Hindi

• hr—Croatian

• ht—Haitian Creole

• hu—Hungarian

• hy—Armenian

• in—Indonesian

• is—Icelandic

• it—Italian

• it_CH—Italian (Switzerland)

• iw—Hebrew

• iw_EO—Esperanto RTL (Pseudo)

• ja—Japanese

• ka—Georgian

• kk—Kazakh

• km—Khmer

• kn—Kannada

• ko—Korean

• lb—Luxembourgish

• lt—Lithuanian

• lv—Latvian

• mi—Te reo

• mk—Macedonian

• ml—Malayalam

• mr—Marathi

746


DetailsField

• ms—Malay

• mt—Maltese

• my—Burmese

• nl_BE—Dutch (Belgium)

• nl_NL—Dutch

• no—Norwegian

• pl—Polish

• pt_BR—Portuguese (Brazil)

• pt_PT—Portuguese (European)

• rm—Romansh

• ro—Romanian

• ro_MD—Romanian (Moldova)

• ru—Russian

• ru_AM—Russian (Armenia)

• ru_BY—Russian (Belarus)

• ru_KG—Russian (Kyrgyzstan)

• ru_KZ—Russian (Kazakhstan)

• ru_LT—Russian (Lithuania)

• ru_MD—Russian (Moldova)

• ru_PL—Russian (Poland)

• ru_UA—Russian (Ukraine)

• sh—Serbian (Latin)

• sh_ME—Montenegrin

• sk—Slovak

• sl—Slovene

• sm—Samoan

• sq—Albanian

• sr—Serbian (Cyrillic)

• sv—Swedish

• sw—Swahili

• ta—Tamil

• te—Telugu

• th—Thai

• tl—Tagalog

• tr—Turkish

• uk—Ukrainian

• ur—Urdu

• vi—Vietnamese

747


DetailsField

• xh—Xhosa

• zh_CN—Chinese (Simplified)

• zh_HK—Chinese (Hong Kong)

• zh_MY—Chinese (Malaysia)

• zh_SG—Chinese (Singapore)

• zh_TW—Chinese (Traditional)

• zu—Zulu

Typestring

MasterLabel


Description

Typereference

NamedCredentialId


Description


Relationship NameNamedCredential


Refers ToNamedCredential

Typestring

ServiceApptRecordTypeName


Description

ApptBookingUrlConfigRepresents a collection of fields to set up the URL paths for appointment scheduling endpoints. This object is available in API version52.0 and later.


748


Fields

DetailsField

Typereference

ApptBookingConfigId


DescriptionThe appointment booking configuratin record associated with this record.


Relationship NameApptBookingConfig


Refers ToApptBookingConfig

Typestring

DeveloperName


Description


Typepicklist

EndpointName


DescriptionSpecifies the name of the endpoint to be called.


• CANCEL_APPOINTMENT

• CREATE_APPOINTMENT

• FIND_SLOTS

• GET_APPOINTMENT

• GET_SLOT_STATUS

Typepicklist

Language

749


DetailsField


Description


• af—Afrikaans

• am—Amharic

• ar—Arabic

• ar_AE—Arabic (United Arab Emirates)

• ar_BH—Arabic (Bahrain)

• ar_DZ—Arabic (Algeria)

• ar_EG—Arabic (Egypt)

• ar_IQ—Arabic (Iraq)

• ar_JO—Arabic (Jordan)

• ar_KW—Arabic (Kuwait)

• ar_LB—Arabic (Lebanon)

• ar_LY—Arabic (Libya)

• ar_MA—Arabic (Morocco)

• ar_OM—Arabic (Oman)

• ar_QA—Arabic (Qatar)

• ar_SA—Arabic (Saudi Arabia)

• ar_SD—Arabic (Sudan)

• ar_SY—Arabic (Syria)

• ar_TN—Arabic (Tunisia)

• ar_YE—Arabic (Yemen)

• bg—Bulgarian

• bn—Bengali

• bs—Bosnian

• ca—Catalan

• cs—Czech

• cy—Welsh

• da—Danish

• de—German

• de_AT—German (Austria)

• de_BE—German (Belgium)

• de_CH—German (Switzerland)

• de_LU—German (Luxembourg)

• el—Greek

• en_AU—English (Australian)

750


DetailsField

• en_CA—English (Canadian)

• en_GB—English (UK)

• en_HK—English (Hong Kong)

• en_IE—English (Ireland)

• en_IN—English (Indian)

• en_MY—English (Malaysian)

• en_NZ—English (New Zealand)

• en_PH—English (Phillipines)

• en_SG—English (Singapore)

• en_US—English

• en_ZA—English (South Africa)

• eo—Esperanto (Pseudo)

• es—Spanish

• es_AR—Spanish (Argentina)

• es_BO—Spanish (Bolivia)

• es_CL—Spanish (Chile)

• es_CO—Spanish (Colombia)

• es_CR—Spanish (Costa Rica)

• es_DO—Spanish (Dominican Republic)

• es_EC—Spanish (Ecuador)

• es_GT—Spanish (Guatemala)

• es_HN—Spanish (Honduras)


• es_NI—Spanish (Nicaragua)

• es_PA—Spanish (Panama)

• es_PE—Spanish (Peru)

• es_PR—Spanish (Puerto Rico)

• es_PY—Spanish (Paraguay)

• es_SV—Spanish (El Salvador)

• es_US—Spanish (United States)

• es_UY—Spanish (Uruguay)

• es_VE—Spanish (Venezuela)

• et—Estonian

• eu—Basque

• fa—Farsi

• fi—Finnish

• fr—French

• fr_BE—French (Belgium)

751


DetailsField

• fr_CA—French (Canadian)

• fr_CH—French (Switzerland)

• fr_LU—French (Luxembourg)

• ga—Irish

• gu—Gujarati

• haw—Hawaiian

• hi—Hindi

• hr—Croatian

• ht—Haitian Creole

• hu—Hungarian

• hy—Armenian

• in—Indonesian

• is—Icelandic

• it—Italian

• it_CH—Italian (Switzerland)

• iw—Hebrew

• iw_EO—Esperanto RTL (Pseudo)

• ja—Japanese

• ka—Georgian

• kk—Kazakh

• km—Khmer

• kn—Kannada

• ko—Korean

• lb—Luxembourgish

• lt—Lithuanian

• lv—Latvian

• mi—Te reo

• mk—Macedonian

• ml—Malayalam

• mr—Marathi

• ms—Malay

• mt—Maltese

• my—Burmese

• nl_BE—Dutch (Belgium)

• nl_NL—Dutch

• no—Norwegian

• pl—Polish


752


DetailsField

• pt_PT—Portuguese (European)

• rm—Romansh

• ro—Romanian

• ro_MD—Romanian (Moldova)

• ru—Russian

• ru_AM—Russian (Armenia)

• ru_BY—Russian (Belarus)

• ru_KG—Russian (Kyrgyzstan)

• ru_KZ—Russian (Kazakhstan)

• ru_LT—Russian (Lithuania)

• ru_MD—Russian (Moldova)

• ru_PL—Russian (Poland)

• ru_UA—Russian (Ukraine)

• sh—Serbian (Latin)

• sh_ME—Montenegrin

• sk—Slovak

• sl—Slovene

• sm—Samoan

• sq—Albanian

• sr—Serbian (Cyrillic)

• sv—Swedish

• sw—Swahili

• ta—Tamil

• te—Telugu

• th—Thai

• tl—Tagalog

• tr—Turkish

• uk—Ukrainian

• ur—Urdu

• vi—Vietnamese

• xh—Xhosa


• zh_HK—Chinese (Hong Kong)

• zh_MY—Chinese (Malaysia)

• zh_SG—Chinese (Singapore)


• zu—Zulu

753


DetailsField

Typestring

MasterLabel


Description

Typestring

UrlPath


DescriptionThe URL path for the endpoint.

ClinicalEncounterRepresents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of a patient’shealthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. This object is availablein API version 51.0 and later.


Fields

DetailsField

Typepicklist

AdmissionSource


DescriptionSpecifies the source of the admission.


• Another Hospital

• Emergency Department

• General Practitioner Referral

• In-Hospital Birth

• Nursing Home

• Other

754


DetailsField

• Other Medical Practitioner Referral

• Outpatient Department

• Psychiatric Hospital

• Rehabilitation Facility

Typepicklist

Category


DescriptionSpecifies the classification of the encounter.


• Ambulatory

• Emergency

• Home Health

• Inpatient Encounter

Typereference

DestinationFacilityId


DescriptionThe facility to which the patient is transferred.

Referenced Objects


Typereference



DescriptionThe organization to which the patient is transferred.

Referenced Objects

• Account

Typemultipicklist

DietPreference


755


DetailsField

DescriptionThe diet preferences of the patient.


• Dairy-Free

• Gluten-Free

• Halal

• Kosher

• Nut-Free

• Vegan

• Vegetarian

Typereference

DischargeDispositionId


DescriptionThe status of the patient at discharge.

Referenced Objects

• CodeSetBundle

Typedouble

Duration


DescriptionThe duration of the patient encounter, in the given unit of measure.

Typereference

DurationUnitId


DescriptionThe unit of measurement for the encounter duration.

Referenced Objects

• UnitOfMeasure

TypedateTime

EndDate


756


DetailsField

DescriptionThe date on which the encounter ended.

Typereference

FacilityId


DescriptionThe facility where the encounter took place.

Referenced Objects


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the clinical encouter record.

Typereference

PatientId


DescriptionThe patient receiving the treatment.

Referenced Objects

• Account

757


DetailsField

Typereference

PreAdmissionIdentifierId


DescriptionThe identifier for the encounter pre-admission.

Referenced Objects

• ClinicalEncounterIdentified

Typereference

PreviousFacilityId


DescriptionThe patient's location before the admission.

Referenced Objects


Typereference

PreviousOrganizationId


DescriptionThe name of the organization where the patient was previously located.

Referenced Objects

• Account

Typereference

PriorityId


DescriptionThe system-defined code that represents the priority associated with the urgency of theencounter.

Referenced Objects

• CodeSetBundle

Typereference

ReadmissionCodeId

758


DetailsField


DescriptionThe system-defined code for the readmission.

Referenced Objects

• CodeSetBundle

Typereference

RelatedClinicalEncounterId


DescriptionSpecifies an encounter that is related to this encounter.

Referenced Objects


Typereference

ServiceAppointment


DescriptionThe appointment associated with this clinical encounter.

Referenced Objects


Typepicklist

ServiceType


DescriptionSpecifies the classification of the type of service.


• Homoeopathy

• Meditation

• Naturopathy

• Reflexology

Typestring

SourceSystem

759


DetailsField



Typestring




TypedateTime




Typepicklist

SpecialCourtesy


DescriptionSpecifies a class of courtesy extended to the patient.


• Extended

• Normal

• Professional

• Staff

• Unknown

• VIP

TypedateTime

StartDate


DescriptionThe date on which the encounter began.

760


DetailsField

Typepicklist

Status


DescriptionSpecifies the status of the patient encounter.


• Arrived

• Cancelled

• Finished

• In Progress

• Planned

• Triaged

Typereference

TypeId


DescriptionThe system-defined code that represents the type of the encounter.

Referenced Objects

• CodeSetBundle

Additional Information for ClinicalEncounter in Other ObjectsIn addition to creating a record using these fields, you can add more details to your ClinicalEncounter record by creating records incertain other objects, and referencing your ClinicalEncounter record as the parent record. Here’s the list of objects you can associate toClinicalEncounter in this way, the type of information they add, and the field they use to reference ClinicalEncounter.


ClinicalEncounterIdSpecifies the different diagnoses from anencounter, and other diagnosis-relatedinformation.


ClinicalEncounterIdSpecifies the different healthcare facilitiesinvolved in an encounter, and other detailsrelevant to the facility and the encounter.


ClinicalEncounterIdSpecifies identifiers for the encounter. Theobject is very similar to the standard


Identifier object, but is exclusive toClinicalEncounter.

761



ClinicalEncounterIdSpecifies the different providers involved inan encounter and the details of theirinvolvement.


ClinicalEncounterIdSpecifies the reasons for why the encounterhappened or was required.


ClinicalEncounterIdSpecifies service requests that the encounterwas based on.



ClinicalEncounterFeedFeed tracking is available for the object.

ClinicalEncounterHistoryHistory is available for tracked fields of the object.

WorkTypeCareSpecialtyRepresents a relationship between a care specialty and a work type. This object is available in API version 52.0 and later.


Fields

DetailsField

Typereference

CareSpecialtyId


Description


Relationship NameCareSpecialty


Refers ToCareSpecialty

762


DetailsField

TypedateTime

LastReferencedDate


Description

TypedateTime

LastViewedDate


Description

Typestring

Name


Description

Typereference

WorkTypeId


Description


Relationship NameWorkType


Refers ToWorkType

WorkTypeCodeSetBundleRepresents a relationship between a code set and a work type. This object is available in API version 52.0 and later.


763


Fields

DetailsField

Typereference

AppointmentTypeId


Description


Relationship NameAppointmentType


Refers ToCodeSetBundle

Typestring

FlowName


Description

TypedateTime

LastReferencedDate


Description

TypedateTime

LastViewedDate


Description

Typestring

Name


Description

Typereference

ParentId

764


DetailsField


Description


Relationship NameParent


Refers ToWorkType

Typepicklist

SchedulingSystem


Description


• External

• Salesforce

The default value is 'External'.

Typereference

ServiceCategoryId


Description


Relationship NameServiceCategory



Typereference

ServiceTypeId


765


DetailsField

Description


Relationship NameServiceType



Home Health CareUse the Home Health Care data objects to manage information about patient intake, assignment and care in home health environments.

The home health care data objects are visible to users with the Health Cloud and the Health Cloud Platform permission set licenses andthe Health Cloud Permission Set License permission set. You must have the Health Cloud managed package installed in your org toaccess the home health data model. Available in API version 47.0 and later.

ReceivedDocument

Contains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction. This object isavailable in API version 50.0 and later.

OcrDocumentScanResult

Represents the contents of a document after optical character recognition (OCR) processing. This object is available in API version50.0 and later.

DocumentChecklistItem

Represents a checklist item for a documentation file upload. This object is available in API version 47.0 and later.

ReceivedDocumentContains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction. This object is availablein API version 50.0 and later.


Fields

DetailsField

Typepicklist

Direction

766

Home Health CareHealth Cloud Developer Guide

DetailsField


DescriptionSpecifies whether the org is receiving or sending the document.


• INCOMING—Incoming

• OUTGOING—Outgoing

Typestring

DocumentNumber


DescriptionUnique document identification number.

Typeboolean

HasAutoOcrDisabled

PropertiesCreate, Defaulted on create, Filter, Group, Sort

DescriptionDetermines whether text is extracted from the document automatically. Default is False.

Typeboolean

IsActive


DescriptionSpecifies whether the document is being processed.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


767


DetailsField


Typestring

Name


DescriptionThe name of the received document.

Typepicklist

OcrStatus

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

DescriptionCurrent state of the text extraction process.

Possible values are: Draft, Approved, In Approval, In Review, Obsolete, Superseded, Archived.Default is Draft.

Typereference

OwnerId


Description

Typepicklist

Priority


DescriptionDetermines the order in which the document is processed when it is part of a queue.


• ONE—1

• THREE—3

• TWO—2

Typestring

Source


768


DetailsField

DescriptionOrigin of the incoming document. Can be used to specify processing priority.

Typepicklist

Status


DescriptionCurrent stage of processing.


• APPROVED—Approved

• ARCHIVED—Archived

• DRAFT—Draft

• IN_REVIEW—In Review

• OBSOLETE—Obsolete

• SUPERSEDED—Superseded

OcrDocumentScanResultRepresents the contents of a document after optical character recognition (OCR) processing. This object is available in API version 50.0and later.


Fields

DetailsField

Typereference

ContentVersionId


DescriptionUnique identifier for the current version of the data.

Typereference

DocumentRequestId

769


DetailsField


DescriptionUnique identifier for a document request.

Typetextarea

ExtractedValues

PropertiesNillable

DescriptionData extracted from the document. Data type StringPlusClob, maximum length131072.

Note: This field is encryptable with Salesforce Platform Encryption.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the record.

Typepicklist

OcrService

PropertiesDefaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

770


DetailsField

DescriptionRecords the service that performed the text extraction.


• AMAZON_TEXTRACT—Amazon Textract

• E.AI

Typepicklist

OcrStatus


DescriptionCurrent phase of OCR processing.


• ERROR—Error

• OCR_ENQUEUE—OCR Enqueue

• SUCCESS—Success

Typereference

OwnerId


Description

Typeint

PageNumber


Description

Typeint

Rotation


DescriptionDegrees of rotation requested. Can be 0, 90, 180, or 270.

DocumentChecklistItemRepresents a checklist item for a documentation file upload. This object is available in API version 47.0 and later.

771


Supported CallsdescribeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

Fields

DetailsField

Typereference

AccountId


DescriptionThe ID of the account the document checklist item belongs to.

Typereference

DocumentTypeId


DescriptionID of the document type for the document checklist item.

Typetextarea

Instruction


DescriptionInstructions associated with the document checklist item.

Typeboolean

IsAccepted


DescriptionIndicates whether the file has been accepted. The default value is False.

Typeboolean

IsFrozen


DescriptionIndicates that the item can no longer be modified. The default value is False.

772


DetailsField

Typeboolean

IsRequired

PropertiesCreate, Defaulted on create, Filter, Group, Sort

DescriptionIndicates if the document checklist item is required. The default value is False.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the document checklist item.

Typereference

OwnerId


DescriptionID of the user who owns this record.

Typereference

ParentRecordId

PropertiesCreate, Filter, Group,, Sort, Update

773


DetailsField

DescriptionOriginal parent object the document checklist item belonged to.

Typepicklist

Status


DescriptionUploaded document checklist item status.


• Accepted

• New

• Pending

• Rejected

The default value is New.

Typereference

UploadedById


DescriptionPerson who uploaded the file.

Typereference

WhoId


DescriptionPerson that the uploaded documentation pertains to.


DocumentChecklistItemFeedFeed tracking is available for the object.

DocumentChecklistItemHistoryHistory is available for tracked fields of the object.

DocumentChecklistItemOwnerSharingRuleSharing rules are available for the object.

774


DocumentChecklistItemShareSharing is available for the object.

Intelligent Sales

EDITIONS


Help your 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.

ActionPlanTemplateItem

Represents the instance of an item on an action plan template version. This object is used by more than one cloud in Industries.

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.

ActionPlanTemplateItem

Represents the instance of an item on an action plan template version. This object is used by more than one cloud in Industries.

Address

Represents a mailing, billing, or home address.

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.

775

Intelligent SalesHealth Cloud Developer Guide

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.

ProductRequest

Stores additional information related to a product transfer request. This object is available in Health Cloud in API version 50.0 andlater.

ProductRequestLineItem

A junction object between ProductRequest and ProductTransfer This object is available Health Cloud in API version50.0 and later.

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.

SerializedProduct

Records serial numbers for each individual product in an inventory. This object is available in API version 50.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:

User Personas for Intelligent Sales

The Intelligent Sales Data Model

Health Cloud Developer Guide: Creating Visits

ActionPlanTemplateItemRepresents the instance of an item on an action plan template version. This object is used by more than one cloud in Industries.

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

776


https://help.salesforce.com/apex/HTViewHelpDoc?id=admin_intelligent_sales.htm&language=en_US#admin_intelligent_sales

https://help.salesforce.com/apex/HTViewHelpDoc?id=admin_intelligent_sales_data_model.htm&language=en_US#admin_intelligent_sales_data_model

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_create_visit.htm

Fields

DetailsField Name

Typereference

ActionPlanTemplateVersionId


Description

The version of the action plan template this item is for.

Typeint

DisplayOrder


Description

The order in which this item is displayed within the action plan template version.

Typeboolean

IsActive


Description

Indicates whether the task created from this template item is active.

Typeboolean

IsRequired


Description

Indicates whether the task created from this template item is required.

Typepicklist

ItemEntityType


Description

The type of action plan template item entity. Always set to Task. Possible valuesare:

• Assessment Task

• RecordAction

• Signature Task

777


DetailsField Name

• Task

TypedateTime

LastReferencedDate


Description

The most recent date on which a user referenced this record.

TypedateTime

LastViewedDate


Description

The most recent date on which a user viewed this record.

Typestring

Name


Description

The unique identifier for this action plan template item record.

Typestring

UniqueName


DescriptionThe unique name for this action plan template item. This field is unique withinyour organization.

actionplantemplateDefines a template for different assessment tasks in a visit. This object is available in API version 49.0 and later in Health Cloud.


778


Fields

DetailsField

Typepicklist

ActionPlanType

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

DescriptionSpecifies the type of action plan you’re creating.


• Industries

• Visit Execution

For Intelligent Sales, select only Visit Execution.

Typetextarea

Description


DescriptionThe description for your action plan template.

Typeboolean

IsAdHocItemCreationEnabled


DescriptionIndicates whether ad-hoc creation of tasks is possible.

TypedateTime

LastReferencedDate


DescriptionThe time stamp for the last time this record was referenced.

TypedateTime

LastViewedDate


DescriptionThe time stamp for the last time this record was viewed.

779


DetailsField

Typestring

Name


DescriptionThe name for your action plan template

Typereference

OwnerId


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.


• Account

• BusinessMilestone—Business Milestone

• Case

• Contact

• Contract

• Lead

• Opportunity

• PersonLifeEvent

• Person Life Event

• Visit

For Intelligent Sales, use only Visit.

Typestring

UniqueName


DescriptionThe unique name for your action plan template.

780


ActionPlanTemplateItemRepresents the instance of an item on an action plan template version. This object is used by more than one cloud in Industries.

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

Fields

DetailsField Name

Typereference

ActionPlanTemplateVersionId


Description

The version of the action plan template this item is for.

Typeint

DisplayOrder


Description

The order in which this item is displayed within the action plan template version.

Typeboolean

IsActive


Description

Indicates whether the task created from this template item is active.

Typeboolean

IsRequired


Description

Indicates whether the task created from this template item is required.

Typepicklist

ItemEntityType

781


DetailsField Name


Description

The type of action plan template item entity. Always set to Task. Possible valuesare:

• Assessment Task

• RecordAction

• Signature Task

• Task

TypedateTime

LastReferencedDate


Description

The most recent date on which a user referenced this record.

TypedateTime

LastViewedDate


Description

The most recent date on which a user viewed this record.

Typestring

Name


Description

The unique identifier for this action plan template item record.

Typestring

UniqueName


DescriptionThe unique name for this action plan template item. This field is unique withinyour organization.

782


AddressRepresents a mailing, billing, or home address.


Special Access RulesThe following access checks must be enabled:

• Industries Insurance

• Retail Execution

• IndustriesVisit

• Field Service

• Order Management

– Perms: FulfillmentOrder, OrderSummary,AdvancedOrderManagement, OrderCCS

– Prefs: OrdersEnabled, EnhancedCommerceOrders

• Public Sector

• Employee Experience

• Contact Tracing For Employees

Fields

DetailsField Name

Typeaddress

Address


DescriptionThe full address.

Typepicklist

AddressType


DescriptionPicklist of address types. The values are:

• Mailing

• Shipping

• Billing

783


DetailsField Name

• Home

Typestring

City


DescriptionThe address city.

Typestring

Country


DescriptionThe address country.

Typestring

Description


DescriptionA brief description of the address.

Typestring

DrivingDirections


DescriptionDirections to the address.

Typepicklist

GeocodeAccuracy


DescriptionThe level of accuracy of a location’s geographical coordinates compared with itsphysical address. A geocoding service typically provides this value based on theaddress’s latitude and longitude coordinates.

Typedouble

Latitude

784


DetailsField Name


DescriptionUsed with Longitude to specify the precise geolocation of the address.Acceptable values are numbers between –90 and 90 with up to 15 decimalplaces.

Typepicklist

LocationType

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

DescriptionPicklist of location types. The available values are:

• Warehouse (default)

• Site

• Van

• Plant

Typedouble

Longitude


DescriptionUsed with Latitude to specify the precise geolocation of the address.Acceptable values are numbers between –180 and 180 with up to 15 decimalplaces.

Typestring

Name


DescriptionName of the address.

Typereference

ParentId


DescriptionA lookup field to the parent location.


785


DetailsField Name

Relationship NameParent


Refers ToLocation

Typestring

PostalCode


DescriptionThe address postal code.

Typestring

State


DescriptionThe address state.

Typetextarea

Street


DescriptionThe address street.

Typepicklist

TimeZone


DescriptionPicklist of available time zones.

Usage

Important: “Address” in Salesforce can also refer to the Address compound field found on many standard objects. When referencingthe Address object in your Apex code, always use Schema.Address instead of Address to prevent confusion with thestandard Address compound field. If referencing both the address object and the Address field in the same snippet, you candifferentiate between the two by using System.Address for the field and Schema.Address for the object.

786


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.


Fields

DetailsField

Typereference

AssessmentTaskDefinitionId


DescriptionThe assessment task definition that is referenced for the task.

Typetextarea

Description


DescriptionDescription of task that has to be performed at the store.

TypedateTime

EndTime


DescriptionTime when the task was completed by a field rep.

Typeboolean

IsRequired


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

787


DetailsField



TypedateTime

LastViewedDate



Typestring

Name


DescriptionUnique identification of the task.

Typereference

OwnerId


DescriptionID of the assessment task record owner.

Typereference

ParentId


DescriptionThe visit associated with an assessment task.This field is available in API version 48.0 andlater.

Typeint

SequenceNumber


DescriptionThe sequence in which the tasks must be performed. This field is available in API version 48.0and later.

788


DetailsField

TypedateTime

StartTime


DescriptionTime when the task was started by a field rep.

Typepicklist

Status


DescriptionView the status of a task. This field is available in API version 48.0 and later.


• 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.


• ConductInStoreSurveys

• InventoryCheck

• Other

• PlaceOrder

• PlanogramCheck

• PromotionCheck


• AssessmentTaskShare on page 1199

• AssessmentTaskFeed on page 1185

789


Pricebook2Represents a price book that contains the list of products that your org sells.


Fields

DetailsField

Typestring

Description


DescriptionText description of the price book.

Typeboolean

IsActive


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.

790


DetailsField

Typeboolean

IsStandard


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.

Typestring

Name


DescriptionRequired. Name of this object. This field is read-only for the standard price book. Label isPrice Book Name.


Pricebook2HistoryHistory is available for tracked fields of the object.

Product2Represents a product that your org sells.


Fields

DetailsField

Typetextarea

Description


DescriptionA text description of this record. Label is Product Description.

791


DetailsField

Typeurl

DisplayUrl


DescriptionURL leading to a specific version of a record in the linked external data source.

Typereference

ExternalDataSourceId


DescriptionID of the related external data source.

Typestring

ExternalId


DescriptionThe unique identifier of a record in the linked external data source. For example, ID #123.

Typepicklist

Family


DescriptionName of the product family associated with this record. Product families are configured aspicklists in the user interface. Label is Product Family.

Typeboolean

IsActive


DescriptionIndicates whether this record is active.

Typeboolean

IsArchived


792


DetailsField

DescriptionIndicated whether the product is archived.

Typeboolean

IsSerialized


DescriptionIndicates whether the product supports serial numbers. If an associated product item recordalready exists, this boolean can’t be set to true unless the product item’s quantity is zero.

TypedateTime

LastReferencedDate


Description

Time stamp for the last time this record was referenced.

TypedateTime

LastViewedDate


Description

Time stamp for the last time this record was viewed.

Typestring

Name


DescriptionRequired. Default name of this record. Label is Product Name.

Typestring

ProductCode


DescriptionDefault product code for this record. Your org defines the product code naming pattern.

Typepicklist

QuantityUnitOfMeasure

793


DetailsField


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


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.


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


DescriptionIndicates whether this price book entry is active.

794


DetailsField

Typeboolean

IsArchived


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


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.

Typereference

Pricebook2Id


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


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


DescriptionProduct code for this record. This read-only field references the value in the ProductCodefield of the associated product record.

795


DetailsField

Typecurrency

UnitPrice


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


DescriptionIndicates whether this price book entry uses the standard price defined in the standard pricebook record.

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).


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.


796


Fields

DetailsField

Typereference

AccountId


DescriptionThe business account a field rep is responsible for visiting.

Typereference

FulfillmentLocationId


DescriptionThe inventory location from which an order will be fulfilled.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

LocationId


DescriptionThe location of the account the field rep visits.

Typestring

Name


797


DetailsField

DescriptionThe name of the Product Fulfillment Location record.

Typereference

ProductId


DescriptionThe name of the product the field rep fulfills at the account.

Typereference

UserId


DescriptionThe field rep responsible for the account and inventory.

ProductItemRepresents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse.


Special Access RulesField Service must be enabled.

Fields

DetailsField Name

TypedateTime

LastReferencedDate


DescriptionThe date when the product item was last modified. Its label in the user interfaceis Last Modified Date.

798


DetailsField Name

TypedateTime

LastViewedDate


DescriptionThe date when the product item was last viewed.

Typereference

LocationId


DescriptionLocation associated with the product item. This usually indicates where theproduct item is stored.

Typereference

OwnerId


DescriptionThe product item’s owner.

Typereference

Product2Id


DescriptionProduct associated with the product item, which represents the type of productin your inventory.

Typestring

ProductItemNumber


Description(Read Only) Auto-generated number identifying the product item.

Typestring

ProductName


799


DetailsField Name

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


DescriptionThe quantity at the location. If you want to add a serial number, this value mustbe 1.

Typepicklist



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.

Typestring

SerialNumber


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.


ProductItemFeedFeed tracking is available for the object.

ProductItemHistoryHistory is available for tracked fields of the object.

ProductItemOwnerSharingRuleSharing rules are available for the object.

800


ProductItemShareSharing is available for the object.

ProductRequestStores additional information related to a product transfer request. This object is available in Health Cloud in API version 50.0 and later.


Fields

DetailsField

TypedateTime

LastReferencedDate


DescriptionThe last date and time this record was referenced.

TypedateTime

LastViewedDate


DescriptionThe last date and time this record was viewed.

TypedateTime

NeedByDate


DescriptionThe date specified as required in a transfer request.

Typereference

OwnerId


DescriptionReferenced the owner of the record.

801


DetailsField

Typestring

ProductRequestNumber


DescriptionAn auto-generated name for the record.

Typepicklist

Status


DescriptionThe status of the request.


• Draft

• Received

• Submitted

ProductRequestLineItemA junction object between ProductRequest and ProductTransfer This object is available Health Cloud in API version 50.0and later.


Fields

DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

802


DetailsField



TypedateTime

NeedByDate


DescriptionThe date specified as required in a transfer request.

Typereference

ParentId


DescriptionReference to the parent ProductRequest record.

Typereference

Product2Id


DescriptionReference to the product requested.

Typestring

ProductRequestLineItemNumber


DescriptionName of this record. This is auto-generated.

Typedouble

QuantityRequested


DescriptionThe quantity that was requested.

Typepicklist


803


DetailsField


DescriptionThe unit of the quantity requested.


• Each

productrequiredRepresents a product that is needed to complete a visit.


Fields

DetailsField

TypedateTime

LastReferencedDate


DescriptionThe date when the product required was last modified. Its label in the user interface is LastModified Date.

TypedateTime

LastViewedDate


DescriptionThe date when the product required was last viewed.

Typereference

ParentRecordId


DescriptionThe work order or work order line item that the product is required for.

804


DetailsField

Typestring

ParentRecordType


DescriptionIndicates whether the parent record is a work order or a work order line item.

Typereference

Product2Id


DescriptionThe required product.

Typestring

ProductName


DescriptionThe name of the product required.

Typestring

ProductRequiredNumber


Description(Read only) Auto-generated number identifying the product required.

Typedouble

QuantityRequired


DescriptionQuantity required of the product.

Typepicklist



DescriptionUnits of the required product

805


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.


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.


Fields

DetailsField

Typetextarea

Description


DescriptionDetails not recorded in the provided fields.

Typereference

DestinationLocationId


DescriptionThe place the product is to be delivered.

TypedateTime

ExpectedPickupDate

806


DetailsField


DescriptionThe date that the transfer is being requested for.

Typeboolean

IsReceived


DescriptionCheckbox identifying that the product was received.

TypedateTime

LastReferencedDate


DescriptionThe date when the product request was last modified. Its label in the user interface is LastModified Date.

TypedateTime

LastViewedDate


DescriptionThe date when the product request was last viewed.

Typereference

OwnerId


DescriptionOwner of the product transfer.

Typereference

Product2Id


DescriptionLookup field for the product associated with the product transfer.

807


DetailsField

Typestring

ProductTransferNumber


DescriptionAn auto-assigned number that identifies the product transfer.

Typedouble

QuantityReceived


DescriptionAmount of product received at the destination location.

Typedouble

QuantitySent


DescriptionAmount of product that’s being requested.

Typepicklist



DescriptionThe units of the product, for example grams, liters, or units.

Typereference

ReceivedById


DescriptionLookup field for the person who received the product at the destination location.

TypedateTime

ShipmentExpectedDeliveryDate


DescriptionThe date for which the transfer is being accepted..

808


DetailsField

Typereference

SourceLocationId


DescriptionReference to the location of the inventory making the transfer.

Typereference

SourceProductItemId


DescriptionReference to the inventory making the transfer.

Typepicklist

Status


DescriptionThe status of the transfer request.


• Accepted

• Rejected

• Requested


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.

809


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()

Special Access RulesAs of Summer ’20 and later, only authenticated internal and external users can access this object.

Fields

DetailsField

Typepicklist

ActionDefinition


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.

Typepicklist

ActionType


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


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.

810


DetailsField

Typereference

FlowInterviewId


DescriptionOptional. The flow interview ID of the paused or completed flow. This field can’t be set inProcess Builder.


Relationship NameFlowInterview


Refers ToFlowInterview

Typeboolean

IsMandatory


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


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


DescriptionRequired. The order of the action among all actions associated with this record.

811


DetailsField

Typepicklist

Pinned


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


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.


Relationship NameRecord


Refers ToAccount, Address, Asset, AssetRelationship, AssignedResource, AssociatedLocation, Campaign,CampaignMember, CarePreauth, CarePreauthItem, Case, ChangeRequest, CollaborationGroup,Contact, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem,EnhancedLetterhead, Incident, Lead, Location, MemberPlan, OperatingHours, Opportunity,Order, PlanBenefit, PlanBenefitItem, Problem, Pricebook2, PricebookEntry, Product2,ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem,ProductRequired, ProductTransfer, PurchaserPlan, PurchaserPlanAssn,RebateMemberAggregateItem, ResourceAbsence, ResourcePreference, ReturnOrder,ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill,ServiceTerritory, ServiceTerritoryMember, Shipment, SkillRequirement, SocialPersona,SocialPost, TimeSlot, User, Visit, VoiceCall, WorkOrder, WorkOrderLineItem, WorkType,WorkTypeGroup

ChangeRequest, Incident, Problem are available in API version 53.0 and later.

RebateMemberAggregateItem is available in API version 54.0 and later.

812


https://developer.salesforce.com/docs/atlas.en-us.238.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/guided_engagement_support.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/guided_engagement_support.htm

DetailsField

Typepicklist

Status


DescriptionRequired. The current state of the action. Possible values are:

• New (default)

• 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

813


https://developer.salesforce.com/docs/atlas.en-us.238.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/salesforce_guided_engagement.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.salesforce_guided_engagement.meta/salesforce_guided_engagement/salesforce_guided_engagement.htm

.create(new SObject[] { newRecordAction });} catch (ConnectionException ce) {

ce.printStackTrace();}

}

Data Model


RecordActionHistoryHistory is available for tracked fields of the object.

SerializedProductRecords serial numbers for each individual product in an inventory. This object is available in API version 50.0 and later.


814


Fields

DetailsField

Typereference

AssetId


DescriptionReference to an asset record. This is currently not used.

Typedate

ExpirationDate


DescriptionThe date the product expires.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the serialized product record. This is auto-generated.

Typereference

OwnerId


815


DetailsField

DescriptionReference to the owner of the record.

Typereference

Product2Id


DescriptionThe product that is serialized.

Typereference

ProductItemId


DescriptionReference to the inventory, a product item record, this serialized product belongs to.

Typestring

SerialNumber


DescriptionThe serial number of the product.

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.


Fields

DetailsField

Typereference

AccountId


816


DetailsField

DescriptionThe account that is associated with a visit.

TypedateTime

ActualVisitEndTime


DescriptionThe date and time when the visit ended.

TypedateTime

ActualVisitStartTime


DescriptionThe date and time when the visit started.

Typetextarea

InstructionDescription


DescriptionSpecial instructions provided by a sales manager or an admin that a sales rep refers to duringa visit.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

817


DetailsField


DescriptionUnique identifier for the visit record.

Typereference

OwnerId


DescriptionID of the visit record owner.

Typereference

PlaceId


DescriptionID of the place that sales reps visit.

TypedateTime

PlannedVisitEndTime


DescriptionThe date and time when the visit is expected to end.

TypedateTime

PlannedVisitStartTime


DescriptionThe date and time when the visit is expected to start.

Typepicklist

Status


DescriptionThe status of a visit.


• Abandoned

818


DetailsField

• Completed

• InProgress

• Planned

Typetextarea

StatusRemarks


DescriptionThe reasons for abandoning or completing the visit as provided by the sales rep.

Typepicklist

VisitPriority


DescriptionThe priority of the visit.


• High

• Low

• Medium

Typereference

VisitorId


DescriptionID of the sales representative visiting the store.


• VisitShare on page 1199

• VisitFeed on page 1185

VisitedPartyRepresents the contact person at the account that’s being visited. This object is available in API version 49.0 and later.

819



Fields

DetailsField

Typereference

ContactId


DescriptionLookup to the person assigned as the contact at an account. This field references theContact object.

Typeboolean

IsPrimaryContact


DescriptionIndicates whether the person is the primary visited party.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the visited party.

820


DetailsField

Typereference

VisitId


DescriptionLookup to the Visit record this person is associated with.


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.


Fields

DetailsField

Typereference

AssigneeId


DescriptionLookup to the person assigned as the visitor. This fields references the User,ServiceResource, and Contact objects.

Typeboolean

IsPrimaryResource


DescriptionIndicates whether the visitor is the primary visitor for a visit.

821


DetailsField

Typeboolean

IsRequired


DescriptionIndicates whether the user is a required visitor for the visit.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the visitor.

Typereference

VisitId


DescriptionLookup to the Visit record this visitor is associated with.


VisitorHistoryHistory is available for the object.

822


VisitorFeedFeed tracking is available for the object.

Medication ManagementThe Medication Management data model provides objects to enable providers and care coordinators to perform a comprehensivemedication reconciliation of their patients’ medication regimen whenever there’s a transition of care. The data model provides objectsfor managing information on medication reconciliations and medication recommendations added for patients.

You must have the Health Cloud managed package installed in your org to access the clinical data model. To use the MedicationManagement add-on, you must also have the Health Cloud Medication Reconciliation Add On license, Health Cloud MedicationReconciliation platform license, and Health Cloud Medication Reconciliation user permission set license.

The objects in the shaded box are available with the Medication Management Add-On. All other objects for Medication Review andMedication Management are part of the Clinical Data Model on page 126.

MedicationReconciliation

Stores information about a medication reconciliation conducted for a patient This object is available in API version 54.0 and later.

MedReconRecommendation

Stores information about a medication recommendation and associates a recommendation to a medication reconciliation. Thisobject is available in API version 54.0 and later.

MedReconStmtRecommendation

Associates a medication recommendation to a medication statement and medication reconciliation. This object is available in APIversion 54.0 and later.

823

Medication ManagementHealth Cloud Developer Guide

MedicationReconciliationStores information about a medication reconciliation conducted for a patient This object is available in API version 54.0 and later.


Fields

DetailsField

Typereference

ConductedById


DescriptionThe user who started the medication reconciliation for the patient.


Relationship NameConductedBy


Refers ToUser

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

824


DetailsField


DescriptionThe name of the medication reconciliation.

Typereference

PatientId


DescriptionThe patient for whom the medication reconciliation is performed.



Relationship TypeMaster-Detail

Refers ToAccount

TypedateTime

ProcessEndDateTime


DescriptionThe date and time when the medication reconciliation process for the patient was completed.

TypedateTime

ProcessStartDateTime


DescriptionThe date and time when the medication reconciliation process for the patient was started.

TypedateTime




825


DetailsField

Typestring

SourceSystem



Typestring




Typepicklist

Status


DescriptionThe status of the medication reconciliation.


• Cancelled

• Completed

• InProgress


MedicationReconciliationFeed on page 1185Feed tracking is available for the object.

MedicationReconciliationHistory on page 1193History is available for tracked fields of the object.

MedReconRecommendationStores information about a medication recommendation and associates a recommendation to a medication reconciliation. This objectis available in API version 54.0 and later.

826



Fields

DetailsField

Typetextarea

Description


DescriptionA description of the medication recommendation added to the patient.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedicationReconciliationId


DescriptionThe medication reconciliation with which the medication recommendation is associated.


Relationship NameMedicationReconciliation


Refers ToMedicationReconciliation

827


DetailsField

Typestring

Name


DescriptionThe name of the medication recommendation.

Typetextarea

NoteForPatient


DescriptionRecommendation notes to provide additional information to the patient.

Typetextarea

NoteForProvider


DescriptionRecommendation notes to provide additional information to the provider.

Typepicklist

Priority


DescriptionThe priority level of the medication recommendation.


• High - Within 24 Hours

• Low - Within a Month

• Medium - Within 2 Weeks

Typepicklist

RecommendationReasonSubtype


DescriptionA further categorization of the recommendation reason type.


• Allergy

828


DetailsField

• Alternative

• Side-effects of treatment

• Suboptimal Drug

Typepicklist

RecommendationReasonType


DescriptionThe reason why the recommendation is added to the patient.


• Cost

• Health Condition

Typepicklist

RecommendationSubtype


DescriptionA further categorization of the recommendation type.


• Change in Dosage

• Change in Route

• Discontinuation

• Non-Compliance

• Omission

Typepicklist

RecommendationType


DescriptionThe type of medication recommendation added to the patient.


• Adverse Drug Event

• Care Gap

• Discrepancy

• Drug to Drug Interaction

829


DetailsField

TypedateTime




Typestring

SourceSystem



Typestring





MedReconRecommendationFeed on page 1185Feed tracking is available for the object.

MedReconRecommendationHistory on page 1193History is available for tracked fields of the object.

MedReconStmtRecommendationAssociates a medication recommendation to a medication statement and medication reconciliation. This object is available in API version54.0 and later.


830


Fields

DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedReconRecommendationId


DescriptionThe medication recommendation associated with the medication reconciliation andmedication statement.


Relationship NameMedReconRecommendation


Refers ToMedReconRecommendation

Typereference

MedicationReconciliationId


DescriptionThe medication reconciliation with which the medication recommendation is associated.


Relationship NameMedicationReconciliation

831


DetailsField


Refers ToMedicationReconciliation

Typereference

MedicationStatementId


DescriptionThe medication statement with which the medication recommendation is associated.


Relationship NameMedicationStatement


Refers ToMedicationStatement

Typestring

Name


DescriptionThe name of the medication recommendation.

TypedateTime




Typestring

SourceSystem



832


DetailsField

Typestring





MedReconStmtRecommendationFeed on page 1185Feed tracking is available for the object.

MedReconStmtRecommendationHistory on page 1193History is available for tracked fields of the object.


EDITIONS


Provider Network Management allows health insurance companies to bring providers into theirnetwork. It provides objects for managing provider application and credentialing data, so you caneasily enroll providers into your network and help your members or patients find care that fits theirneeds.

Provider application and credentialling diagram

833

Provider Network ManagementHealth Cloud Developer Guide

Provider network contract management diagram

To use Health Cloud for provider network management, assign the Health Cloud permission set and the Provider Network Managementpermission set to your users.

Note: The Provider Recruiting and Credentialing Application features of the Vlocity Health and Insurance package are fullysupported in Health Cloud. You will need the Vlocity HINS package for OmniStudio. For information about all the features supportingend to end provider network management in the Vlocity package, see the Vlocity Content (formerly Express) documentation.

Provider Network Management Overview

Use the Health Cloud Provider Network Management data model along with standard Salesforce objects to manage your networkof providers.

834


https://docs.vlocity.com/en/OmniStudio.html

https://docs.vlocity.com/en/Provider-Network-Management-Application-892582.html

Access to Provider Network Management

The provider network management standard objects are available to users with the Health Cloud, Health Cloud Platform, and ProviderNetwork Management permission set licenses and the Health Foundation permission set.

Vlocity Health and Insurance Objects Available in Health Cloud

The Provider Recruiting and Credentialing Application features of the Vlocity Health and Insurance package are fully supported inHealth Cloud. Each Vlocity field has an equivalent Health Cloud field, which you can find here.

ApplicationCase

This junction object stores a relationship between Case and IndividualApplication. This object is available in API version 52.0 andlater with the Provider Network Management permission set license.

BusinessLicense

Represents the licenses of a party role like healthcare provider or producer.

CareProviderAdverseAction

Captures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is available in API version47.0 and later.

CareSpecialtyTaxonomy

The junction object between CareSpecialty and CareTaxonomy. This object is available in API version 52.0 and later.

CareTaxonomy

Represents a static list of taxonomy codes.

IndividualApplication

Represents an application form submitted by an individual. Available with the Provider Network Management permission set license.

Insurance Policy

Represents a type of insurance policy. Available with the Provider Network Management permission set license.

PersonEducation

Represents information about professional education for a person in a provider role.

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.

BundledCareFeeAgreement

Specifies the payment terms for contracts of Bundled Care Fee Agreement. This object is available in API version 54.0 and later withthe Provider Network Management permission set license.

CapitationCareFeeAgreement

Specifies the payment terms for contracts of Capitation Care Fee Agreement type. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.

CareFeeScheduleItem

Stores procedure level fees for a fee schedule definition. This object is available in API version 54.0 and later with the Provider NetworkManagement permission set license.

835


CareProviderFacilitySpecialty

Represents all the specialties that the practitioner provides at a given location. For example, a physician who is board-certified inboth spine and neuro may provide spine services at one location and neuro services at another.

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.

CareSpecialty

Represents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery.

CategorizedCareFeeAgreement

Specifies the payment terms for contracts of Categorized Care Fee Agreement. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.

ContractPaymentAgreement

Stores information about the contract payment agreement associated with a contract. This object is available in API version 54.0and later with the Provider Network Management permission set license.

FeeScheduleDefinition

Stores fee schedule information for contracts of Standard Care Fee Agreement types. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.

HealthcareFacilityNetwork

Represents a junction object identifying the insurance network that a location or business entity is a part of. Network participationrecords are also stored in this object.

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.

PercentileBsdCareFeeAgreement

Specifies the payment terms for contracts of Percentile Based Care Fee Agreement. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.

836


ProviderNetworkContract

Represents a provider and a network bound together by a contract. This object is available in API version 53.0 and later with theProvider Network Management permission set license.

ProviderNetworkTier

Represents unique tiers for each provider network. This object is available in API version 53.0 and later with the Provider NetworkManagement permission set license.

PreventiveCareAgreement

Specifies the payment terms for contracts of Preventive Care Fee Agreement. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.

SharedSavingPaymentAgreement

Specifies the payment terms for contracts of Shared Saving Payment Agreement type. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.

StandardCareFeeAgreement

Specifies the payment terms for contracts of Standard Care Fee Agreement type. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.

SEE ALSO:

Health Cloud Administrator Guide: Provider Network Management

Provider Network Management OverviewUse the Health Cloud Provider Network Management data model along with standard Salesforce objects to manage your network ofproviders.

The Provider Network 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

• Payment agreement terms for provider network contract types

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.

837


https://help.salesforce.com/articleView?id=sf.admin_provider_relationship.htm&language=en_US

• 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.

Access to Provider Network ManagementThe provider network management standard objects are available to users with the Health Cloud, Health Cloud Platform, and ProviderNetwork Management permission set licenses and the Health Foundation permission set.

You must have the Health Cloud managed package installed in your org to access the provider network management data model, whichis available in API version 52.0 and later. You must also have the Health Cloud Provider Network Management Add On license, whichcontains the Health Cloud Provider Network Management platform license and the Health Cloud Provider Network Management userpermission set license.

Some of the objects are available in your org even before enabling this org pref because they’re part of other data models in HealthCloud or other Salesforce products. These objects need the Health Cloud Provider Network Management Add On license to be enabledbefore you can use them:

• Application Case

• Individual Application

• Insurance Policy

• Person Employment

• Provider Network Tier

• Provider Network Contract

• Care Fee Schedule Item

• Fee Schedule Definition

• Contract Payment Agreement

• Standard Care Fee Agreement

• Categorized Care Fee Agreement

• Capitation Care Fee Agreement

• Shared Saving Payment Agreement

• Percentile Care Fee Agreement

• Bundled Care Fee Agreement

• Preventive Care Agreement

And these fields are added to existing objects when you enable the Health Cloud Provider Network Management Add On license.

Business License

• IsPrimaryLicense

• IssueDate

• LicenseNumber

Care Provider Adverse Action

• ActionIssueDate

838


• IncidentDate

• IncidentReportedDate

• InsurancePolicyNumber

• InsuranceProviderName

• PenaltyAmount

• RegulatoryBody

• RegulatoryBodyType

Person Education

• InstitutionAddress

• ProgramName

• CertificateIdentifier

Vlocity Health and Insurance Objects Available in Health CloudThe Provider Recruiting and Credentialing Application features of the Vlocity Health and Insurance package are fully supported in HealthCloud. Each Vlocity field has an equivalent Health Cloud field, which you can find here.

SEE ALSO:

Vlocity Provider Network Management Data Model

Account Regulatory ActionThe functionality supported by the Account Regulatory Action object in the Vlocity Health and Insurance package is supported by theCare Provider Adverse Action object in Health Cloud.

Health Cloud Object: Care Provider Adverse ActionVlocity Object: Account Regulatory Action

AccountAccount

Action Issue DateAction Date

Regulatory BodyAgency Identifier

NameName

Penalty AmountPenalty Amount

Effective FromPeriod Start

SEE ALSO:


ApplicationThe functionality supported by the Application object in the Vlocity Health and Insurance package is supported by the IndividualApplication object in Health Cloud.

839


https://docs.vlocity.com/en/Network-Management.html

Health Cloud Object: Individual ApplicationVlocity Object: Application

AccountAccount

ReferenceNumberApplication Name

ReferenceNumberApplication Reference Number

ContactContactId

CreatedByCreated By

OwnerOwner

StatusStatus

ApplicationTypeType

SEE ALSO:

IndividualApplication

Contact EmploymentThe functionality supported by the Contact Employment object in the Vlocity Health and Insurance package is supported by the PersonEmployment object in Health Cloud.

Health Cloud Object: Person EmploymentVlocity Object: Contact Employment

EmployerAddressAddress

AddressCity

RelatedPersonContact Id

AddressCountry Code

DescriptionDescription

EmployerEmployer

EmployerPhoneEmployer Phone

EmploymentTypeEmployment Type

EndDateEnd Date

EmploymentOccupationOccupation

AddressPostal Code

StartDateStart Date

AddressStates/Provinces

Verification StatusStatus

PositionTitle

840


Contact Regulatory ActionThe functionality supported by the Contact Regulatory Action object in the Vlocity Health and Insurance package is supported by theCare Provider Adverse Action object in Health Cloud.

Health Cloud Object: Care Provider Adverse ActionVlocity Object: Contact Regulatory Action

Action Issue DateAction Date

Regulatory BodyAgency Identifier

Regulatory Body TypeAgency type

Incident Reported DateComplaintDate

PractitionerContact

Incident DateIncidentDate (OccurrenceDate)

Insurance Provider NameInsurance Carrier

NameName

Penalty AmountPenalty Amount

Effective FromPeriod Start

Insurance Policy NumberPolicy Number

Action Issue DateResolutionDate

SEE ALSO:


Contract Provider NetworkThe functionality supported by the Contract Provider Network object in the Vlocity Health and Insurance package is supported by theProvider Network Contract object in Health Cloud.

Health Cloud Object: Provider Network ContractVlocity Object: Contract Provider Network

Contract ExtensionContract

End DateEffective End Date

Start DateEffective Start Date

Name

FacilityProvider Account

Provider Fee Schedule

Provider NetworkProvider Network

841


Provider Account LicenseThe functionality supported by the Provider Account License object in the Vlocity Health and Insurance package is supported by theBusiness License object in Health Cloud.

Health Cloud Object: Business LicenseVlocity Object: Provider Account License

Period EndEffective End Date

Period StartEffective Start Date

Issue DateEnumeration CertifiedDate

Primary LicenseIs Primary License

Jurisdiction StateJurisdiction

DescriptionLicense Description

IssuerLicense Issuer

Source System Update DateLicense Last Updated Date

License NumberLicense Number

License ClassLicense Type

NameName

OrganizationProvider Account

StatusStatus

SEE ALSO:

BusinessLicense

Provider Contact LicenseThe functionality supported by the Provider Contact License object in the Vlocity Health and Insurance package is supported by theBusiness License object in Health Cloud.

Health Cloud Object: Business LicenseVlocity Object: Provider Contact License

ContactContact

Period EndEffective End Date

Period StartEffective Start Date

Issue DateEnumeration Certified Date

Primary LicenseIs Primary License

Jurisdiction StateJurisdiction

DescriptionLicense Description

IssuerLicense Issuer

842


Health Cloud Object: Business LicenseVlocity Object: Provider Contact License

Source System Update DateLicense Last Updated Date

License NumberLicense Number

License ClassLicense Type

NameName

StatusStatus

SEE ALSO:

BusinessLicense

Provider EducationThe functionality supported by the Provider Education object in the Vlocity Health and Insurance package is supported by the PersonEducation object in Health Cloud.

Health Cloud Object: Person EducationVlocity Object: Provider Education

Education LevelAccreditation Type

Certificate IDCertification #

Degree Earner (Contact)Contact

Graduation DateDegree Through

DegreeEducation Type

Institution AddressInstitution Address

InstitutionInstitution Name

Completion DateProgram Completed Date

Program NameProgram Name

Start DateProgram Start Date

StatusStatus

SEE ALSO:

PersonEducation

Provider NetworkThe functionality supported by the Provider Network object in the Vlocity Health and Insurance package is supported by the HealthcarePayer Network object in Health Cloud.

843


Health Cloud Object: Healthcare Provider NetworkVlocity Object: Provider Network

ActiveActive

PayerCarrier Account

Effective ToEffective End Date

Effective FromEffective Start Date

Payer Network NameNetwork Name


Parent Network

Line of Business

SEE ALSO:

HealthcarePayerNetwork

Provider Network TierThe functionality supported by the Provider Network Member object in the Vlocity Health and Insurance package is supported by theHealthcare Facility Network object in Health Cloud.

Health Cloud Object: Healthcare Facility NetworkVlocity Object: Provider Network Member

Payer NetworkProvider Network

ProviderNetworkTierProvider Network Tier

Health Care ProviderProvider Account

Health Care ProviderProvider Contact

Member Name

Effective FromStart Date

Panel StatusStatus

Effective ToEnd Date

Provider Network TierThe functionality supported by the Provider Network Tier object in the Vlocity Health and Insurance package is supported by the ProviderNetwork Tier object in Health Cloud.

Health Cloud Object: Provider Network TierVlocity Object: Provider Network Tier

Provider NetworkProvider Network

ActiveActive

844


Health Cloud Object: Provider Network TierVlocity Object: Provider Network Tier


Tier NameTier Name

Provider TaxonomyThe functionality supported by the Provider Taxonomy object in the Vlocity Health and Insurance package is supported by the HealthcareProvider Taxonomy object in Health Cloud.

Health Cloud Object: Healthcare Provider TaxonomyVlocity Object: Provider Taxonomy

Effective ToEnd Date

Taxonomy NameName

Owner NameOwner

AccountProvider Account

PractitionerProvider Contact

Effective FromStart Date

TaxonomyTaxonomy Code

SEE ALSO:

HealthcareProviderTaxonomy

ApplicationCaseThis junction object stores a relationship between Case and IndividualApplication. This object is available in API version 52.0 and laterwith the Provider Network Management permission set license.


Fields

DetailsField

Typereference

ApplicationId


DescriptionThe individual application associated with a case application.

845


DetailsField


Relationship NameApplication


Refers ToIndividualApplication

Typereference

CaseId


DescriptionThe case associated with a case application.


Relationship NameCase


Refers ToCase

TypedateTime

LastReferencedDate


Description

TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name associated with the record.

846



ApplicationCaseFeed on page 1185Feed tracking is available for the object.

ApplicationCaseHistory on page 1193History is available for tracked fields of the object.

BusinessLicenseRepresents the licenses of a party role like healthcare provider or producer.


Fields

DetailsField

Typereference

AccountId


DescriptionID of the organization holding the license.

Typereference

ContactId


DescriptionID of the person who holds the license and is listed as a contact.

Typestring

Identifier


DescriptionIssuer's ID for the licensee.

Typeboolean

IsActive

847


DetailsField


DescriptionIndicates whether the license is active.

Typestring

Issuer


DescriptionLicense issuer's name.

Typestring

JurisdictionCountry


DescriptionCountry where license is valid.

Typestring

JurisdictionOther


DescriptionName of other jurisdiction.

Typestring

JurisdictionState


DescriptionState where license is valid.

Typepicklist

JurisdictionType


DescriptionJurisdiction for the license. Example values:

• State

• County

848


DetailsField

• Province

• Country

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typepicklist

LicenseClass


DescriptionThe class that the distributor’s license belongs to. This field is available from API version 48.0and later.


• Insurance Producer

• Managing General Agent

• Public Adjuster

Typestring

Name


DescriptionName of the business or professional license.

Typereference

OwnerId


849


DetailsField


TypedateTime

PeriodEnd


DescriptionLicense's expiration date.

TypedateTime

PeriodStart


DescriptionLicense's effective start date.

Typepicklist

Status


DescriptionCurrent status of the license. Example values:

• Inactive

• Revoked

• Draft

• Verified

Typereference

UserId


DescriptionPerson who holds the license and is listed as a user.

Typepicklist

VerificationStatus


DescriptionCurrent status for the license. Example values:

850


DetailsField

• Authorized

• Pending

• Unverified

Typedate

VerifiedDate


DescriptionLicense was validated on this date.


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.

CareProviderAdverseActionCaptures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is available in API version47.0 and later.


Fields

DetailsField

Typereference

AccountId


851


https://developer.salesforce.com/docs/atlas.en-us.238.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm

DetailsField

DescriptionThe account this adverse action is associated with.

Typereference

AccreditationId


DescriptionThe accreditation that might be affected by this adverse action.

Typedate

ActionIssueDate


DescriptionThe date when the adverse action was issued by the regulatory authority.

Typepicklist

ActionType


DescriptionThe type of adverse action that is being taken.


• AdministrativeDisciplinaryAction

• CourtOrder

• FelonyConviction

• MalpracticeJudgement

• MisdemeanorConviction

• ProbationaryLicense

Typereference

BoardCertificationId


DescriptionThe board certification that might be affected by this adverse action

Typereference

BusinessLicenseId

852


DetailsField


DescriptionThe business license that might be affected by this adverse action.

Typestring

CaseNumber


DescriptionThe case number associated with this adverse action.

Typestring

CourtSentence


DescriptionThe final sentence by the governing court, if any.

Typestring

Description


DescriptionSummary of the adverse action.

Typedate

EffectiveFrom


DescriptionThe date from which this Adverse Action is effective.

Typedate

EffectiveTo


DescriptionThe date on which this Adverse Action is no longer effective.

Typereference


853


DetailsField


DescriptionHealthcareProvider that this Adverse Action is associated with

Typedate

IncidentDate


DescriptionThe date when the incident took place that resulted in the adverse action.

Typedate

IncidentReportedDate


DescriptionThe date on which the incident was reported to the regulatory authority.

Typestring

InsurancePolicyNumber


DescriptionThe number of the insurance policy associated with an adverse action.

Typestring

InsuranceProviderName


DescriptionThe name of the insurance provider that issued the policy associated with an adverse action.

Typestring

Jurisdiction


DescriptionThe name of the court or goverment body that issued the legal determination.

TypedateTime

LastReferencedDate

854


DetailsField



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the adverse action that is being taken.

Typecurrency

PenaltyAmount


DescriptionThe penalty amount imposed for an adverse action.

Typereference

OwnerId


DescriptionTime stamp that indicates when the current user last viewed this record.

Typereference

PractitionerId


DescriptionThe practitioner this adverse action record is associated with.

855


DetailsField

Typestring

RegulatoryBody


DescriptionThe name of the regulatory authority to which the incident was reported.

Typepicklist

RegulatoryBodyType


DescriptionSpecifies the type of regulatory authority to which the incident was reported.

Typestring

ReportingEntity


DescriptionThe name of the entity or organization that reported this action.

Typestring

SourceSystem



Typestring



DescriptionUnique record ID in source system.

Typepicklist

Status


DescriptionThe status of the license or certification, such as "revoked" or "suspended."

856


DetailsField


• Active

• Revoked

• Suspended


CareProviderAdverseActionFeed on page 1185Feed tracking is available for the object.

CareProviderAdverseActionHistory on page 1193History is available for tracked fields of the object.

CareSpecialtyTaxonomyThe junction object between CareSpecialty and CareTaxonomy. This object is available in API version 52.0 and later.


Fields

DetailsField

Typereference

CareSpecialtyId


DescriptionThe care specialty associated with a care specialty taxonomy.


Relationship NameCareSpecialty



857


DetailsField

Typereference

CareTaxonomyId


DescriptionThe care taxonomy associated with a care specialty taxonomy.


Relationship NameCareTaxonomy


Refers ToCareTaxonomy

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe system-generated name of the record.


CareSpecialtyTaxonomyFeed on page 1185Feed tracking is available for the object.

858


CareSpecialtyTaxonomyHistory on page 1193History is available for tracked fields of the object.

CareTaxonomyRepresents a static list of taxonomy codes.


Fields

DetailsField

Typestring

Description


DescriptionDescription of the taxonomy.

Typedate

EffectiveFrom


DescriptionThe date from which this taxonomy is effective.

Typedate

EffectiveTo


DescriptionThe date on which this taxonomy is no longer effective.

Typeboolean

IsActive



859


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the taxonomy master record.

Typereference

OwnerId



Typereference

ParentTaxonomyId


DescriptionThe parent taxonomy associated with a care taxonomy.


Relationship NameParentTaxonomy


860


DetailsField


Typestring

TaxonomyCode


DescriptionCode for the taxonomy.

Typepicklist

TaxonomyType


DescriptionType of taxonomy.


CareTaxonomyFeedFeed tracking is available for the object.

CareTaxonomyHistoryHistory is available for tracked fields of the object.

IndividualApplicationRepresents an application form submitted by an individual. Available with the Provider Network Management permission set license.


Fields

DetailsField

Typereference

AccountId


861


DetailsField

DescriptionThe ID of the applicant’s account.

Typecurrency

AmountPaid


DescriptionThe amount paid by the applicant.

Typereference

ApplicationCaseId


DescriptionThe ID of a case that relates to this application.

Typepicklist

ApplicationCategory


DescriptionCategorizes the ways an application can be processed. Possible values are:

• Basic

• Special

Typepicklist

ApplicationType


DescriptionThe type of the application. Possible values are:

• New

• Renewal

TypedateTime

AppliedDate


DescriptionThe date on which the application was received from the applicant.

862


DetailsField

TypedateTime

ApprovedDate


DescriptionThe date on which the application was approved.

Typereference

BusinessTypeId


DescriptionThe type of individual business activity for this application.

Typepicklist

Category


DescriptionThe service category of the application.


• Emergency Service

• License

• Permit

Typestring

Description


DescriptionText description provided by the applicant.

Typeboolean

IsOwnerEditable


DescriptionWhether the owner ID of this record can be changed.

TypedateTime

LastReferencedDate

863


DetailsField


DescriptionThe timestamp for when a user most recently viewed a record related to this record.

TypedateTime

LastViewedDate


DescriptionThe timestamp for when a user most recently viewed this record. If this value is null, thisrecord might only have been referenced (LastReferencedDate) and not viewed.

Typereference

LicensePermitNameId


DescriptionThe emergency service authorization that will be granted if this application is approved.

Typereference

LicenseTypeId

PropertiesCreate, Filter, Group, Sort, Update, Nillable

DescriptionThe type of emergency service that the applicant will provide.

Typestring

Name


DescriptionThe auto-generated unique ID for this application.

Typereference

OwnerId


DescriptionThe ID of the user that owns this record.

864


DetailsField

TypedateTime

PaymentDate


DescriptionThe date and time at which payment was received from the applicant.

TypedateTime

RequirementsCompleteDate


DescriptionThe date when the applicant fulfilled all the requirements for approval.

TypedateTime

SavedApplicationRefId


DescriptionReference Id of the saved application.

Typepicklist

Status


DescriptionThe submission and approval status of the application. Possible values are:

• Closed

• In Distribution

• In Review

• Submitted

Typeboolean

WasReturned


DescriptionWhether a submitted application was sent back to the applicant due to errors.

865



IndividualApplicationHistory on page 1193History is available for the object.

IndividualApplicationFeed on page 1185Feed tracking is available for the object.

IndividualOwnerSharingRule on page 1196Sharing rules are available for the object.

IndividualApplicationShare on page 1199Share is available for the object.

Insurance PolicyRepresents a type of insurance policy. Available with the Provider Network Management permission set license.


Fields

DetailsField

Typetextarea

AttributesSelectedValues__c


DescriptionValues of root product attributes set at the InsurancePolicy level.

Typepicklist

AuditTerm


DescriptionThe frequency of the audit. For example, monthly, semi-monthly, quarterly, semi-annually,or annually.


• Annually

• Monthly

• Quarterly

• Semi Annual(twice a year)

866


DetailsField

• Semi-Monthly(twice a month)

TypedateTime

CancellationDate


DescriptionThe date on which the insurance policy was canceled.

Typetextarea

CancellationReason


DescriptionThe reason for canceling the insurance policy.

Typepicklist

CancellationReasonType


DescriptionThe category that the cancellation reason belongs to.


• Canceled at Request of the Finance Company

• Canceled by Underwriter or Plan Administrator

• Corporate Officer NonElection

• Court Release

• Coverage Placed Elsewhere

• Duplicate Coverage

• Failure to Comply with Terms and Conditions (ex. AuditFailure)

• Failure to Pay Deductible

• Insured's Request

• Misrepresentation of Information on Application

• Non-Payment

• Not Taken

• Other

• Revocation of Voluntary Market Acceptance

• Rewritten

• Substantial Change in Risk

867


DetailsField

• Underwriting Reasons

Typecurrency

CashSurrenderValue


DescriptionThe cash surrender value of the insurance policy.

Typepicklist

ChangeSubtype


DescriptionA further categorization of the change type. For example, childbirth, marriage.


• Child Birth

• Marriage

Typepicklist

ChangeType


DescriptionThe type of the change in the policy. For example, life event, house renovation.


• House Renovation

• Life-Event

Typereference

ContractLineItemId__c


DescriptionThe ID of a line item in the contract for the policy.


Relationship NameContractLineItemId__r


868


DetailsField

Refers ToContractLineItem__c

TypedateTime

DateRenewed


DescriptionThe date on which the policy was last renewed.

Typedouble

Discount


DescriptionThe discount that was given on the policy.

TypedateTime

EffectiveDate


DescriptionThe date from which the policy is in effect.

TypedateTime

ExpirationDate


DescriptionThe date on which the policy expires.

TypedateTime

FinalRenewalDate


DescriptionThe final date on which the policyholder can renew the insurance policy.

Typepicklist

FnolChannel


869


DetailsField

DescriptionThe channel through which the loss for the claim associated with this policy was reported.This field is deprecated in API version 48.0 and will be removed in API version 52 (the Summer’21 release).


• Chatbot

• Mobile

• Phone

• Web

Typecurrency

GrossWrittenPremium


DescriptionThe total expected premium amount for the insurance policy over the policy period.

Typeboolean

HasAnyAutoCoverage


DescriptionIndicates whether the insurance policy has an Any Auto coverage, which extends the coverageto hired and other non-owned vehicles.

The default value is False.

Typeboolean

IsActive


DescriptionIndicates whether the policy is active.


Typeboolean

IsLoanEligibile


DescriptionIndicates whether a loan can be requested against the insurance policy.


870


DetailsField

Typeboolean

IsRenewedPolicy


DescriptionIndicates whether the policy is a renewed policy.


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe insurance policy number. Label is Policy Number.

Typereference

NameInsuredId


DescriptionThe name of the primary insured.


Relationship NameNameInsured


871


DetailsField

Refers ToAccount

TypedateTime

OriginalEffectiveDate


DescriptionThe date on which the original policy went into effect. This field is available from API version51.0 and later.

TypedateTime

OriginalExpirationDate


DescriptionExpiration date of the original policy. This field is available from API version 51.0 and later.

Typereference

OriginalPolicyId


DescriptionThe ID of the original insurance policy. This field is available from API version 51.0 and later.


Relationship NameOriginalPolicy


Refers ToInsurancePolicy

Typereference

OwnerId





872


DetailsField



Typedate

PaidToDate


DescriptionThe date up to which the policy is paid for. This field is available from API version 51.0 andlater.

Typereference

ParentPolicyId


DescriptionThe ID of the parent policy that covers this policy. For example, a parent policy can cover anauto policy and home policy.


Relationship NameParentPolicy



TypedateTime

PaymentDueDate


DescriptionThe date on which the next payment of the premium is due.

Typepicklist

PlanTier


DescriptionThe class that the insurance policy belongs to. For example, silver, gold, or platinum.

873


DetailsField


• Gold

• Platinum

• Silver

Typepicklist

PlanType


DescriptionThe type of the insurance policy plan. For example, single life, joint last-to-die, or jointfirst-to-die (primarily applicable for term insurance).


• Joint First-to-Die

• Joint Last-to-Die

• Single Life

Typetextarea

PolicyDescription


DescriptionThe description of the insurance policy.

Typestring

PolicyName


DescriptionThe name of the insurance policy.

Typepicklist

PolicyTerm


DescriptionThe time period for which the policy provides coverage. This field is available from API version51.0 and later.


• Annual

874


DetailsField

• Custom

• Daily

• Monthly

• Semi-Annual

The default value is Annual.

Typepicklist

PolicyType


DescriptionThe type of the insurance policy. For example, home, auto, annuity, or life.


• Annuity

• Auto

• Commercial Auto

• Commercial Property

• Home

• Life

• Workers' Compensation

Typecurrency

PremiumAmount


DescriptionThe premium paid by the policy owner for the current billing period.

Typepicklist

PremiumCalculationMethod


DescriptionThe premium calculation method for a payment period. This field is available from API version51.0 and later.


• Daily

• Modal

The default value is Daily.

875


DetailsField

Typepicklist

PremiumFrequency


DescriptionThe frequency of the premium payment or billing. For example, monthly, semi-monthly,quarterly, semi-annually, or annually.


• Annually

• Monthly

• Quarterly

• Semi Annual(twice a year)

• Semi-Monthly(twice a month)

The default value is Annually.

Typepicklist

PremiumPaymentType


DescriptionThe type of premium payment, such as Advance or Arrears. This field is available from APIversion 51.0 and later.


• Advance

• Arrears

The default value is Advance.

Typecurrency

PreviousPremium


DescriptionThe premium of the policy before it was renewed.

TypedateTime

PreviousRenewalDate


DescriptionThe date on which the insurance policy was renewed in the last renewal cycle.

876


DetailsField

Typereference

PriorPolicyId


DescriptionThe ID of the insurance policy before it was renewed.


Relationship NamePriorPolicy



Typereference

ProducerId


DescriptionThe ID of the agency or the agent who sold the policy.


Relationship NameProducer


Refers ToProducer

Typestring

ProductCode__c


DescriptionThe code of the product that this policy belongs to.


Formula

Product.ProductCode

Typereference

ProductId

877


DetailsField


DescriptionThe product that this policy belongs to. For example, if the customer buys a silver auto policy,this field looks up to the silver auto product in the Product object.


Relationship NameProduct


Refers ToProduct2

Typepicklist

RenewalChannel


DescriptionThe channel through which the insurance policy was renewed.


• Chatbot

• Mobile

• Phone

• Web

TypedateTime

RenewalDate


DescriptionThe date on which the policy is expected to be renewed. The actual renewal date may bedifferent.

TypedateTime

SaleDate


DescriptionThe date on which the policy was sold.

878


DetailsField

Typeaddress

ServicingOffice


DescriptionThe address of the office that issued the policy and that services the policy.

This is a compound field of type Address and combines these fields: ServicingOfficeCity,ServicingOfficeCountry, ServicingOfficeGeocodeAccuracy, ServicingOfficeLatitude,ServicingOfficeLongitude, ServicingOfficePostalCode, ServicingOfficeState, andServicingOfficeStreet.

Typereference

SourceOpportunityId


DescriptionThe ID of the opportunity from which the policy was created.


Relationship NameSourceOpportunity


Refers ToOpportunity

Typereference

SourceQuoteId


DescriptionThe ID of the quote from which the policy was created.


Relationship NameSourceQuote


Refers ToQuote

Typestring

SourceSystem

879


DetailsField


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

Typestring



DescriptionThe unique ID of this record in the source system.

Typecurrency

StandardFeeAmount


DescriptionThe expected fee for the policy over the policy period. This field is available from API version51.0 and later.

Typecurrency

StandardPremiumAmount


DescriptionThe expected premium for the policy over the policy period. This field is available from APIversion 51.0 and later.

Typecurrency

StandardTaxAmount


DescriptionThe expected tax on the policy over the policy period. This field is available from API version51.0 and later.

Typepicklist

Status


DescriptionThe status of the insurance policy.

880


DetailsField


• Agreement Premature endings

• Applied

• Canceled

• Customer Rejected

• Draft

• Final

• Full Life Ending

• Hypothetical

• In Force

• In Force with temporary coverage

• In Force-change pending

• Initial

• Insurer Rejected

• Lapsed

• Negotiation End

• Not Taken Up

• Offered

• Quote Abandoned

• Quoted

• Replaced by customer application

• Replaced by insurer counter offer

• Suspended

• Terminated

• Under negotiation

The default value is Initial.

Typepicklist

Substatus


DescriptionThe carrier system's substatus code for the insurance policy.


• Draft

• Final

• Negotiation End

• Not Taken Up

881


DetailsField

• Quote Abandoned

The default value is Draft.

Typecurrency

TaxesSurcharges


DescriptionThe taxes and surcharges levied on the premium for the insurance policy.

Typecurrency

TermFeeAmount


DescriptionThe expected fee for the policy over the policy period, prorated based on the policy's effectivedates. This field is available from API version 51.0 and later.

Typecurrency

TermPremiumAmount


DescriptionThe expected premium for the policy over the policy period, prorated based on the policy'seffective dates. This field is available from API version 51.0 and later.

Typecurrency

TermTaxAmount


DescriptionThe expected tax on the policy over the policy period, prorated based on the policy's effectivedates. This field is available from API version 51.0 and later.

Typecurrency

TotalCommissionAmount


DescriptionThe total commission amount for the policy.

882


DetailsField

Typecurrency

TotalStandardAmount


DescriptionThe sum of the expected premium, fee, and tax for the policy over the policy period. Thisfield is available from API version 51.0 and later.


Typecurrency

TotalSumInsured


DescriptionThe total insured amount. This field is available from API version 51.0 and later.

Typereference

UnderwritingEntityId


DescriptionLegal entity that underwrote the insurance policy.


Relationship NameUnderwritingEntity


Refers ToLegalEntity

Typestring

UniversalPolicyNumber


DescriptionA number that uniquely identifies the policy across different source systems.

PersonEducationRepresents information about professional education for a person in a provider role.

883



Fields

DetailsField

TypedateTime

CompletionDate


DescriptionEducation's completion date.

Typereference

ContactId


DescriptionID of the person who earned the degree and is listed as a contact.

Typepicklist

EducationLevel


DescriptionLevel of education achieved. Example values:

• Undergraduate degree

• Medical school

• Internship

• Residency

• Fellowship

TypedateTime

GraduationDate


DescriptionGraduation date from institution.

Typestring

Identifier

884


DetailsField


DescriptionID issued to the recipient by the educational institution.

Typestring

IdentifierIssuer


DescriptionEducational institution's name.

Typereference

IndividualId


DescriptionID of the person who earned the degree and is listed as an individual.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

885


DetailsField


DescriptionName of the degree earned.

Typereference

OwnerId



TypedateTime

StartDate


DescriptionEducation's start date.

Typepicklist

Status


DescriptionCurrent status of education. Valid values:

• Inactive

• Revoked

• Draft

• Verified

The default value is Inactive.

Typereference

UserId


DescriptionID of the person who earned the degree and is listed as a user.

Typepicklist

VerificationStatus

886


DetailsField


DescriptionCurrent educational status. Valid values:

• Authorized

• None

The default value is None.

TypedateTime

VerifiedDate


DescriptionEducation was validated on this date.


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.

AccreditationRepresents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute care hospital.


Fields

DetailsField

Typereference

AccountId

887


https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm

DetailsField


DescriptionHealthcare facility (Account) that this accreditation is associated with.

Typepicklist

AccreditationRating


DescriptionRating system used by the accrediting body.

Typepicklist

AccreditingBody


DescriptionThe organization that provided the accreditation.

Typedate

EffectiveFrom


DescriptionThe date from which this accreditation is effective.

Typedate

EffectiveTo


DescriptionThe date on which this accreditation is no longer effective.

Typedate

LastFullSurveyDate


DescriptionDate of the last full survey completed by accrediting body.

Typedate

LastOnsiteSurveyDate

888


DetailsField


DescriptionDate that accrediting body was last onsite.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the accreditation.

Typereference

OwnerId



Typereference

PractitionerId


DescriptionPractitioner that this accreditation is associated with.

889


DetailsField

Typestring

SourceSystem



Typestring




Typepicklist

Status


DescriptionAccreditation status.

Typepicklist

SubType


DescriptionSubtype of the accreditation.

Typepicklist

Type


DescriptionType of accreditation.


AccreditationFeedFeed tracking is available for the object.

890


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.


Fields

DetailsField

Typereference

AccountId


DescriptionID of the organization receiving the award.

TypedateTime

AwardDate


DescriptionDate award was received.

Typestring

AwardedBy


DescriptionName of the issuing organization.

Typereference

ContactId

891


DetailsField


DescriptionPerson who received the award and is listed as a contact.

Typestring

Identifier


DescriptionIssuing organization's identifier for the award recipient.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionAward name.

Typereference

OwnerId

892


DetailsField


DescriptionID of the user who owns this record.

Typepicklist

Status


DescriptionAward status. Example values:

• Inactive

• Revoked

• Draft

• Verified

Typereference

UserId


DescriptionID of the person who received the award and is listed as a user.

Typepicklist

VerificationStatus


DescriptionCurrent award status. Example values:

• Authorized

• Pending

• Unverified

TypedateTime

VerifiedDate


DescriptionAward was validated on this date.

893



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.

BoardCertificationRepresents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease.


Fields

DetailsField

Typereference

AccountId


DescriptionAccount that this healthcare provider is associated with.

Typestring

BoardName


DescriptionName of the organization providing the board certification.

Typepicklist

CertificationType


DescriptionType of certification.

894


https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm

DetailsField

Typedate

CurrentCertificationDate


DescriptionDate of most recent board certification.

Typedate

EffectiveFrom


DescriptionThe date from which this certification is effective.

Typedate

EffectiveTo


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



TypedateTime

LastViewedDate


895


DetailsField


Typestring

Name


DescriptionName of the provider.

Typereference

OwnerId



Typereference

PractitionerId


DescriptionPractitioner that this certification is associated with.

Typestring

SourceSystem



Typestring




Typepicklist

Status

896


DetailsField


DescriptionStatus of the certification.

Typedate

TerminationDate


DescriptionTermination date for this provider.

Typestring

TerminationReason


DescriptionReason for termination.


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.

BundledCareFeeAgreementSpecifies the payment terms for contracts of Bundled Care Fee Agreement. This object is available in API version 54.0 and later with theProvider Network Management permission set license.


897


Fields

DetailsField

Typecurrency

BasicTierPrice


DescriptionThe basic tier price for the procedure bundle.

Typereference

ContractPaymentAgreementId


DescriptionThe contract payment agreement record to which this bundled care fee agreement isassociated.


Relationship NameContractPaymentAgreement


Refers ToContractPaymentAgreement

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typecurrency

MidTierPrice


898


DetailsField

DescriptionThe mid tier price for the procedure bundle.

Typestring

Name


DescriptionThe name of the bundled care fee agreement.

Typecurrency

PremiumTierPrice


DescriptionThe premium tier price for the procedure bundle.

Typereference

ProcedureBundleCodeId


DescriptionThe code of the bundle including a set of procedures.


Relationship NameProcedureBundleCode



Typetextarea

ProcedureBundleDescription


DescriptionThe description of the procedure bundle.

Typestring

ProcedureBundleItemList

899


DetailsField


DescriptionThe list of procedures covered in the bundle.


BundledCareFeeAgreementFeed on page 1185Feed tracking is available for the object.

BundledCareFeeAgreementHistory on page 1193History is available for tracked fields of the object.

CapitationCareFeeAgreementSpecifies the payment terms for contracts of Capitation Care Fee Agreement type. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.


Fields

DetailsField

Typereference



DescriptionThe contract payment agreement record to which this capitation care fee agreement isassociated.





900


DetailsField

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typeint

MemberAgeRangeLowerLimit


DescriptionThe lower age limit of the enrolled member for the capitation care fee agreement.

Typeint

MemberAgeRangeUpperLimit


DescriptionThe upper age limit of the enrolled member for the capitation care fee agreement.

Typecurrency

MonthlyBalanceFee


DescriptionThe balance fee for each member after the monthly withheld fee.


Typecurrency

MonthlyFee


901


DetailsField

DescriptionThe fee agreed upon by the provider and payer for each member per month.

Typepercent

MonthlyWithheldPercentage


DescriptionThe percentage of the monthly fee that's withheld by the payer and shared later with theprovider based on the performance.

Typestring

Name


DescriptionThe name of the capitation care fee agreement.


CapitationCareFeeAgreementFeed on page 1185Feed tracking is available for the object.

CapitationCareFeeAgreementHistory on page 1193History is available for tracked fields of the object.

CareFeeScheduleItemStores procedure level fees for a fee schedule definition. This object is available in API version 54.0 and later with the Provider NetworkManagement permission set license.


Fields

DetailsField

Typestring

CareFeeScheduleItemKey

902


DetailsField


DescriptionA unique key assigned to the Care Fee Schedule Item record.

Typecurrency

FacilityPrice


DescriptionThe fees when the procedure is performed in a facility location such as a hospital orAmbulatory Surgical Center (ASC).

Typereference

FeeScheduleDefinitionId


DescriptionThe Fee Schedule Definition associated with the Care Fee Schedule Item.


Relationship NameFeeScheduleDefinition


Refers ToFeeScheduleDefinition

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



903


DetailsField

Typestring

Name


DescriptionThe name of the Care Fee Schedule Item.

Typecurrency

NonFacilityPrice


DescriptionThe fees when the procedure is performed in a non-facility location such as the physician'soffice.

Typestring

ProcedureCodeDescription


DescriptionThe description of the procedure code.

Typereference

ProcedureCodeId


DescriptionThe industry standard code for the procedure such as CPT or HCPCS.


Relationship NameProcedureCode




904


CareFeeScheduleItemFeed on page 1185Feed tracking is available for the object.

CareFeeScheduleItemHistory on page 1193History is available for tracked fields of the object.

CareProviderFacilitySpecialtyRepresents all the specialties that the practitioner provides at a given location. For example, a physician who is board-certified in bothspine and neuro may provide spine services at one location and neuro services at another.


Fields

DetailsField

Typereference

AccountId


DescriptionFacility associated with this provider facility specialty record.

Typedate

EffectiveFrom


DescriptionThe date from which this record is effective.

Typedate

EffectiveTo


DescriptionThe date on which this record is no longer effective.

Typeboolean

IsActive


905


DetailsField


Typeboolean

IsPrimarySpecialty


DescriptionIndicates whether this specialty is the practitioner's primary specialty at this facility, or thefacility's primary specialty.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the specialty provided at this provider facility.

Typereference

OwnerId



Typereference

PractitionerFacilityId

906


DetailsField


DescriptionPractitioner facility associated with this provider facility specialty record.

Typestring

SourceSystem



Typestring




Typereference

SpecialtyId


DescriptionIdentifies the specialty associated with this provider facility specialty record

Typepicklist

SpecialtyRole


DescriptionRole of the specialty for the provider or practitioner.


CareProviderFacilitySpecialtyFeedFeed tracking is available for the object.

CareProviderFacilitySpecialtyHistoryHistory is available for tracked fields of the object.

907


CareProviderFacilitySpecialtyOwnerSharingRuleSharing rules are available for the object.

CareProviderFacilitySpecialtyShareSharing is available for the object.

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.

Note: Degree, Status, DegreeEarner, and HealthCareProvidermust also be specified.

908


DetailsField

Typereference

Facility


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


DescriptionSpecified in Account.Name.

Typephone

FacilityPhone


DescriptionFacility's main contact telephone number. Specified in Account.Phone.

Typeboolean

IsAcceptingNewPatients


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



TypedateTime

LastViewedDate

909


DetailsField



Typestring

NationalProviderIdentifier


DescriptionProvider’s unique NPI number. Specified in HealthcareProviderNpi.Accountfor a facility, and HealthcareProviderNpi.Practitioner for a practitioner.

Typereference

OperatingHours


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


DescriptionThe URL for a photograph of the practitioner. Field is synced based onAccount-PhotoUrl or Contact.PhotoUrl.

Typetextarea

PlanType

PropertiesNillable


• PPO

• HMO

• Medicare

• Medicaid

910


DetailsField

• 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


DescriptionLookup to HealthcareProvider. Represents a facility or practitioner-facilitycombination.

Typestring

ProviderName


DescriptionName of the provider. Specified in Account for a facility, or in Contact for a practitioner.

Typestring

ProviderType


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, orCareProviderFacilitySpecialty.HealthcarePractitionerFacilityfor a practitioner.

Note: Specialty.SpecialtyType must also be specified.

911


DetailsField

Typetextarea

SubSpecialty

PropertiesNillable

DescriptionProvider's subspecialty. Specified inHealthcareProviderTaxonomy.careTaxonomy.TaxonomyType. Not validfor a practitioner-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.


Fields

DetailsField

Typestring

DeveloperName


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


DescriptionIndicates whether this configuration is active.

912


DetailsField

Typepicklist

Language


DescriptionThe language that the care provider search uses.


• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typepicklist

MappedObject


DescriptionIndicates mapped objects.




Typestring

MasterLabel

913


DetailsField


DescriptionThe label for the care provider.

Typestring

SourceField


DescriptionThe API name of the field that is copied to the target object.

Typestring

TargetField


DescriptionThe API name of the field to copy the data to.

CareSpecialtyRepresents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery.


Fields

DetailsField

Typestring


Description

DescriptionDescription of the specialty.

Typedate

EffectiveFrom


914


DetailsField

DescriptionThe date from which this specialty is effective.

Typedate

EffectiveTo


DescriptionThe date on which this specialty is no longer effective.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

PropertiesCreate, Filter, Group, idLookup Sort, Update

DescriptionName of the specialty master record.

Typereference

OwnerId

915


DetailsField







Typestring

SpecialtyCode


DescriptionCode for the specialty.

Typepicklist

SpecialtyType


DescriptionType of care specialty.

Typepicklist

SpecialtyUsage


DescriptionIndicates whether this specialty is related to the practitioner, the organization, or both.


CareSpecialtyFeedFeed tracking is available for the object.

CareSpecialtyHistoryHistory is available for tracked fields of the object.

916


https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm


CareSpecialtyOwnerSharingRuleSharing rules are available for the object.

CareSpecialtyShareSharing is available for the object.

CategorizedCareFeeAgreementSpecifies the payment terms for contracts of Categorized Care Fee Agreement. This object is available in API version 54.0 and later withthe Provider Network Management permission set license.


Fields

DetailsField

Typestring

CategorizedCareFeeAgreeKey


DescriptionA unique key assigned to the Categorized Care Fee Agreement record.

Typereference



DescriptionThe contract payment agreement record to which this categorized care fee agreement isassociated.





Typestring

Description

917




DetailsField


DescriptionThe description of the procedure category.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typepicklist

LineofBusiness


DescriptionThe line of business for which the agreed upon fee is applicable.


• Commercial

• Medi-Cal

• Medicare

Typestring

Name


DescriptionThe name of the categorized care fee agreement.

Typestring

PricingInformation


918


DetailsField

DescriptionThe agreed upon fee for the procedure category.

Typestring

ProcedureCategory


DescriptionThe category of procedures covered in the Categorized Care Fee Agreement, such asImmunization.


CategorizedCareFeeAgreementFeed on page 1185Feed tracking is available for the object.

CategorizedCareFeeAgreementHistory on page 1193History is available for tracked fields of the object.

ContractPaymentAgreementStores information about the contract payment agreement associated with a contract. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.


Fields

DetailsField

Typepicklist

AgreementType


DescriptionThe payment type supported in the contract payment agreement.


• Bundled Care Fee Agreement

919


DetailsField

• Capitation Care Fee Agreement

• Categorized Care Fee Agreement

• Percentile Based Care Fee Agreement

• Preventive Care Agreement

• Shared Saving Payment Agreement

• Standard Care Fee Agreement

Typereference

ContractId


DescriptionThe contract associated with the contract payment agreement.


Relationship NameContract


Refers ToContract

Typestring

ContractPaymentAgreementKey


DescriptionA unique key assigned to the Contract Payment Agreement record.

Typetextarea

Description


DescriptionThe description of the contract payment agreement.

Typetextarea

EligibleProcedureCodeList


920


DetailsField

DescriptionThe procedure codes that are covered in the contract payment agreement. This value isapplicable for Capitation and Shared Savings payment type.

TypedateTime

EndDateTime


DescriptionThe end date until when the contract payment agreement is effective.

Typereference

FeeScheduleDefinitionId


DescriptionThe fee schedule definition record associated with the contract payment agreement. Thisvalue is applicable only for Fee-for-Service payment types.


Relationship NameFeeScheduleDefinition


Refers ToFeeScheduleDefinition

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



921


DetailsField

Typepicklist

LineofBusiness


DescriptionThe line of business to which the contract payment agreement is applicable.


• Commercial

• Medi-Cal

• Medicaid

• Medicare

Typestring

Name


DescriptionThe name of the contract payment agreement associated with the contract.

Typepercent

StandardFeeCalculationPercentage


DescriptionThe percentage of the baseline fees of the fee schedule definition that's used to calculatethe negotiated fees for the Fee-for-Service payment types.

TypedateTime

StartDateTime


DescriptionThe start date from when the contract payment agreement is effective.

Typepicklist

Status


DescriptionThe status of the contract payment agreement.


922


DetailsField

• ACTIVATED—Activated

• DEACTIVATED—Deactivated

• DRAFT—Draft


ContractPaymentAgreementFeed on page 1185Feed tracking is available for the object.

ContractPaymentAgreementHistory on page 1193History is available for tracked fields of the object.

FeeScheduleDefinitionStores fee schedule information for contracts of Standard Care Fee Agreement types. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.


Fields

DetailsField

Typetextarea

Description


DescriptionThe description of the Fee Schedule Definition.

TypedateTime

EffectiveEndDateTime


DescriptionThe end date until when the Fee Schedule Definition is effective.

TypedateTime

EffectiveStartDateTime

923


DetailsField


DescriptionThe start date from when the Fee Schedule Definition is effective.

Typestring

FeeScheduleDefinitionKey


DescriptionA unique key assigned to the Fee Schedule Definition record.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the Fee Schedule Definition.

Typereference

OwnerId


DescriptionThe unique ID of the owner.


924


DetailsField





FeeScheduleDefinitionFeed on page 1185Feed tracking is available for the object.

FeeScheduleDefinitionHistory on page 1193History is available for tracked fields of the object.

FeeScheduleDefinitionShare on page 1199Sharing is available for the object.

HealthcareFacilityNetworkRepresents a junction object identifying the insurance network that a location or business entity is a part of. Network participation recordsare also stored in this object.


Fields

DetailsField

Typereference

AccountId


DescriptionAccount associated with this facility network.

Typetextarea

Description

925


DetailsField


DescriptionDescription of the facility network.

Typedate

EffectiveFrom


DescriptionThe date from which this facility network is effective.

Typedate

EffectiveTo


DescriptionThe date on which this facility network is no longer effective.

Typepicklist

GenderRestriction


DescriptionIndicates whether this facility network only applies to male or female patients or membersinstead of all patients or members.

Typereference



DescriptionReferences the HealthcareFacility record associated with the network. Use this field if theassociated provider is a business account.



Refers ToHealthcareFacility

926


DetailsField

Typereference



DescriptionHealthcare provider associated with this facility network.


Refers ToHealthcareProvider

Typeint

HighestValidAge


DescriptionIndicates the highest age of patient that this facility network is applicable for.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



927


DetailsField

Typeint

LowestValidAge


DescriptionIndicates the lowest age of patient that this facility network is applicable for.

Typestring

Name


DescriptionName of the facility network record.

Typereference

OwnerId



Typedouble

PanelLimit


DescriptionIndicates the maximum number of patients in the practitioner's panel for this payer networkand practitioner location.

Typepicklist

PanelStatus


DescriptionIndicates whether the practitioner is accepting new patients based on the status of theirpatient panel.

Typereference

PayerNetworkId


928


DetailsField

DescriptionPayer network associated with this facility network.

Typereference

PractitionerFacilityId


DescriptionPractitioner facility associated with this facility network. Use this field if the provider associatedwith the network is an individual practitioner.

Typereference

PractitionerId


DescriptionThe individual practitioner associated with the facility network.

Typereference

ProviderNetworkContractId


DescriptionProvider network contract associated with this facility network



Refers ToProviderNetworkContract

Typereference

ProviderNetworkTierId


DescriptionProvider network tier associated with this facility network.



Refers ToProviderNetworkTier

929


DetailsField

Typestring

SourceSystem



Typestring





HealthcareFacilityNetworkFeedFeed tracking is available for the object.

HealthcareFacilityNetworkHistoryHistory is available for tracked fields of the object.

HealthcareFacilityNetworkOwnerSharingRuleSharing rules are available for the object.

HealthcareFacilityNetworkShareSharing is available for the object.

HealthcarePayerNetworkRepresents an insurance network group. For example, an insurance company’s exclusive provider organization (EPO) plans.


Fields

DetailsField

Typestring

Code

930


DetailsField


DescriptionCode representing the payer network.

Typetextarea

Description


DescriptionDescription of the payer network.

Typedate

EffectiveFrom


DescriptionThe date from which this payer network is effective.

Typedate

EffectiveTo


DescriptionThe date on which this payer network is no longer effective.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

931


DetailsField



Typepicklist

LineofBusiness


DescriptionSpecifies the line of business supported by this payer network.


• Commercial for Groups

• Commercial for Individuals

• Exchange

• Medicaid

• Medicare

Typestring

Name


DescriptionName of the payer network.

Typepicklist

NetworkType


DescriptionType of network, such as HMO, PPO, or EPO.

Typereference

OwnerId




932


DetailsField




Typereference

ParentPayerNetworkId


DescriptionThe parent healthcare payer network associated with this payer network.



Refers ToHealthcarePayerNetwork

Typereference

PayerId


DescriptionThe account associated with the payer network.


Relationship NamePayer


Refers ToAccount

Typestring

SourceSystem



933


DetailsField

Typestring



DescriptionID of an external record on its source system.


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.


Fields

DetailsField

Typereference

AccountId


DescriptionAccount associated with this practitioner facility.


Relationship NameAccount

934






DetailsField


Refers ToAccount

Typedate

EffectiveFrom


DescriptionThe date from which this practitioner facility is effective.

Typedate

EffectiveTo


DescriptionThe date on which this practitioner facility is no longer effective.

Typepicklist

GenderRestriction


DescriptionIndicates whether physician sees patients of a specific gender.

Typereference



DescriptionThe Healthcare facility associated with this healthcare practitioner facility.


Refers ToHealthcareFacility

Typereference



935


DetailsField

DescriptionHealthcare provider associated with this healthcare practitioner facility.




Typeint

HighestValidAge


DescriptionThe highest age of patients that the practitioner sees at this facility

Typedate

InitialStartDate


DescriptionDate the practitioner started at this facility.

Typeboolean

IsActive



Typeboolean

IsDirectoryPrint


DescriptionIndicates whether this facility is displayed in an online or printed directory.

Typeboolean

IsPrimaryCarePhysician


936


DetailsField

DescriptionIndicates whether the practitioner provides primary care services at this facility.

Typeboolean

IsPrimaryFacility


DescriptionIndicates whether the facility is the primary facility for the practitioner.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typeint

LowestValidAge


DescriptionThe lowest age of patients that the practitioner sees at this facility.

Typestring

Name


DescriptionName of the practitioner facility record.

Typereference

OperatingHoursId

937


DetailsField


DescriptionIdentifies the operating hours for this practitioner at this facility.


Relationship NameOperatingHours


Refers ToOperatingHours

Typereference

OwnerId







Typereference

PractitionerId


DescriptionID of the practitioner associated with this facility.


Relationship NamePractitioner


Refers ToContact

938


DetailsField

Typestring

ServiceTerritoryMember


DescriptionThe service territory member associated with the record.

Typestring

SourceSystem



Typestring




Typedate

TerminationDate


DescriptionDate the practitioner stopped working at this facility.

Typepicklist

TerminationReasonCode


DescriptionReason the practitioner facility is no longer current.


HealthcarePractitionerFacilityFeedFeed tracking is available for the object.

939



HealthcarePractitionerFacilityHistoryHistory is available for tracked fields of the object.

HealthcarePractitionerFacilityOwnerSharingRuleSharing rules are available for the object.

HealthcarePractitionerFacilityShareSharing is available for the object.

HealthcareProviderRepresents business-level details about the healthcare organization or the practitioner.


Fields

DetailsField

Typereference

AccountId


DescriptionAccount that this healthcare provider is associated with.

Typedate

EffectiveFrom


DescriptionThe date from which this provider is effective.

Typedate

EffectiveTo


DescriptionThe date on which this provider is no longer effective.

Typetextarea

EhrSystem

940





DetailsField


DescriptionName of the EHR system used at this facility or organization.

Typedate

InitialStartDate


DescriptionDate that the facility first became operational or the practitioner first started practicing.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the provider.

Typereference

OwnerId



941


DetailsField

Typereference

PractitionerId


DescriptionPractitioner that this healthcare provider record is associated with.

Typepicklist

ProviderClass


DescriptionClass of facility, such as an IPA, medical group, or solo practitioner.

Typepicklist

ProviderType


DescriptionType of provider or facility. For example, pharmacist or ambulatory care facility.

Typestring

SourceSystem



Typestring




Typedate

TerminationDate


DescriptionTermination date for this provider.

942


DetailsField

Typestring

TerminationReason


DescriptionReason for termination.

Typeint

TotalLicensedBeds


DescriptionTotal number of licensed beds at this facility, if applicable.


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.


Fields

DetailsField

Typereference

AccountId

943


DetailsField


DescriptionName of the facility that this NPI belongs to.

Typedate

EffectiveFrom


DescriptionThe date from which this NPI is effective.

Typedate

EffectiveTo


DescriptionThe date on which this NPI is no longer effective.

Typeboolean

IsActive



TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



944


DetailsField

Typestring

Name


DescriptionPractitioner or facility name as listed in the NPI database.

Typestring

Npi


DescriptionTen-digit identifier for a provider from the National Plan and Provider Enumeration System.

Typepicklist

NpiType


DescriptionIdentifies whether the NPI is for an individual or an organization.

Typereference

OwnerId



Typereference

PractitionerId


DescriptionName of the practitioner that this NPI belongs to.

Typestring

SourceSystem



945


DetailsField

Typestring





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.


Fields

DetailsField

Typereference

AccountId


DescriptionAccount associated with this specialty.



946


DetailsField


Refers ToAccount

Typedate

EffectiveFrom


DescriptionThe date from which this provider specialty is effective.

Typedate

EffectiveTo


DescriptionThe date on which this provider specialty is no longer effective.

Typeboolean

IsActive



Typeboolean

IsPrimarySpecialty


DescriptionIndicates whether the specialty is the provider's primary specialty.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate

947


DetailsField



Typestring

Name


DescriptionName of the provider’s specialty.

Typereference

OwnerId







Typereference

PractitionerId


DescriptionPractitioner associated with the specialty.




Refers ToContact

948


DetailsField

Typestring

SourceSystem



Typestring




Typereference

SpecialtyId


DescriptionCare specialty record associated with the provider.


Relationship NameSpecialty



Typepicklist

SpecialtyRole


DescriptionRole of the specialty for the provider or practitioner.


HealthcareProviderSpecialtyFeedFeed tracking is available for the object.

949



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.


Fields

DetailsField

Typereference

AccountId


DescriptionThe business account associated with the provider taxonomy.




Refers ToAccount

Typedate

EffectiveFrom


DescriptionThe date from which this taxonomy is effective.

Typedate

EffectiveTo

950





DetailsField


DescriptionThe date on which this taxonomy is no longer effective.

Typeboolean

IsActive



Typeboolean

IsPrimaryTaxonomy


DescriptionIndicates whether the taxonomy is the provider's primary taxonomy.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the provider taxonomy.

951


DetailsField

Typereference

OwnerId







Typereference

PractitionerId


DescriptionContact record for the practitioner.




Refers ToContact

Typestring

SourceSystem



Typestring



DescriptionRecord ID in source system of provider directory.

952


DetailsField

Typereference

TaxonomyId


DescriptionCare taxonomy record associated with the provider taxonomy.


Relationship NameTaxonomy




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.

PercentileBsdCareFeeAgreementSpecifies the payment terms for contracts of Percentile Based Care Fee Agreement. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.


Fields

DetailsField

Typestring

BracketInformation

953






DetailsField


DescriptionThe description of the percentile bracket information.

Typereference



DescriptionThe contract payment agreement record to which this percentile based care fee agreementis associated.





Typecurrency

FifthBracketPrice


DescriptionThe price for the procedure if the member falls into the fifth percentile bracket based on thefactor considered by the payer.

Typecurrency

FirstBracketPrice


DescriptionThe price for the procedure if the member falls into the first percentile bracket based on thefactor considered by the payer.

Typecurrency

FourthBracketPrice


954


DetailsField

DescriptionThe price for the procedure if the member falls into the fourth percentile bracket based onthe factor considered by the payer.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the percentile based care fee agreement.

Typestring




Typereference

ProcedureCodeId





955


DetailsField



Typedouble

RelativeValueUnit


DescriptionThe relative value unit for the procedure.

Typecurrency

SecondBracketPrice


DescriptionThe price for the procedure if the member falls into the second percentile bracket based onthe factor considered by the payer.

Typecurrency

StandardPrice


DescriptionThe standard price for the procedure defined by the governing body.

Typecurrency

ThirdBracketPrice


DescriptionThe price for the procedure if the member falls into the third percentile bracket based onthe factor considered by the payer.


PercentileBsdCareFeeAgreementFeed on page 1185Feed tracking is available for the object.

956


PercentileBsdCareFeeAgreementHistory on page 1193History is available for tracked fields of the object.

ProviderNetworkContractRepresents a provider and a network bound together by a contract. This object is available in API version 53.0 and later with the ProviderNetwork Management permission set license.


Fields

DetailsField

Typereference

ContractId


DescriptionThe contract that ties the network and provider together.



Refers ToContract

Typedate

EndDate


DescriptionThe end date of the contract between the provider and the network.

Typereference

HealthcarePayerNetworkId


DescriptionThe healthcare payer network associated with the contract.


957


DetailsField



Typereference



DescriptionThe healthcare provider associated with the contract.




TypedateTime

LastReferencedDate


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

TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the ProviderNetworkContract record.

Typedate

StartDate

958


DetailsField


DescriptionThe start date of the contract between the provider and the network.

UsageThis object is used to store Network Participation records created by the Network Participation Lightning component. The location ofthe network participation is derived from the provider associated with the contract.


ProviderNetworkContractFeedFeed tracking is available for the object.

ProviderNetworkContractHistoryHistory is available for tracked fields of the object.

ProviderNetworkTierRepresents unique tiers for each provider network. This object is available in API version 53.0 and later with the Provider NetworkManagement permission set license.


Fields

DetailsField

Typestring

Description


DescriptionRepresents the description of the provider network tier.

Typeboolean

IsActive

959


DetailsField


DescriptionIndicates whether the provider network tier is active.


TypedateTime

LastReferencedDate


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

TypedateTime

LastViewedDate



Typestring

Name


DescriptionRepresents the name of the provider network tier.

Typereference

ProviderNetworkId


DescriptionRepresents the parent provider network whose tier is specified by the record.




960



ProviderNetworkTierFeedFeed tracking is available for the object.

ProviderNetworkTierHistoryHistory is available for tracked fields of the object.

PreventiveCareAgreementSpecifies the payment terms for contracts of Preventive Care Fee Agreement. This object is available in API version 54.0 and later withthe Provider Network Management permission set license.


Fields

DetailsField

Typestring

AdditionalInformation


DescriptionAdditional information on the bonus payout and target expectation.

Typestring

BonusMeasureDescription


DescriptionThe description of the bonus measure type.

Typestring

BonusMeasureType


DescriptionThe measure type used to define the bonus payout such as Preventive Readmission Rateand Preventive Admission Rate.

961


DetailsField

Typecurrency

BonusPayout


DescriptionThe bonus paid on reaching the target measure percentage.

Typereference



DescriptionThe contract payment agreement record to which this preventive care fee agreement isassociated.





Typepercent

CurrentMeasurePercent


DescriptionThe current percentage of the specified measure.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


962


DetailsField


Typestring

Name


DescriptionThe name of the preventive care fee agreement.

Typepercent

TargetMeasurePercent


DescriptionThe expected percentage of the specified measure.


PreventiveCareAgreementFeed on page 1185Feed tracking is available for the object.

PreventiveCareAgreementHistory on page 1193History is available for tracked fields of the object.

SharedSavingPaymentAgreementSpecifies the payment terms for contracts of Shared Saving Payment Agreement type. This object is available in API version 54.0 andlater with the Provider Network Management permission set license.


Fields

DetailsField

TypedateTime

BenchmarkEndDateTime

963


DetailsField


DescriptionThe end date of the benchmark period based on which the profit or loss is determined forthe Shared Saving payment type.

TypedateTime

BenchmarkStartDateTime


DescriptionThe start date of the benchmark period based on which the profit or loss is determined forthe Shared Saving payment type.

Typecurrency

BenchmarkedExpenditureAmount


DescriptionThis is the expenditure amount for the selected benchmark period.

Typereference



DescriptionThe contract payment agreement record to which this shared savings payment agreementis associated.





Typecurrency

ForecastedExpenditureAmount


964


DetailsField

DescriptionThis is the expenditure amount that's forecasted for the contract payment agreement duration.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typetextarea

LossPlanDescription


DescriptionThe description of the shared savings payment agreement in case of a loss.

Typestring

Name


DescriptionThe name of the shared savings payment agreement.

Typetextarea

ProfitPlanDescription


DescriptionThe description of the shared savings payment agreement when a profit is attained.

Typepercent

QualifyingProfitPercentage


965


DetailsField

DescriptionThe minimum profit percentage to be reached to share the profit.


SharedSavingPaymentAgreementFeed on page 1185Feed tracking is available for the object.

SharedSavingPaymentAgreementHistory on page 1193History is available for tracked fields of the object.

StandardCareFeeAgreementSpecifies the payment terms for contracts of Standard Care Fee Agreement type. This object is available in API version 54.0 and laterwith the Provider Network Management permission set license.


Fields

DetailsField

Typereference



DescriptionThe contract payment agreement record to which this standard care fee agreement isassociated.





966


DetailsField

Typecurrency

FacilityPrice


DescriptionThe fees when the procedure is performed in a facility location such as a hospital orAmbulatory Surgical Center (ASC).

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of the standard care fee agreement.

Typecurrency

NonFacilityPrice


DescriptionThe fees when the procedure is performed in a non-facility location such as the physician'soffice.

Typestring



967


DetailsField


Typereference

ProcedureCodeId







Typestring

StdCareFeeAgreementKey


DescriptionA unique key assigned to the Standard Care Fee Agreement record.


StandardCareFeeAgreementFeed on page 1185Feed tracking is available for the object.

StandardCareFeeAgreementHistory on page 1193History is available for tracked fields of the object.

Remote Monitoring and Device RegistrationThe remote monitoring and device registration data model provides objects for managing data collected from devices issued to patientsor program members, such as smart watches and heart monitors.

You must have the Health Cloud managed package installed in your org to use the remote monitoring and device registration datamodel.

The remote monitoring and device registration data model includes standard objects and record types. The health insurance standardobjects are visible to users with the Health Cloud and Health Cloud Platform permission set licenses.

968

Remote Monitoring and Device RegistrationHealth Cloud Developer Guide

CareMetricTarget

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

UnitOfMeasure

Represents the unit of measures for care metrics and care observations. 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.

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


Fields

DetailsField

Typereference

CodeId

969


DetailsField



Typedate

EndDate


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

Typeboolean

IsOutcomePositive


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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typedouble

LowerLimit


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

970


DetailsField

Typestring

Name


DescriptionThe name of this care metric target.

Typedouble

NumericValue


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

Typereference

OwnerId



Typereference

PatientId


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

Typedate

StartDate


DescriptionThe date when the care metric target value takes effect.

Typepicklist

Type


971


DetailsField

DescriptionThe care metric value type.


• BOOLEAN

• EXACT

• MAX

• MIN

• RANGE

Typereference

UnitOfMeasureId


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

Typedouble

UpperLimit


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


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.

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

972



Fields

DetailsField

Typestring

Description


DescriptionThe description of this unit of measure.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of this unit of measure.

Typereference

OwnerId



973


DetailsField

Typepicklist

Type


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

Typestring

UnitCode


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


UnitOfMeasureOwnerSharingRuleSharing rules are available for the object.

UnitOfMeasureShareSharing 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.


Fields

DetailsField

Typereference

AdditionalCode1Id


974


DetailsField

DescriptionThe system-defined code that represents the type of the observation. This field is meant tobe used if the CodeId field is not sufficient.

Referenced Objects

• CodeSet

Typereference

AdditionalCode2Id


DescriptionThe system-defined code that represents the type of the observation. This field is meant tobe used if the CodeId and AdditionalCode1Id fields are not sufficient.

Referenced Objects

• CodeSet


BasedOnId


DescriptionThe medication request or service request that the observation is based on.

Referenced Objects



Typereference

BaselineUnitId


DescriptionThe unit of measure for the baseline values of this observation.

Referenced Objects

• UnitOfMeasure

Typestring

BaselineValueText


975


DetailsField


Typereference

BodySiteId


DescriptionThe system-defined code that represent the site of the observation on the patient’s body.

Referenced Objects

• CodeSetBundle

Typepicklist

Category


DescriptionSpecifies the category of the observation.


• Activity

• Exam

• Imaging

• Procedure

• Social-History

• Survey

• Therapy

• Vital-Signs

Typereference

CodeId


DescriptionThe system-defined code that represents the specific observation type.

Referenced Objects

• CodeSet


976


DetailsField

Typereference

DerivationSourceId


DescriptionRepresents the document or observation from which the value of the observation is derived.If the observation value is derived from a document, reference the diagnostic summaryrecord that represents the document. If the observation value is derived from anotherobservation, reference the CareObservation record representing that observation.


Relationship NameDerivationSource


Referenced ObjectsCareObservation, DiagnosticSummary

Typereference

DeviceId


DescriptionThe ID of the device generating the observed value.


TypedateTime

EffectiveDateTime


DescriptionThe date and time when the observation was recorded or the start date and time of theobservation’s clinically relevant period.

Typereference

EncounterId


DescriptionThe encounter related to the observation.

977


DetailsField

Referenced Objects


TypedateTime

EndDateTime


DescriptionThe end date and time of the observation’s clinically relevant period.

Typereference

ExpectedValueId




Typeboolean

HasMetExpectedValue


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

Typereference

IdentifierId


DescriptionThe identifer for the observation.

Referenced Objects

• Identifier

Typeboolean

IsMonitoredRemotely


978


DetailsField

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

IsObserved


DescriptionIndicates the boolean value for the observation. The value is true if something is observed,and false if it’s not. The default value is false. This is field is a duplicate field introduced in APIversion 51.0 that stores the same information as IsOutcomePositive. Use only oneof these two fields for this type of information.

Typeboolean

IsOutcomePositive


DescriptionIndicates the boolean value for the observation. The value is true if something is observed,and false if it’s not. The IsObserved field is a duplicate of this field that stores the sameinformation. Use only one of these two fields for this type of information. The default valueis false.

TypedateTime

IssuedDateTime


DescriptionThe date and time the current version of the observation record is issued.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


979


DetailsField


Typedouble

LowerBaselineValue



Typereference

MethodId


DescriptionThe system-defined code that represents the method of the observation.

Referenced Objects

• CodeSetBundle

Typestring

Name


DescriptionThe name of this care observation.

Typedouble

NumericValue


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

TypedateTime

ObservationEndTime


DescriptionThe date and time when the observation ended.

980


DetailsField

TypedateTime



DescriptionThe date and time when the observation started.

Typepicklist

ObservationStatus


DescriptionSpeicifies the status of the observation


• Amended

• Final

• Preliminary

• Registered


ObservedSubjectId


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

Referenced Objects

• Account


Typereference

ObservedValueCodeId


DescriptionThe system-defined code that represents the observed value.

Referenced Objects

• CodeSetBundle

981


DetailsField

Typedouble



DescriptionThe denominator of the observed value.

Typedouble



DescriptionThe numerator of the observed value.

Typestring

ObservedValueText


DescriptionThe observed value in text form.

Typepicklist

ObservedValueType


DescriptionSpecifies the type of observed values recorded in ObservedValueNumerator andObservedValueDenominator.


• Quantity

• Range

• Ratio

Typereference

ObservedValueUnitId


DescriptionThe unit of measure for the observed value. This is a duplicate field introduced in API version51.0 that stores the same information as UnitOfMeasureId. Use only one of these fieldsto store this information.

982


DetailsField

Referenced Objects

• UnitOfMeasure


ObserverId


DescriptionThe person who made the observation.

Referenced Objects

• Account



PartOfId


DescriptionThe medication statement, procedure, or immunization that this observation is a part of.

Referenced Objects




Typepicklist

ProcessingResult


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


• 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.

983


DetailsField

• 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.

Typestring

SourceSystem



Typestring




TypedateTime




Typereference

UnitOfMeasureId


DescriptionThe unit of measure for the observed value. The ObservedValueUnitId field is aduplicate of this field that stores the same information. Use only one of these fields to storethis information.

Referenced Objects

• UnitOfMeasure

984


DetailsField


Typedouble

UpperBaselineValue



Typepicklist

ValueInterpretation




• High

• Low

• Normal

Additional Information for CareObservation in Other ObjectsIn addition to creating a record using these fields, you can add more details to your CareObservation record by creating records in certainother objects, and referencing your CareObservation record as the parent record. Here’s the list of objects you can associate toCareObservation in this way, the type of information they add, and the field they use to reference CareObservation.


CareObservationIdAssociates information about theobservation’s child components.



CareObservationFeedFeed tracking is available for the object.

CareObservationHistoryHistory is available for tracked fields of the object.

985


Social Determinants

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.

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.

986

Social DeterminantsHealth Cloud Developer Guide

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 CallsdescribeLayout(),describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

Fields

DetailsField Name

Typereference

CareBarrierTypeId

PropertiesFilter, Group, Sort

DescriptionIdentifier for the care barrier type for the patient or member.


Relationship NameCareBarrierType


Refers ToCareBarrierType

Typereference

CaseId


DescriptionID of the associated case.




Refers ToCase

987


DetailsField Name

Typedate

EffectiveFrom


DescriptionThe date on which the barrier becomes effective.

Typedate

EffectiveTo


DescriptionTermination date for the barrier.

Typeboolean

IsActive


DescriptionIndicates whether this barrier is active.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

PropertiesFilter, Group, idLookup, Sort

988


DetailsField Name

Description

Name of the barrier.

Typereference

OwnerId







Typereference

PatientId


DescriptionIdentifier for the patient or member.




Refers ToAccount

Typepicklist

Priority

PropertiesDefaulted on create, Filter, Group, Nillable, Sort, Update

DescriptionPriority of the barrier such as Low or High.

Typepicklist

Status

989


DetailsField Name


DescriptionStatus of the barrier such as Open or Addressed.

Typereference

SurveyResponseId


DescriptionIdentifier for the survey response related to the barrier.


CareBarrierFeedFeed tracking is available for the object.

CareBarrierHistoryHistory is available for tracked fields of the object.

CareBarrierOwnerSharingRuleSharing rules are available for the object.

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.


Fields

DetailsField Name

Typereference

CareBarrierId


Description

ID of the care barrier associated with this record.

990






DetailsField Name


Relationship NameCareBarrier


Refers ToCareBarrier

Typereference

CareDeterminantId


Description

ID of the care determinant associated with this record.


Relationship NameCareDeterminant


Refers ToCareDeterminant

TypedateTime

LastReferencedDate


Description

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

TypedateTime

LastViewedDate


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

991


DetailsField Name


Description

The name of the relationship between the barrier and the determinant. Forexample, Mold growth in home - Housing.

Typereference

OwnerId


Description

The ID of the user who owns this record.






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.


992






Fields

DetailsField

Typestring

Code


DescriptionMedical vocabulary code for the barrier.

Typepicklist

CodeType


DescriptionMedical vocabulary code type for the barrier.


• ICD-10-CM

• SNOMED CT

Typetextarea

Description


DescriptionDescription of the barrier.

Typereference

DiagnosisCodeSetId


DescriptionDiagnosis code set associated with the care barrier type.


Relationship NameDiagnosisCodeSet



993


DetailsField

Typereference

HealthCareDiagnosisId


DescriptionDiagnosis code for the barrier. HealthCareDiagnosisId may be deprecated in a future release,so use DiagnosisCodeSetId instead.


Relationship NameHealthCareDiagnosis


Refers ToHealthCareDiagnosis

Typeboolean

IsActive


DescriptionIndicates whether this care barrier type is active.


TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

994


DetailsField


DescriptionName of the care barrier type.

Typereference

OwnerId








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.

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.


995






Fields

DetailsField Name

Typereference

CareDeterminantTypeId


DescriptionCare determinant for the patient or member.


Relationship NameCareDeterminantType


Refers ToCareDeterminantType

Typeboolean

IsActive


DescriptionIndicates whether this care determinant is active.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name

996


DetailsField Name


Description

Name of the care determinant.

Typereference

OwnerId







Typereference

PatientId


DescriptionIdentifier for the patient or member.




Refers ToAccount

Typepicklist

Priority

PropertiesDefaulted on create, Filter, Group, Nillable, Sort

DescriptionPriority of the determinant such as Low or High.

997


DetailsField Name

Typereference

SurveyResponseId


DescriptionSurvey response related to the determinant.


CareDeterminantFeedFeed tracking is available for the object.

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.


Fields

DetailsField Name

Typetextarea

Description

PropertiesNillable

DescriptionDescription of the determinant.

Typepicklist

Domain

998






DetailsField Name


DescriptionThe domain for the determinant, such as Housing or Transportation.

Typeboolean

IsActive


DescriptionIndicates whether this care determinant type is active.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


Description

Name of the care determinant type.

Typereference

OwnerId


999


DetailsField Name






Typepicklist

Type


DescriptionThe type of determinant.


CareDeterminantTypeFeedFeed tracking is available for the object.

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.


1000






Fields

DetailsField Name

Typestring

Code


DescriptionMedical vocabulary code for the intervention.

Typepicklist

CodeType

PropertiesDefaulted on Create, Filter, Group, Nillable, Sort

DescriptionMedical vocabulary code type for the intervention.

Typetextarea

Description

PropertiesNillable

DescriptionDescription of the intervention.

Typereference

HealthCareProcedureId


DescriptionProcedure code for the intervention.


Relationship NameHealthCareProcedure


Refers ToHealthCareProcedure

Typepicklist

InterventionType


1001


DetailsField Name

DescriptionThe type of intervention.

Typeboolean

IsActive


DescriptionIndicates whether this intervention type is active.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


Description

Name of the intervention type.

Typereference

OwnerId




1002


DetailsField Name




Typereference

ProcedureCodeSetId


DescriptionThe procedure code set associated with the care intervention type.


Relationship NameProcedureCodeSet




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.

1003






Utilization Management

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.

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.

1004

Utilization ManagementHealth Cloud Developer Guide

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.

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.

CareRequestReviewer

Represents the details of a care request reviewer including name, reviewer type, status of the care request at the end of the review,the reviewer’s notes, and date of review. A care request, care request item, care request drug, or care diagnosis can be associatedwith a care request reviewer. This object is available in API version 52.0 and later.

CareDiagnosisRepresents the details of a diagnosis including code type, name, and description. One or more care diagnoses can be associated with acare request.


Fields

DetailsField

Typereference

CareRequestCaseId


DescriptionCase related to the care request.


Relationship NameCareRequestCase


Refers ToCase

1005


DetailsField

Typereference

CareRequestId


DescriptionCare request for the diagnosis.


Relationship NameCareRequest


Refers ToCareRequest

Typestring

CodeDescription


DescriptionDiagnosis code description.

Typepicklist

CodeType


DescriptionCode type for the diagnosis.


• ICD-10-CM

Typestring

CodeTypeIdentifier


DescriptionID of the code type for the diagnosis.

Typereference

DiagnosisCodeId


1006


DetailsField

DescriptionDiagnosis code. DiagnosisCodeId will be deprecated in a future release, so useDiagnosisCodeSetId instead.


Relationship NameDiagnosisCode



Typereference

DiagnosisCodeSetId


DescriptionDiagnosis code set.


Relationship NameDiagnosisCodeSet



Typestring

DischargeCode


DescriptionDischarge diagnosis code.

Typestring

DischargeCodeDescription


DescriptionDescription of the discharge diagnosis code.

Typepicklist

DischargeCodeType

1007


DetailsField


DescriptionCode type for the discharge diagnosis.


• ICD-10-CM

Typestring

DischargeCodeTypeIdentifier


DescriptionID of the code type for the discharge diagnosis.

Typereference

DischargeDiagnosisCodeId


DescriptionDiagnosis code at discharge.


Relationship NameDischargeDiagnosisCode



Typedate

DischargeDiagnosisEffectiveDate


DescriptionEffective date for the discharge diagnosis.

Typedate

DischargeDiagnosisEndDate


DescriptionTermination date for the discharge diagnosis.

1008


DetailsField

Typedate

EffectiveDate


DescriptionEffective date for the diagnosis.

Typedate

EndDate


DescriptionTermination date for the diagnosis.

Typeboolean

IsDischargeDiagnosisPrimary


DescriptionIndicates whether this is the primary discharge diagnosis.


Typeboolean

IsModifiedDiagnosisPrimary


DescriptionIndicates whether this modified diagnosis is the primary diagnosis.


Typeboolean

IsPrimary


DescriptionIndicates whether this diagnosis is the primary diagnosis.


TypedateTime

LastReferencedDate

1009


DetailsField



TypedateTime

LastViewedDate



Typestring

ModifiedCode


DescriptionModified diagnosis code.

Typestring

ModifiedCodeDescription


DescriptionModified diagnosis code description.

Typepicklist

ModifiedCodeType


DescriptionCode type for the modified diagnosis.


• ICD-10-CM

Typestring

ModifiedCodeTypeIdentifier


1010


DetailsField

DescriptionID of the code type for the modified diagnosis.

Typereference

ModifiedDiagnosisCodeId


DescriptionID of the code type for the modified diagnosis. ModifiedDiagnosisCodeId will be deprecatedin a future release, so use ModifiedDiagnosisCodeSetId instead.


Relationship NameModifiedDiagnosisCode



Typereference

ModifiedDiagnosisCodeSetId


DescriptionModified diagnosis code set associated with the diagnosis.


Relationship NameModifiedDiagnosisCodeSet



Typedate

ModifiedEffectiveDate


DescriptionModified effective date for the diagnosis.

Typedate

ModifiedEndDate

1011


DetailsField


DescriptionModified termination date for the diagnosis.

Typestring

Name


DescriptionName of the diagnosis code.

Typereference

RecordTypeId


DescriptionID of the record type assigned to this object.


Relationship NameRecordType


Refers ToRecordType

Typestring

SourceSystem


DescriptionSystem from which this request was sourced.

Typestring



DescriptionID of the system from which the request was sourced.

1012


DetailsField

TypedateTime





CareDiagnosisFeedFeed tracking is available for the object.

CareDiagnosisHistoryHistory is available for tracked fields of the object.

SEE ALSO:

Care Diagnosis Input

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.


Fields

DetailsField Name

TypedateTime

AcknowledgementLetterSentDate


DescriptionDate and time when an acknowledgment letter was sent to the requester.

1013




DetailsField Name

TypedateTime

ActualAdmissionDate


DescriptionActual admission date for the patient.

TypedateTime

ActualDischargeDate


DescriptionActual discharge date for the patient.

Typetextarea

AdmissionNotes


DescriptionNotes related to the admission.

Typepicklist

AdmissionSource


DescriptionWhere the patient was admitted from, for example, a clinic or an emergencyroom.

Typepicklist

AdmissionType


Description

Type of admission, for example, emergency or elective.

TypedateTime

AorReceivedDate


1014


DetailsField Name

Description

Date and time when the Appointment of Representative (AOR) form was received.

TypedateTime

AorRequestedDate


Description

Date and time when the AOR form was requested.

Typepicklist

AppealRequestReasonType


Description


• Service Claim Unpaid

Typereference

AppointedRepresentativeId


DescriptionID of the appointed representative for the member.


Relationship NameAppointedRepresentative


Refers ToAccount

TypedateTime

AppointedRepVerbalContactDate


DescriptionDate and time of verbal contact with the member's appointed representative.

1015


DetailsField Name

TypedateTime

AppointedRepWrittenContactDate


DescriptionDate and time correspondence was sent to the member's appointedrepresentative.

Typeint

ApprovedLengthOfStay


DescriptionApproved number of days for the admission.

Typepicklist

ApprovedLevelOfCare


DescriptionApproved level of care for the patient, for example, Hospital-Observatonor SNF-Rehabilitation.

Typereference

CareRequestCaseId






Refers ToCase

Typestring

ClaimNumber


1016


DetailsField Name

DescriptionClaim number for the medical service or medication, if one exists.

Typepicklist

ClinicalCaseType


DescriptionClinical case type for the patient, for example, High Risk Fall or AdultDiabetes.

Typepicklist

CriteriaMet


Description

Indicates whether criteria for care was met.

Typeint

CumulativeLengthOfStay


Description

Total number of days for the admission.

Typepicklist

CurrentLevelOfCare


Description

Level of care that the patient is receiving.

TypedateTime

DecisionDate


DescriptionDate by which the decision must be made for the request.

Typeint

DecisionDaysRemaining

1017


DetailsField Name


DescriptionNumber of days remaining for a decision or resolution.

Typetextarea

DecisionLetter


DescriptionThe text of the determination letter sent to the member and provider.

Typetextarea

DecisionNotes


Description

Notes related to the decision.

Typepicklist

DecisionReason


Description

Reason for the decision.

Typetextarea

DecisionReasonDescription


Description

Text describing the reason for the decision.

Typeint

DeniedLengthOfStay


Description

Number of days denied for the admission.

1018


DetailsField Name

Typepicklist

DeniedLevelOfCare


Description

Level of care denied for the patient.

Typetextarea

DispositionNotes


Description

Notes related to the disposition of the request.

TypedateTime

DueDate


DescriptionDate the request is due for completion.

TypedateTime

EffectiveFrom


DescriptionThe start date for an effective-date range.

TypedateTime

EffectiveTo


DescriptionThe end date for an effective-date range.

TypedateTime

ExpirationDate


DescriptionExpiration date for the request.

1019


DetailsField Name

TypedateTime

ExtensionRequestReceivedDate


DescriptionDate and time an extension was requested.

Typestring

ExternalComplaintIdentifier


DescriptionComplaint ID number.

Typestring

FacilityRecordNumber



Typepicklist

FacilityRoomBedType


DescriptionType of facility bed for the patient.

Typestring

FacilityRoomNumber


DescriptionThe facility room number for the patient.

Typepicklist

FinalLevelOfCare


DescriptionFinal level of care the patient.

1020


DetailsField Name

Typereference

FirstReviewerId


DescriptionThe name of the person who reviewed the request.


Relationship NameFirstReviewer


Refers ToUser

Typetextarea

FirstReviewerNotes


DescriptionNotes from the first reviewer related to the case.

Typereference

GeneralPractitionerId


DescriptionMember's primary or general care practitioner.


Relationship NameGeneralPractitioner


Refers ToContact

TypedateTime

GeneralPractitionerVerbalNotifiedDate


DescriptionDate when the primary care practitioner was verbally notified of the decision

1021


DetailsField Name

TypedateTime

GeneralPractitionerWrittenNotifiedDate


DescriptionDate when the primary care practitioner was notified of the decision by writtencorrespondence.

Typepicklist

GrievanceType


DescriptionSpecifies the type of grievance.

TypedateTime

InfoReceivedDate


DescriptionDate and time when additional information was received from the provider ormember.

TypedateTime

InfoRequestedDate


DescriptionDate and time when additional information was requested from the provider ormember.

Typedate

InitialDenialNotificationDate


DescriptionDate of initial denial notification.

Typetime

InitialDenialNotificationTime


1022


DetailsField Name

DescriptionThe time when the initial care request was denied.

Typeboolean

IsExtendedRequest


DescriptionIndicates whether a request was extended.

Typeboolean

IsReadmission


DescriptionIndicates whether the care request is for a readmission.


Typeboolean

IsServiceOrMedicationReceived


DescriptionIndicates whether the member has already received the medial service ormedication.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



1023


DetailsField Name

Typereference

MedicalDirectorId


DescriptionName of the medical director who reviewed the request.


Relationship NameMedicalDirector


Refers ToUser

Typetextarea

MedicalDirectorNotes


DescriptionNotes from the medical director related to the request.

Typetextarea

MemberCondition


DescriptionFree-form description of the member's condition.

TypedateTime

MemberContactDateTime


DescriptionDate and time when the member was contacted.

Typedate

MemberDateOfBirth


Description

Date of birth of the member.

1024


DetailsField Name

Typestring

MemberFirstName


Description

First name of the member.

Typepicklist

MemberGender


DescriptionGender of the member.

Typestring

MemberGroupNumber


Description

Insurance group number for the member.

Typereference

MemberId


Description

Insurance identifier for the member.




Refers ToAccount

Typestring

MemberIdentificationNumber


1025


DetailsField Name

Description

Insurance identification number for the member.

Typestring

MemberLastName


Description

Last name of the member.

Typereference

MemberPrimaryPlanId


DescriptionThe primary insurance plan of a member associated with the care request whenthe member is insured under multiple plans.


Relationship NameMemberPrimaryPlan


Refers ToMemberPlan

Typepicklist

MemberPrognosis


DescriptionIndicator of the provider's prognosis for the member.

Typereference

MemberSecondaryPlanId


DescriptionThe secondary insurance plan of a member associated with the care requestwhen the member is insured under multiple plans.


1026


DetailsField Name

Relationship NameMemberSecondaryPlan


Refers ToMemberPlan

Typetextarea

MemberStatus


DescriptionThe member's status at admission, date of outpatient service, or start of care.

TypedateTime

MemberVerbalNotificationDate


DescriptionDate when the member was verbally notified of the decision.

TypedateTime

MemberWrittenNotificationDate


DescriptionDate when the member was notified of the decision by written correspondence.

TypedateTime

ModificationDate


DescriptionDate the case was modified.

Typeint

ModifiedLengthOfStay


DescriptionModified number of days for the admission.

1027


DetailsField Name

Typepicklist

ModifiedLevelOfCare


DescriptionModified level of care for the patient.

Typestring

Name


Description

Name of the care request.

TypedateTime

NextReviewDate


DescriptionDate the next review is scheduled for completion.

Typereference

OriginalDenialMedicalDirectorId


DescriptionThe name of the medical director who denied the original request.


Relationship NameOriginalDenialMedicalDirector


Refers ToUser

Typepicklist

ParProvider


1028


DetailsField Name

DescriptionIndicator of whether this provider has entered into an agreement with theinsurance carrier.

Typepicklist

PlaceOfService


DescriptionPlace of service for the member's care such as an inpatient hospital or anambulatory surgery center.

TypedateTime

PractitionerContactDateTime


DescriptionDate and time when the provider was contacted.

Typepicklist

QuantityType


DescriptionQuantity type for the request such as days, units, or visits.

TypedateTime

ReceivedDate


DescriptionDate the request was received.

Typedate

ReconsiderationDenialNotificationDate


DescriptionThe date when the reconsidered care request was denied.

Typetime

ReconsiderationDenialNotificationTime

1029


DetailsField Name


DescriptionThe time when the reconsidered care request was denied.

Typereference

ReferenceCareRequestCaseId


DescriptionThe reference care request case number associated with the care request.


Relationship NameReferenceCareRequestCase


Refers ToCase

Typestring

ReferenceCaseNumber


DescriptionReference authorization number for an appeal, complaint, or grievance.

TypedateTime

ReopenedDate


DescriptionDate the request was reopened.

Typepicklist

ReopenReason


DescriptionReason the request was reopened.

1030


DetailsField Name

Typetextarea

ReopenReasonDescription


DescriptionDescription of why the request was reopened.

TypedateTime

RequestedDate


DescriptionDate the request was originally requested.

Typeint

RequestedLengthOfStay


DescriptionRequested number of days for the admission.

Typepicklist

RequestedLevelOfCare


DescriptionRequested level of care for the patient.

Typepicklist

RequesterType


DescriptionIndicates the role of the individual initiating the request.

Typereference

RequestingPractitionerId


DescriptionOrdering or referring practitioner for the request.

1031


DetailsField Name


Relationship NameRequestingPractitioner


Refers ToContact

Typepicklist

RequestingPractitionerLicense


DescriptionLicense type of the practitioner.

Typepicklist

RequestingPractitionerSpecialty


DescriptionSpecialty of the practitioner, for example, Family Practice or GeneralSurgery.

TypedateTime

RequestingPractitionerVerbalNotifiedDate


DescriptionDate when the practitioner was verbally notified of the decision.

TypedateTime

RequestingPractitionerWrittenNotifiedDate


DescriptionDate when the practitioner was notified of the decision by writtencorrespondence.

TypedateTime

ResolutionDate


1032


DetailsField Name

DescriptionDate when the complaint, appeal, or grievance was resolved.

TypedateTime

ResolutionLetterSentDate


DescriptionDate and time when a resolution letter was sent to the requester.

Typetextarea

ResolutionNotes


DescriptionResolution notes for the request.

TypedateTime

ReviewDate


DescriptionDate the review was completed.

Typetextarea

RootCauseNotes


DescriptionField for notes related to the root cause for the request.

TypedateTime

ScheduledAdmissionDate


DescriptionAnticipated admission date for the patient.

TypedateTime

ScheduledDischargeDate


1033


DetailsField Name

DescriptionScheduled discharge date for the patient.

Typedate

ServiceDate


DescriptionDate when patient received the service.

Typereference

ServicingFacilityId


DescriptionFacility where the service is being provided.


Relationship NameServicingFacility


Refers ToAccount

Typereference

ServicingPractitionerId


DescriptionPractitioner administering the service.


Relationship NameServicingPractitioner


Refers ToContact

Typepicklist

ServicingPractitionerLicense

1034


DetailsField Name


DescriptionLicense type of the practitioner.

Typepicklist

ServicingPractitionerSpecialty


DescriptionSpecialty of the practitioner.

Typestring

SourceSystem



Typestring




TypedateTime





CareRequestFeedFeed tracking is available for the object.

1035



CareRequestHistoryHistory is available for tracked fields of the object.

SEE ALSO:

Care Request Input

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.


Fields

DetailsField

Typemultipicklist

CareRequestRecords


DescriptionThe list of available objects used to configure the care request. The possible values are:

• CareDiagnosis

• CareRequestItem

• CareRequestDrug

Typestring

CareRequestRecordType


DescriptionThe record type for the care request.

Typepicklist

CareRequestType


DescriptionType of care request. For example, an appeal, a service request, or an admission.

1036



DetailsField

Typestring

DeveloperName


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


DescriptionIndicates whether this configuration is active.

Typeboolean

IsDefaultRecordType


DescriptionIndicates whether this is the default record type.

Typepicklist

Language


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)

1037


DetailsField

• 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


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.


Fields

DetailsField Name

Typeint

ApprovedUnits


DescriptionApproved quantity of the drug.

1038


DetailsField Name

Typereference

CareRequestCaseId






Refers ToCase

Typereference

CareRequestId


DescriptionCare request for the care request drug.





Typepicklist

ClinicalDetermination


DescriptionThe clinical determination of the drug request.

Typetextarea

ClinicalDeterminationNote


DescriptionThe notes related to the clinical determination.

1039


DetailsField Name

Typereference

ClinicalDeterminationReasonId


DescriptionThe reason for the clinical determination.


Relationship NameClinicalDeterminationReason


Refers ToCodeSet

Typestring

Code


DescriptionCode for the drug.

Typepicklist

CodeType


DescriptionID code type for the drug.

Typeint

DaysSupply


DescriptionNumber of days to supply the drug.

TypedateTime

DecisionDate


DescriptionThe date and time when the decision was made for this drug request.

1040


DetailsField Name

Typeint

DeniedUnits


DescriptionDenied quantity of the drug.

Typeaddress

DispenserAddress


DescriptionPharmacy address.

Typephone

DispenserFaxNumber


DescriptionPharmacy fax number.

Typestring

DispenserIdentifier


DescriptionID for the pharmacy.

Typestring

DispenserName


DescriptionID for the pharmacy.

Typephone

DispenserPhoneNumber


DescriptionPharmacy phone number.

1041


DetailsField Name

Typestring

DispenserTaxIdentifier


DescriptionPharmacy tax identification number.

TypedateTime

DispenserVerbalNotificationDateTime


DescriptionDate and time when the pharmacy or pharmacy benefit manager was contactedverbally.

TypedateTime

DispenserWrittenNotificationDateTime


DescriptionDate and time when the pharmacy or pharmacy benefit manager was notifiedin writing or electronically.

Typereference

DispensingPharmacyId


DescriptionThe pharmacy that dispenses the drug.


Relationship NameDispensingPharmacy


Refers ToAccount, HealthcareProvider

Typestring

Dose


1042


DetailsField Name

DescriptionDose of the drug.

Typestring

Frequency


DescriptionFrequency of the drug.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typereference

MedicationCodeId


DescriptionThe code of the care request drug.


Relationship NameMedicationCode


Refers ToMedication

1043


DetailsField Name

Typestring

ModifiedCode


DescriptionCode for the modified drug.

Typepicklist

ModifiedCodeType


DescriptionID code type for the modified drug.

Typeint

ModifiedDaysSupply


DescriptionNumber of days of supply for the modified drug.

Typestring

ModifiedDose


DescriptionDose of the modified drug.

Typestring

ModifiedFrequency


DescriptionFrequency of the modified drug.

Typestring

ModifiedName


DescriptionName of the modified drug.

1044


DetailsField Name

Typetextarea

ModifiedSig


DescriptionDirections for use of the modified drug.

Typestring

ModifiedStrength


DescriptionStrength of the modified drug.

Typeint

ModifiedTherapyDuration


DescriptionDuration of therapy for the modified drug.

Typeint

ModifiedUnits


DescriptionModified quantity of the drug.

Typestring

Name


Description

Name of the drug.

Typedate

PrescriptionDate


DescriptionDate for the prescription.

1045


DetailsField Name

Typedate

PrescriptionFillDate


DescriptionNumber of fills for the prescription.

Typeint

PrescriptionFills


DescriptionNumber of fills for the prescription.

Typestring

PrescriptionNumber


DescriptionDrug prescription number.

Typestring

ServiceCategory


DescriptionName of the service type such as medical care, diagnostic radiology, pharmacy,or diagnostic laboratory.

Typestring

ServiceCategoryCode


DescriptionAlphanumeric code that uniquely identifies a service type.

Typetextarea

Sig


1046


DetailsField Name

DescriptionDirections for use of the drug.

Typestring

SourceSystem



Typestring




TypedateTime




Typestring

Strength


DescriptionStrength of the drug.

Typeint

TherapyDuration


DescriptionDuration of therapy for the drug.

Typeint

Units


1047


DetailsField Name

DescriptionQuantity of the drug.


CareRequestDrugFeedFeed tracking is available for the object.

CareRequestDrugHistoryHistory is available for tracked fields of the object.

SEE ALSO:

Care Request Drug Input

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.


Fields

DetailsField

Typepicklist

AmbulanceTransportReason


DescriptionReason for ambulance transport.

Typepicklist

AmbulanceTransportType


DescriptionType of ambulance transport.

1048




DetailsField

TypedateTime

AppealEffectuationDateTime


DescriptionThe effective date of the outcome of the appeal request. For example, if a claim wassuccessfully appealed, this field displays the date when the claim was paid.

Typereference

CareRequestCaseId


DescriptionCase related to the care request extension.




Refers ToCase

Typereference

CareRequestId


DescriptionCare request related to the care request extension.





Typepicklist

DocumentAttachmentStatus


1049


DetailsField

DescriptionThe status of a clinical document upload.


• Complete

• Incomplete


Typereference



DescriptionThe healthcare provider associated with the care request agianst whom the Grievance isfiled


Relationship NameHealthcareProvider



Typedate

HomeHealthCertificationEndDate


DescriptionCertification end date for home health care.

Typedate

HomeHealthCertificationStartDate


DescriptionCertification start date for home health care.

Typedate

HomeHealthStartDate


1050


DetailsField

DescriptionDate that home health services are scheduled or anticipated to start.

Typepicklist

IndependentReviewDetermination


DescriptionThe determination made by the independent review.


• Other

• Overturned

• Upheld

TypedateTime

IndependentReviewDeterminationDate


DescriptionThe date when the determination was made by the independent review.

TypedateTime

IndependentReviewSubmissionDate


DescriptionThe date when the review request was submitted for independent review.

Typeboolean

IsIndependentReviewRequired


DescriptionIndicates whether an independent review is required


Typeboolean

IsMedicareCoverage


1051


DetailsField

DescriptionIndicates whether the member has Medicare coverage.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionName of the care request extension.

Typepicklist

NursingHomeResidentialStatus


DescriptionNursing home resident status at the time of service.

Typepicklist

PriorDischargeStatus


DescriptionSpecifies the previous discharge status of the member.


• Discharged to court/law enforcement.

• Discharged to home with home health.

1052


DetailsField

• Discharged to home/self care.

• Discharged to hospice care.

• Discharged/transferred to LTACC.

• Discharged/transferred to Psychiatric facility.

• Discharged/transferred to SNF.

• Discharged/transferred to other acute care facility.

• Expired

• Left against medical advice (AMA).

Typereference

RecordTypeId


DescriptionCategory type of the request.


Relationship NameRecordType


Refers ToRecordType

TypedateTime

ReopenDecisionDateTime


DescriptionThe date when the decision on the reopen request was made.

Typepicklist

ReopenRequestOutcome


DescriptionThe result of the reopen request.


• Overturned

• Upheld

1053


DetailsField

Typepicklist

ReopenRequestType


DescriptionThe type of reopen request.


• Peer-to-Peer Review

• Reconsideration

Typetextarea

RequestExtensionReason


DescriptionThe reason for requesting the care extension.

TypedateTime

RequestExtnDecisionDateTime


DescriptionThe date when the decision to extend the care request extension was made.

Typepicklist

RequestOutcome


DescriptionSpecifies the outcome of the request.


• Overturned

• Partially Pending

• Partially Upheld

• Upheld

• Voided

Typetextarea

RequestOutcomeDesc

1054


DetailsField


DescriptionThe description of the request outcome.

Typepicklist

RequestType


DescriptionCategory type of the request.

Typereference

RequestingProviderId


DescriptionThe provider who requested a prior authorization for a care request. This field is available inAPI version 55.0 and later.


Relationship NameRequestingProvider



Typetextarea

ResolutionDescription


DescriptionThe description of the care request.

Typepicklist

ServiceLevel


DescriptionThe level of service rendered.

1055


DetailsField

Typestring

ServiceType


DescriptionClassification of the type of service.

Typereference

ServicingFacilityId


DescriptionThe facility where a patient receives service for a care request. This field is available in APIversion 55.0 and later.


Relationship NameServicingFacility


Refers ToHealthcareFacility, HealthcarePractitionerFacility

Typereference

ServicingProviderId


DescriptionThe provider who provides the service for a care request. This field is available in API version55.0 and later.


Relationship NameServicingProvider



Typereference

SubscriberId


1056


DetailsField

DescriptionIdentifier for the person who has subscribed to the health plan.


Relationship NameSubscriber


Refers ToAccount

Typestring

SubscriberMemberIdentifier


DescriptionMember ID for the subscriber.

Typedouble

TotalAmbulanceTransportDistance


DescriptionTotal distance traveled during ambulance transport.

Typereference

UnitofMeasureId


DescriptionThe unit of measure for the quantity associated with a prior authorization request. This fieldis available in API version 55.0 and later.


Relationship NameUnitofMeasure


Refers ToUnitOfMeasure

1057



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.


Fields

DetailsField Name

Typedouble

AmbulanceTransportDistance


DescriptionDistance traveled during ambulance transport.

Typepicklist

AmbulanceTransportReason


DescriptionReason for ambulance transport.

Typepicklist

AmbulanceTransportType


DescriptionType of ambulance transport.

1058




DetailsField Name

Typeint

ApprovedLengthOfStay


DescriptionThe number of days requested for the admission.

Typepicklist

ApprovedLevelOfCare


DescriptionSpecifies the approved level of care for the patient.


• Hospital - Inpatient

• Hospital - Intensive Care

• Hospital - Rehabilitation

• Psychiatric Intensive Care

• Psychiatric Room - Semi-private

• Psychiatric Room and Board - Private

• Psychiatric Ward

• SNF - Inpatient

• SNF - Rehabilitation

• SNF - Specialized Care

Typeint

ApprovedQuantity


DescriptionThe approved quantity of the care item.

Typedate

ApprovedServiceEndDate


DescriptionThe end date of the approved service that the patient received.

1059


DetailsField Name

Typedate

ApprovedServiceStartDate


DescriptionThe start date of the approved service that the patient received.

Typereference

CareRequestCaseId






Refers ToCase

Typereference

CareRequestId


DescriptionCare request for the care request item.





Typestring

CodeDescription


DescriptionDescription of the denied service code.

1060


DetailsField Name

Typepicklist

CodeType


Description

Code type for the service.

Typestring

CodeTypeIdentifier


Description

ID of the code type for the service.

Typeint

CumulativeLengthOfStay


DescriptionThe number of days a patient is admitted.

Typepicklist

CurrentLevelOfCare


DescriptionSpecifies the level of care the patient is receiving.









• SNF - Inpatient



1061


DetailsField Name

TypedateTime

DecisionDate


DescriptionThe date and time when the last decision was made for this care request item.

Typepicklist

DeniedLevelOfCare


DescriptionThe level of care denied for the patient.









• SNF - Inpatient



Typeint

DeniedQuantity


DescriptionThe quantity of the denied service.

Typedate

EffectiveDate


Description

Effective date for the diagnosis.

1062


DetailsField Name

Typedate

EndDate


Description

Termination date for the service.

Typetextarea

FreeFormProcedureDescription


Description

Free-form description of the procedure.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

ModifiedCodeDescription


DescriptionDescription of the modified service code.

Typestring

ModifiedCodeIdentifier

1063


DetailsField Name


DescriptionID of the code for the modified service.

Typepicklist

ModifiedCodeType


DescriptionCode type for the modified service.

Typestring

ModifiedCodeTypeIdentifier


DescriptionID of the code type for the modified service.

Typedate

ModifiedEffectiveDate


DescriptionEffective date for the modified service.

Typedate

ModifiedEndDate


DescriptionTermination date for the modified service.

Typepicklist

ModifiedLevelOfCare


DescriptionSpecifies the modified level of care for the patient.



1064


DetailsField Name







• SNF - Inpatient



Typestring

ModifiedModifier


DescriptionModifier for modified service code.

Typestring

ModifiedModifierDescription


DescriptionModifier description for modified service code.

Typereference

ModifiedProcedureCodeId


DescriptionCode for the modified service, drug, or equipment. ModifiedProcedureCodeIdwill be deprecated in a future release, so use ModifiedProcedureCodeSetId instead.


Relationship NameModifiedProcedureCode



Typereference

ModifiedProcedureCodeSetId

1065


DetailsField Name


DescriptionThe code set for the modified service, drug, or device associated with the carerequest item.


Relationship NameModifiedProcedureCodeSet



Typeint

ModifiedQuantity


DescriptionThe modified quantity of requested care.

Typestring

Modifier


Description

Modifier for the service code.

Typestring

Modifier2


Description

Second modifier for service code.

Typestring

Modifier2Description


Description

Description of the second modifier for the service code.

1066


DetailsField Name

Typestring

Modifier3


Description

Third modifier for service code.

Typestring



Description

Description of the third modifier for the service code.

Typestring

Modifier4


Description

Fourth modifier for service code.

Typestring



Description

Description of the fourth modifier for the service code.

Typereference

ModifierCodeSetId


DescriptionThe modifier code set for the service code associated with the care request item.


Relationship NameModifierCodeSet


1067


DetailsField Name


Typestring

ModifierDescription


Description

Description of the modifier for the service code

Typestring

Name


Description

ID of the service code.

Typereference

ProcedureCodeId


Description

Code for the service, drug, or equipment. ProcedureCodeId will be deprecatedin a future release, so use ProcedureCodeSetId instead.





Typereference

ProcedureCodeSetId


DescriptionThe code set for the service, drug, or device associated with the care requestitem.


1068


DetailsField Name

Relationship NameProcedureCodeSet



Typeint

Quantity


Description

The quantity of the item that is requested.

Typepicklist

QuantityType


Description

Quantity type for the request such as days, units, or visits.

Typeint

RequestedLengthOfStay


DescriptionThe number of days requested for the admission.

Typepicklist

RequestedLevelOfCare


DescriptionSpecifies the requested level of care for the patient.







1069


DetailsField Name



• SNF - Inpatient



Typedate

RequestedServiceEndDate


DescriptionThe end date of the requested service.

Typedate

RequestedServiceStartDate


DescriptionThe start date of the requested service.

Typestring

ServiceCategory


DescriptionName of the service type such as medical care, diagnostic radiology, pharmacy,or diagnostic laboratory.

Typestring

ServiceCategoryCode


DescriptionAlphanumeric code that uniquely identifies a service type

Typestring

SourceSystem


DescriptionSystem from which the request was sourced.

1070


DetailsField Name

Typestring




TypedateTime




Typepicklist

Status


DescriptionThe authorization status of this service.

Typepicklist

StatusReason


DescriptionReason for the authorization status of this service.

Typereference

TransportLocationId


DescriptionDestination location for ambulance transport.


Relationship NameTransportLocation


Refers ToAccount

1071



CareRequestItemFeedFeed tracking is available for the object.

CareRequestItemHistoryHistory is available for tracked fields of the object.

SEE ALSO:

Care Request Item Input

CareRequestReviewerRepresents the details of a care request reviewer including name, reviewer type, status of the care request at the end of the review, thereviewer’s notes, and date of review. A care request, care request item, care request drug, or care diagnosis can be associated with a carerequest reviewer. This object is available in API version 52.0 and later.


Fields

DetailsField

Typereference

CareRequestCaseId


DescriptionThe case related to the care request.




Refers ToCase

Typereference

CareRequestReferenceId


1072




DetailsField

DescriptionThe care request, care request item, care request drug, or care diagnosis associated with thecare request reviewer.


Relationship NameCareRequestReference


Refers ToCareDiagnosis, CareRequest, CareRequestDrug, CareRequestItem

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name associated with the record.

TypedateTime

ReviewDate


DescriptionThe date when the care request was reviewed.

1073


DetailsField

Typereference

ReviewerId


DescriptionThe name of the user who reviewed the care request.


Relationship NameReviewer


Refers ToHealthcareProvider, User

Typetextarea

ReviewerNotes


DescriptionThe notes related to the review.

Typepicklist

ReviewerType


DescriptionThe type of the reviewer who reviewed the care request.


• Medical Director Review

• Peer Review

• Physician Review

• Registered Nurse Review

The default value is 'Registered Nurse Review'.

Typepicklist

Status


DescriptionThe status of the care request.

1074


DetailsField


• Approved

• Denied

• In process

The default value is 'Approved'.


CareRequestReviewerFeedFeed tracking is available for the object.

CareRequestReviewerHistoryHistory is available for tracked fields of the object.

Benefits Verification Data Model

EDITIONS



The benefits verification data model supports providers, payers, and life sciences organizations indetermining benefits coverage for services and products provided.

The benefits verification objects are available to users with the Health Cloud and the Health CloudPlatform permission set licenses and the Health Foundation permission set. You must have theHealth Cloud managed package installed in your org to access this data model. Available in APIversion 53.0 and later.

PLACEHOLDER IMAGE

CareBenefitVerifySettings

Configuration settings for benefit verification requests. This object is available in API version 53.0 and later.

CareBenefitVerifyRequest

Request for verification of benefits. This object is available in API version 53.0 and later.

1075

Benefits Verification Data ModelHealth Cloud Developer Guide



CareLimitType

Defines the characteristics of limits on benefit provision. This object is available in API version 53.0 and later.

CoverageBenefit

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

CoverageBenefitItem

Specific service covered by the insurance plan. This object is available in API version 53.0 and later.

CoverageBenefitItemLimit

Allows you to track details associated with a specific benefit as it relates to expenditures, limits, coverage levels, eligibility, andexclusion. This object is available in API version 53.0 and later.

MemberPlan

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

PurchaserPlan

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

SEE ALSO:

Health Cloud Administration Guide: Setting up Benefit Verification

CareBenefitVerifySettingsConfiguration settings for benefit verification requests. This object is available in API version 53.0 and later.


Fields

DetailsField

Typestring

CodeSetType


DescriptionSpecifies the code set type to use for the benefits verification service type codes.

Typestring

DefaultNpi


DescriptionDefault National Provider Identifier to be used in the benefits verification request.

1076


https://help.salesforce.com/articleView?id=sf.admin_benefit_verification_setup.htm&language=en_US

DetailsField

Typestring

DeveloperName



Typestring

GeneralPlanServiceTypeCode


DescriptionService type code for the plan benefits as a whole.

Typeboolean

IsDefault


DescriptionSpecifies whether this record is the default verification service.


Typepicklist

Language


Description[DESCRIPTION]


• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

1077


DetailsField

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typestring

MasterLabel



Typestring

NamespacePrefix



Typestring

OrganizationName



Typereference

ServiceApexClassId


DescriptionIdentifies the Apex class used to access the benefits verification service.


Relationship NameServiceApexClass


1078


DetailsField

Refers ToApexClass

Typereference

ServiceNamedCredentialId


DescriptionCredential used to access the benefits verification service.


Relationship NameServiceNamedCredential


Refers ToNamedCredential

Typestring

ServiceTypeSourceSystem


DescriptionExternal EHR system storing service type information.

Typetextarea

UriPath


DescriptionExternal endpoint where Health Cloud can access the verification service data.

CareBenefitVerifyRequestRequest for verification of benefits. This object is available in API version 53.0 and later.


1079


Fields

DetailsField

Typereference

CaseId


DescriptionIdentifies the associated case.




Refers ToCase

Typereference

CoverageBenefitId


DescriptionIdentifies the set of services covered by the insurance plan.





TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


1080


DetailsField


Typereference

MemberPlanId


DescriptionIdentifies the member plan that includes the benefit item being verified.


Relationship NameMemberPlan


Refers ToMemberPlan

Typestring

Name



TypedateTime

RequestDate


DescriptionDate of verification request.

Typereference

RequestedById


DescriptionPerson or organization requesting verification.


Relationship NameRequestedBy

1081


DetailsField


Refers ToUser

Typebase64

ResponseBody


DescriptionFull JSON response from external system.

Typepicklist

ResponseContentType




• application/html

• application/java-archive

• application/javascript

• application/json

• application/msword

• application/octet-stream

• application/octet-stream;type=unknown

• application/opx

• application/pdf

• application/postscript

• application/rtf

• application/vnd.box.notes

• application/vnd.google-apps.document

• application/vnd.google-apps.drawing

• application/vnd.google-apps.form

• application/vnd.google-apps.presentation

• application/vnd.google-apps.script

• application/vnd.google-apps.spreadsheet

• application/vnd.ms-excel

• application/vnd.ms-excel.sheet.macroEnabled.12

1082


DetailsField

• application/vnd.ms-infopath

• application/vnd.ms-powerpoint

• application/vnd.ms-powerpoint.presentation.macroEnabled.12

• application/vnd.ms-word.document.macroEnabled.12

• application/vnd.oasis.opendocument.presentation

• application/vnd.oasis.opendocument.spreadsheet

• application/vnd.oasis.opendocument.text

• application/vnd.openxmlformats-officedocument.presentationml.presentation

• application/vnd.openxmlformats-officedocument.presentationml.slideshow

• application/vnd.openxmlformats-officedocument.presentationml.template

• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

• application/vnd.openxmlformats-officedocument.spreadsheetml.template

• application/vnd.openxmlformats-officedocument.wordprocessingml.document

• application/vnd.openxmlformats-officedocument.wordprocessingml.template

• application/vnd.visio

• application/x-gzip

• application/x-java-source

• application/x-javascript

• application/x-shockwave-flash

• application/x-sql

• application/x-zip-compressed

• application/xhtml+xml

• application/xml

• application/zip

• audio/mp4

• audio/mpeg

• audio/x-aac

• audio/x-ms-wma

• audio/x-ms-wmv

• audio/x-wav

• image/bmp

• image/gif

• image/jpeg

• image/jpeg;type=mobile

• image/png

• image/svg+xml

• image/tiff

• image/vnd.adobe.photoshop

1083


DetailsField

• image/vnd.dwg

• image/x-photoshop

• message/rfc822

• model/vnd.usdz+zip

• text/css

• text/csv

• text/html

• text/plain

• text/rtf

• text/snote

• text/stypi

• text/vnd.salesforce.quip-chat

• text/vnd.salesforce.quip-doc

• text/vnd.salesforce.quip-sheet

• text/vnd.salesforce.quip-slides

• text/vnd.salesforce.quip-template

• text/vtt

• text/webviewhtml

• text/x-c

• text/x-c++

• text/xml

• video/mp4

• video/mpeg

• video/ogg

• video/quicktime

• video/x-m4v

• video/x-ms-asf

• video/x-msvideo

Typeint

ResponseLength



Typestring

ResponseName

1084


DetailsField



Typepicklist

Status


DescriptionStatus of the verification request.


• Completed

• Error

• Partial

• Pending

Typetextarea

StatusReason


DescriptionResponse to verification request.

CareLimitTypeDefines the characteristics of limits on benefit provision. This object is available in API version 53.0 and later.


Fields

DetailsField

Typestring

DeveloperName


1085


DetailsField


Typepicklist

Language




• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typestring

LimitType



Typestring

LimitType


1086


DetailsField

DescriptionSource of limit on benefit provision, such as a co-insurance requirement.

Typestring

MasterLabel



Typepicklist

MetricType


DescriptionQuantity used for calculating the benefit limit, such as number of visits, amount spent, orpercentage of allowed expenditure.


• Amount

• Money

• Percentage

• Text

Typestring

NamespacePrefix



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


1087


Fields

DetailsField Name

Typetextarea

BenefitNotes


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

Typedate

BenefitPeriodEndDate


DescriptionLast day of the coverage benefit period.

Typedate

BenefitPeriodStartDate


DescriptionFirst day of the coverage benefit period.

Typetextarea

CoinsuranceNotes


DescriptionAdditional information about the contribution the member makes towardstreatment.

Typetextarea

CopayNotes


DescriptionAdditional information on the copayment amounts members contributes.

Typepicklist

CoverageType

1088


DetailsField Name


DescriptionGeneral category of service covered.


• Dental

• Medical

• Vision

Typetextarea

DeductibleNotes


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

Typestring

Disclaimer



Typestring

Disclaimer


DescriptionOverall plan benefit disclaimers.

Typecurrency



DescriptionThe amount the member contributes towards emergency treatment.

Typecurrency

FamilyInNetworkDeductibleApplied


1089


DetailsField Name

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

Typecurrency

FamilyInNetworkDeductibleLimit


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


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


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


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

1090


DetailsField Name


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


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

Typecurrency

FamilyOutofNetworkDeductibleLimit


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


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


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.

1091


DetailsField Name

Typecurrency

FamilyOutofNetworkOutofPocketLimit


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


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


DescriptionThe amount the member has paid for health care provided by the health plan’spreferred providers to the most costly family member.

Typecurrency

IndividualInNetworkDeductibleLimit


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.

Typecurrency

IndividualInNetworkDeductibleRemaining


1092


DetailsField Name

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


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


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


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


DescriptionThe amount the member has paid for health care provided by non-preferredproviders to the most costly family member.

Typecurrency

IndividualOutofNetworkDeductibleLimit

1093


DetailsField Name


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


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


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


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


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.

1094


DetailsField Name

Typecurrency



DescriptionThe amount the member contributes towards treatment undertaken by thehealth plan’s preferred providers.

Typepercent



DescriptionThe percentage of treatment cost the member pays for treatment undertakenby the health plan’s preferred providers.

Typecurrency



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.

Typeboolean

IsActive




Typeboolean

IsActive


DescriptionSpecifies whether the coverage benefit is currently in force.


1095


DetailsField Name

Typedatetime

LastReferencedDate



Typedatetime

LastViewedDate



Typetextarea



DescriptionAdditional information on the lifetime maximum payments the member Will beexpected to make.

Typereference

MemberId


DescriptionThe ID of the member receiving these benefits.

Typereference

MemberPlanId


DescriptionThe ID of the member plan receiving these benefits.

Typestring

Name

1096


DetailsField Name


DescriptionName of these coverage benefits.

Typecurrency



DescriptionThe amount the member contributes towards treatment undertaken bynon-preferred providers.

Typepercent

OutofNetworkCoinsurancPercentage



Typecurrency



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


DescriptionAdditional information about the out-of-pocket payment the member makes.

Typereference

OwnerId


1097


DetailsField Name


Typecurrency

PrimaryCareCopay


DescriptionThe amount the member contributes towards primary care treatment.

Typestring

SourceSystem


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

Typestring




Typedate




Typecurrency

SpecialistCopay


DescriptionThe amount the member contributes towards specialist consultations.

Typecurrency

UrgentCareCopay


1098


DetailsField Name

DescriptionThe amount the member contributes towards urgent care.

TypedateTime

VerificationDate


DescriptionDate on which the benefit was verified.


CoverageBenefitFeedFeed tracking is available for the object.

CoverageBenefitHistoryHistory is available for tracked fields of the object.

CoverageBenefitOwnerSharingRuleSharing rules are available for the object.

CoverageBenefitShareSharing is available for the object.

CoverageBenefitItemSpecific service covered by the insurance plan. This object is available in API version 53.0 and later.


Fields

DetailsField

Typestring

BenefitCategory


DescriptionName of the category this benefit is in.

1099


DetailsField

Typereference

CodeSetServiceTypeId


DescriptionID of a Code Set Service Type in the Code Set object.


Relationship NameCodeSetServiceType


Refers ToCodeSet

Typereference

CoverageBenefitId


DescriptionThe ID of the covered benefit this item belongs to.





Typestring

CoverageLevel


DescriptionDescription of the level of coverage provided by this item.

Typeboolean

DoesDeductibleApply


DescriptionSpecifies whether the benefit item requires a prior expenditure by the patient.

1100


DetailsField


Typetextarea

InNetworkCoverage


DescriptionDescription of the in network coverage provided by this item.

Typeboolean

IsActive


DescriptionSpecifies whether the benefit item is currently available.


Typeboolean

IsInPlanNetwork




Typeboolean

IsPreauthorizationRequired


DescriptionSpecifies whether the service must be approved before use.


TypedateTime

LastReferencedDate



1101


DetailsField

TypedateTime

LastViewedDate



Typereference

MemberId


DescriptionThe ID of the member receiving this benefit item.




Refers ToAccount

Typestring

Name


DescriptionName of this coverage benefit item.

Typetextarea

Notes


DescriptionAdditional information about this coverage benefit item.

Typetextarea



1102


DetailsField

DescriptionDescription of the coverage for non-preferred providers.

Typereference

OwnerId







Typestring

ServiceType


DescriptionThe type of service this plan benefit item provides.

Typestring

ServiceTypeCode


DescriptionThe code for the type of service this plan benefit item provides.

Typestring

SourceSystem


DescriptionThe name of the system this coverage benefits item record came from.

Typestring


1103


DetailsField



TypedateTime



DescriptionThe ID of this coverage benefits item record on its source system.

TypedateTime



DescriptionThe date on which this coverage benefits item was last changed on the source system.

Typestring

TimePeriod


DescriptionA description of the period this plan benefit item covers.

CoverageBenefitItemLimitAllows you to track details associated with a specific benefit as it relates to expenditures, limits, coverage levels, eligibility, and exclusion.This object is available in API version 53.0 and later.


Fields

DetailsField

Typestring

AllowedLimit

1104


DetailsField


DescriptionMaximum amount that will be paid for the service.

Typestring

AppliedLimit


DescriptionSpecifies whether the benefit has been claimed.

Typereference

CareLimitTypeId


DescriptionSpecifies whether the limit is a required payment or excluded service.


Relationship NameCareLimitType


Refers ToCareLimitType

Typereference

CoverageBenefitItemId


DescriptionSpecific service covered by the insurance plan.


Relationship NameCoverageBenefitItem


Refers ToCoverageBenefitItem

1105


DetailsField

Typepicklist

CoverageLevel


DescriptionDefines the persons eligible for the benefit item.


• EmployeeSpouse—Employee & Spouse

• Family

• Individual

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typetextarea

LimitNotes


DescriptionGeneral information about the limit.

Typestring

Name



1106


DetailsField

Typepicklist

NetworkType


DescriptionSpecifies whether the provider is eligible for reimbursement.


• In

• NA

• Out

Typedouble

PriorityOrder


DescriptionThis limit's position in the sequence for calculating limits.

Typepicklist

TermType


DescriptionSpecifies the type of time period during which the benefit item is available.


• Calendar Year

• Day

• Month

• Year to Date

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.


1107


Fields

DetailsField Name

Typestring

Affiliation



Typedate

EffectiveFrom


DescriptionThe date from which this member plan is effective.

Typedate

EffectiveTo


DescriptionThe date on which this member plan ceases to be effective.

Typestring

GroupNumber


DescriptionThe group number or policy number of the primary member.

Typestring

IssuerNumber


DescriptionReference number for the issuer of the plan.

Typedatetime

LastReferencedDate


1108


DetailsField Name


Typedate

LastVerification


DescriptionThe date on which this plan was last verified.

Typedatetime

LastViewedDate



Typereference

MemberId


DescriptionThe ID of the member’s record.

Typestring

MemberNumber


DescriptionThe member’s reference number for this plan.

Typestring

Name


DescriptionThe name by which the member knows this plan.

1109


DetailsField Name

Typetextarea

Notes


DescriptionNotes about this member plan.

Typereference

OwnerId



Typereference

PayerId



Typereference

PlanId


DescriptionLookup of the Purchaser Plan ID.

Typestring

PrimaryCarePhysician


DescriptionThe name of the physician providing primary care under this plan.

Typepicklist

PrimarySecondaryTertiary


DescriptionWhether this plan is the primary, secondary, or tertiary plan.

1110


DetailsField Name

Typepicklist

RelationshipToSubscriber


DescriptionThe relationship of this member to the plan’s subscriber. Valid options are:

• Self

• Spouse

• Child

• Unknown

• Other Relationship

Typestring

SourceSystem



Typestring




TypedateTime




Typepicklist

Status



1111


DetailsField Name

Typereference

SubscriberId


DescriptionThe ID of the subscriber’s record.

Typepicklist

VerificationStatus


DescriptionThe status of the plan’s verification. Valid options are:

• Active - Verified

• Rejected

• Not Checked

• Unknown

• Inactive


MemberPlanFeedFeed tracking is available for the object.

MemberPlanHistoryHistory is available for tracked fields of the object.

MemberPlanOwnerSharingRuleSharing rules are available for the object.

MemberPlanShareSharing is available for the object.

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


1112


Fields

DetailsField Name

Typepicklist

Affiliation



Typedate

EffectiveFrom


DescriptionThe date from which this purchaser plan is effective.

Typedate

EffectiveTo


DescriptionThe date on which this purchaser plan ceases to be effective.

Typeboolean

IsVerifiable



Typeboolean

IsVerifiable



Typestring

Name


1113


DetailsField Name

DescriptionThe name of this plan.

Typetextarea

Notes


DescriptionNotes about this payer.

Typereference

Payer



Typestring

PlanNumber


DescriptionThe plan’s reference number.

Typepicklist

PlanStatus



Typepicklist

PlanType



• PPO

• HMO

• Medicare

• Medicaid

1114


DetailsField Name

• Workers Comp

Typestring

ServiceType


DescriptionThe description of the service type offered by this plan.

Typestring

SourceSystem



Typestring




TypedateTime





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.

1115


Identity Verification Data Model

EDITIONS



The Identity Verification data model is used in configuring the process to verify the identity of acaller before their requests are processed by a call center agent.

IdentityVerificationProcDef

Represents the definition of the identity verification process. Available in API version 54.0 andlater.

IdentityVerificationProcDtl

Used to configure the search function as well as the minimum number of verifiers for the identityverification process. Available in API version 54.0 and later.

IdentityVerificationProcFld

Used to configure the questions or criteria for verifying the identity of a caller. Available in API version 54.0 and later.

IdentityVerificationProcDefRepresents the definition of the identity verification process. Available in API version 54.0 and later.


Special Access RulesThe Health Cloud permission set license is required to use this object.

Fields

DetailsField

Typestring

DeveloperName


DescriptionThe developer name of a record.

Typepicklist

Language


DescriptionThe languages in which translation of record labels is supported.


• da—Danish

1116

Identity Verification Data ModelHealth Cloud Developer Guide

DetailsField

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typestring

MasterLabel


DescriptionThe label of the Identity Verification Process Definition record.

Typestring

NamespacePrefix


DescriptionThe namespace prefix associated with this object. Each Developer Edition organization thatcreates a managed package has a unique namespace prefix. Limit: 15 characters. You canrefer 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 organizations, the namespace prefix is set to the namespace prefixof the organization for all objects that support it. There’s an exception if an object is inan installed managed package. In that case, the object has the namespace prefix of theinstalled managed package. This field’s value is the namespace prefix of the DeveloperEdition organization of the package developer.

1117


DetailsField

• In organizations that aren’t Developer Edition organizations, NamespacePrefix is onlyset for objects that are part of an installed managed package. There’s no namespaceprefix for all other objects.

Typepicklist

SearchLayoutType


DescriptionThe display layout of the search component.


• Stack

• Tab

Note: As of API version 54.0, Tab isn't supported.

UsageThis object is referenced in the Verify Caller Identity flow.

IdentityVerificationProcDtlUsed to configure the search function as well as the minimum number of verifiers for the identity verification process. Available in APIversion 54.0 and later.



Fields

DetailsField

Typereference

ApexClassId


DescriptionThe ID of the Apex class.

1118


DetailsField


Note: As of API version 54.0, this isn't supported.

Relationship NameApexClass


Refers ToApexClass

Typepicklist

DataSourceType


DescriptionThe source type of the data.


• External

Note: As of API version 54.0, an external data source isn’t supported.

• Salesforce

Typestring

DeveloperName



Typereference

IdentityVerificationProcDefId


DescriptionThe label of the relevant Identity Verification Process Definition record.


Relationship NameIdentityVerificationProcDef


1119


DetailsField

Refers ToIdentityVerificationProcDef

Typeboolean

IsActive




Typepicklist

Language




• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typestring

MasterLabel

1120


DetailsField


DescriptionThe label of the Identity Verification Process Detail record.

Typestring

NamespacePrefix






Typestring

ObjectName


DescriptionThe name of the object on which the search is performed and data is verified.

Typeint

OptionalVerifiersMinVerfCount


DescriptionThe minimum number of optional verifiers that must be checked.

Typestring

SearchFilter


1121


DetailsField

DescriptionConditions to filter the search results.

For example, if you want to perform the search only on Person Account records, enterisPersonAccount = true.

Typestring

SearchRecordUniqueIdField


DescriptionThe field storing the unique identifier of records displayed in the search results.

Typestring

SearchResultSortBy


DescriptionThe values that are used to sort the search results.

For example, if you want to sort the results by policy date, enter PolicyDate__c Desc.

Typeint

SearchSequenceNumber


DescriptionThe sequence in which the search is performed and the search result is displayed.

Note: As of API version 54.0, this isn't supported.

Typepicklist

SearchType


DescriptionThe type of search being performed.


• Object-Based

Note: As of API version 54.0, object-based search isn’t supported.

• Text-Based

1122


IdentityVerificationProcFldUsed to configure the questions or criteria for verifying the identity of a caller. Available in API version 54.0 and later.



Fields

DetailsField

Typestring

CustomFieldLabel


DescriptionThe custom label for the field that contains the verification data.

Note: As of API version 54.0, translation of custom field labels isn't supported.

Typepicklist

DataSourceType


DescriptionThe source type of the data.


• External

Note: As of API version 54.0, an external data source isn’t supported.

• Salesforce

Typestring

DeveloperName



1123


DetailsField

Typestring

FieldName


DescriptionThe label of the field that contains the verification data based on the selected field type.

Typepicklist

FieldType


DescriptionIndicates the type of field.


• additionalResultField—To fetch data as part of the search query, but thedata isn’t displayed in search results. Suppose you want to fetch the policy number andthe age of the policy owner as a result of the search but the agent isn’t supposed to seethis data. You can write custom logic to process this additional data.

• optionalVerifier—Optional Verifier

• requiredVerifier—Required Verifier

• resultField—To display in search results. For example, when an agent searchesfor a caller, you’d like the search results to include the account name, phone number,and email ID.

• searchField—To perform object-based search.

Note: Object-based search isn't supported as of API version 54.0.

Typestring

FieldValueFormula


DescriptionStores the formula that's applied to the field value.

Note: As of API version 54.0, this isn’t supported.

Typereference

IdentityVerificationProcDtlId


1124


DetailsField

DescriptionThe label of the relevant Identity Verification Process Detail record.


Relationship NameIdentityVerificationProcDtl


Refers ToIdentityVerificationProcDtl

Typeboolean

IsActive




Typepicklist

Language




• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

1125


DetailsField

• sv—Swedish

• th—Thai



Typestring

MasterLabel


DescriptionThe label of the Identity Verification Process Field record.

Typestring

NamespacePrefix






Typeint

SequenceNumber


DescriptionThe sequence number of the field.

TimelineObjectDefinitionStores timeline configurations. This object is available in API version 55.0 and later.

1126

TimelineObjectDefinitionHealth Cloud Developer Guide


Special Access RulesThe Health Cloud license is required to use this object.

Fields

DetailsField

Typepicklist

BaseObject


DescriptionThe object on which a timeline is based. Information displayed in a timeline comes fromobjects that are related to the base object. The base object can be any Salesforce object,standard or custom.


• AEJobTracker

• AIApplication

• AIApplicationConfig

• AIDataDefinition

• AIError

• AIFactorComponent

• AIFilter

• AIFilterGroup

• AIFilterValue

• AIInsightAction

• AIInsightFeedback

• AIInsightReason

• AIInsightReasonMLModelFactor

• AIInsightSource

• AIInsightValue

• AIManagedField

• AIMetric

• AIModel

• AIModelDefinition

• AIModelFactor

• AIModelGraph

1127


DetailsField

• AIModelMetric

• AIPredictionDefinition

• AIPredictionEvent

• AIPredictionExpression

• AIPredictionField

• AIPredictionTarget

• AIRecordInsight

• AIState

• AQTWorkloadMetadata

• ASEMobileConfigUser

• AacObjectSetting

• AcceptedEventRelation

• AcceptedRecommendation

• AccessControlPolicy

• Account

• AccountBrand

• AccountContactRelation

• AccountContactRole

• AccountForecastFormula

• AccountForecastSettings

• AccountPartner

• AccountRecordUserAccess

• Accreditation

• AcctMgrTargetSettings

• ActionApex

• ActionAssignEscalate

• ActionAssignTeam

• ActionCadenceAsyncJob

• ActionChatterPost

• ActionChatterPostRecipient

• ActionEmail

• ActionEmailRecipient

• ActionFieldUpdate

• ActionFlow

• ActionFlowParam

• ActionKnowledgeSubmit

• ActionLink

• ActionLinkGroup

1128


DetailsField

• ActionLinkGroupAssoc

• ActionLinkGroupTemplate

• ActionLinkTemplate

• ActionLinkTemplateBinding

• ActionLinkUserState

• ActionOutboundMessage

• ActionOverride

• ActionOverrideInfo

• ActionPlan

• ActionPlanItem

• ActionPlanItemDependency

• ActionPlanTemplate

• ActionPlanTemplateItem

• ActionPlanTemplateItemValue

• ActionPlanTemplateVersion

• ActionPlanTmplItmAssessmentInd

• ActionPlanTmplPkgConfig

• ActionPlnTmplItmDependency

• ActionQuickCreate

• ActionResponse

• ActionSend

• ActionTask

• ActionVisibility

• ActiveFeatureLicenseMetric

• ActivePermSetLicenseMetric

• ActiveProfileMetric

• Activity

• ActivityEngagementRollup

• ActivityHistory

• ActivityRecurrence2

• ActivityRecurrence2Exception

• ActivityRelation

• ActivityTiming

• AdditionalNumber

• Address

• AddressCountry

• AddressState

• AgentWork

1129


DetailsField

• AggregateResult

• AiExternalModelReference

• AllInstalledPackageVersion

• AllManagedClassRelationship

• AllManagedMemberOption

• AllManagedPackageMember

• AllOrganization

• AllOrganizationValue

• AllPackage

• AllPackageVersion

• AllPackageVersionLm

• AllUsersBasic


• AnalysisConfiguration

• AnalysisInsight

• AnalysisSetup

• AnalysisSetupFile

• AnalysisSetupStatusEvent

• AnalyticAction

• AnalyticActionConfiguration

• AnalyticCondition

• AnalyticDataAlert

• AnalyticNotification

• AnalyticNotificationTracker

• AnalyticQueryCaptureEvent

• AnalyticRecordUserAccess

• AnalyticThreshold

• AnalyticsBackupBucket

• AnalyticsBackupFile

• AnalyticsBackupFilePart

• AnalyticsBackupUploadJob

• AnalyticsLicensedAsset

• AndroidPushApplicationSetup

• AnimationRule

• Announcement

• ApexClass

• ApexClassIdentifier

• ApexClassIdentifierRelationship

1130


DetailsField

• ApexClassMember

• ApexCodeCoverage

• ApexCodeCoverageAggregate

• ApexComponent

• ApexComponentAttribute

• ApexComponentMember

• ApexDebuggerBreakpoint

• ApexDebuggerEvent

• ApexDebuggerRequest

• ApexDebuggerSession

• ApexEmailNotification

• ApexExecutionOverlayAction

• ApexExecutionOverlayResult

• ApexHammerOrgResult

• ApexHammerResult

• ApexLog

• ApexMetaAnnotation

• ApexOrgWideCoverage

• ApexPackage

• ApexPackageIdentifier

• ApexPage

• ApexPageInfo

• ApexPageMember

• ApexTestQueueItem

• ApexTestResult

• ApexTestResultLimits

• ApexTestRunResult

• ApexTestSuite

• ApexTrigger

• ApexTriggerMember

• ApexTypeImplementor

• ApiCapture

• ApiTask

• ApiTaskResult

• ApiUsage

• AppAnalyticsQueryRequest

• AppBrand

• AppClone

1131


DetailsField

• AppCloneAccount

• AppCloneActionTrigger

• AppCloneAndroidPush

• AppCloneApp

• AppCloneAppAccount

• AppCloneAsset

• AppCloneAuthorizedDomain

• AppCloneCodeSigning

• AppCloneDeepLink

• AppCloneDelegateAccount

• AppCloneIosPush

• AppCloneLocalizedAndroidAsset

• AppCloneLocalizedIosAsset

• AppCloneMarketingCloud

• AppCloneMediaAsset

• AppCloneMetadata

• AppClonePrivateAccount

• AppCloneSupportedRegion

• AppCloneTester

• AppDefinition

• AppIpRange

• AppManifest

• AppManifestVersion

• AppMenuItem

• AppNotifTypeOrgSetting

• AppNotifTypeUserSetting

• AppNotificationType

• AppTabMember

• AppleAppIdConfig

• AppleDomainVerification

• AppleEcKey

• ApplePushApplicationSetup

• Application

• ApplicationCase

• ApplicationDependency

• ApplicationRecordTypeConfig

• AppointmentAssignmentPolicy

• AppointmentReason

1132


DetailsField

• AppointmentScheduleAggr

• AppointmentScheduleLog

• AppointmentSchedulingPolicy

• AppointmentTopicTimeSlot

• ApptBookingConfig

• ApptBookingUrlConfig

• AqtImportRequest

• AqtImportRequestIndex

• ArticleMapInfo

• AssessmentIndicatorDefinition

• AssessmentTask

• AssessmentTaskContentDocument

• AssessmentTaskDefinition

• AssessmentTaskIndDefinition

• AssessmentTaskOrder

• Asset

• AssetRelationship

• AssetTokenEvent

• AssignedResource

• AssignmentDelta

• AssignmentRule

• AssistantInteraction

• AssistantProgress

• AssistantRecommendation

• AssistantRecommendationType

• AssistantStepProgress

• AssociatedLocation

• AssociationQueueItem

• AsyncApexJob

• AsyncApiBatch

• AsyncApiBatchOptions

• AsyncApiChunkResults

• AsyncApiJob

• AsyncApiJobOptions

• AsyncApiQueryResult

• AsyncApiTransformationSpec

• AsyncOperationEvent

• AsyncOperationStatus

1133


DetailsField

• AsyncRequest

• AsyncRequestFFX

• AsyncRequestFFXResult

• AttachedContentDocument

• Attachment

• Audience

• AudienceCriteria

• AudienceCustomFormula

• AudienceMembership

• AudiencePermissionCriteria

• AuraDefinition

• AuraDefinitionBundle

• AuraDefinitionBundleInfo

• AuraDefinitionChange

• AuraDefinitionInfo

• AuraResource

• AuthConfig

• AuthConfigProviders

• AuthFormRequestRecord

• AuthProvider

• AuthSecurityLevel

• AuthSession

• AuthorNote

• AuthorizationForm

• AuthorizationFormConsent

• AuthorizationFormDataUse

• AuthorizationFormText

• AutoResponseRule

• AvroSchema

• Award

• BackgroundOperation

• BadgeMissionDefinition

• BadgeMissionRule

• BatchApexErrorEvent

• BatchApexRelationship

• BigObjectCounter

• BlackTabAuditLog

• BlacklistedConsumer

1134


DetailsField

• BoardCertification

• BrandTemplate

• BrandingSet

• BrandingSetProperty

• BrandingValue

• BundledCareFeeAgreement

• BusProcessFeedbackConfig

• BusinessBrand

• BusinessHours

• BusinessLicense

• BusinessMilestone

• BusinessProcess

• BusinessProcessPicklist

• CMSConnectAsset

• CMSConnectLanguage

• CMSConnectPersonalization

• CMSConnectResourceDefinition

• CMSConnectResourceType

• CMSConnectSource

• Calendar

• CalendarModel

• CalendarShare

• CalendarSharing

• CalendarView

• CallCenter

• CallCoachingMediaProvider

• Campaign

• CampaignInfluence

• CampaignInfluenceAdjustment

• CampaignInfluenceModel

• CampaignMember

• CampaignMemberStatus

• Canvas

• CanvasFeedItem

• CapitationCareFeeAgreement

• CaptchaKey

• CareBarrier

• CareBarrierDeterminant

1135


DetailsField

• CareBarrierType

• CareBenefitVerifyRequest

• CareBenefitVerifySettings

• CareDeterminant

• CareDeterminantType

• CareDiagnosis

• CareFeeScheduleItem

• CareInterventionType

• CareLimitType

• CareMetricTarget

• CareObservation

• CareObservationComponent

• CarePerformer

• CarePgmProvHealthcareProvider

• CarePractnFacilityAppt

• CarePreauth

• CarePreauthItem

• CareProgram

• CareProgramCampaign

• CareProgramEligibilityRule

• CareProgramEnrollee

• CareProgramEnrolleeProduct

• CareProgramEnrollmentCard

• CareProgramGoal

• CareProgramProduct

• CareProgramProvider

• CareProgramTeamMember

• CareProviderAdverseAction

• CareProviderFacilitySpecialty

• CareProviderSearchConfig

• CareProviderSearchableField


• CareRequest

• CareRequestConfiguration

• CareRequestDrug

• CareRequestExtension

• CareRequestItem

• CareRequestReviewer

1136


DetailsField

• CareSpecialty

• CareSpecialtyTaxonomy

• CareSystemFieldMapping

• CareTaxonomy

• Case

• CaseContactRole

• CaseEscalation

• CaseHistory2

• CaseRelatedIssue

• CaseSolution

• CaseStatus

• CaseSubjectParticle

• CategorizedCareFeeAgreement

• CategoryAccess

• CategoryData

• CategoryJobTask

• CategoryNode

• CciTable

• CciTableField

• CdnDomain

• Certificate

• CertificateIp

• ChangeRequest

• ChangeRequestRelatedIssue

• ChangeRequestRelatedItem

• ChangeSetDeployHistory

• ChangeSetDeployMessage

• ChangeSetUploadHistory

• ChatterActivity

• ChatterActivityDailyMetrics

• ChatterConversation

• ChatterConversationMember

• ChatterExtension

• ChatterExtensionConfig

• ChatterExtensionInstance

• ChatterMessage

• ChatterMessageThread

• ChatterServiceSiteSetting

1137


DetailsField

• ChatterUniqueContributorDailyMetrics

• ChunkableEntityChunk

• ChunkableEntityChunk2

• ChunkableEntityTally

• ChunkableEntityTally2

• ChunkableTask

• ChunkableTask2

• CleanActivityLog

• CleanDataService

• CleanEntityError

• CleanInfo

• CleanRule

• ClientBrowser

• ClinicalAlert

• ClinicalDetectedIssue

• ClinicalDetectedIssueDetail


• ClinicalEncounterDiagnosis

• ClinicalEncounterFacility

• ClinicalEncounterIdentifier

• ClinicalEncounterProvider

• ClinicalEncounterReason

• ClinicalEncounterSvcRequest


• ClinicalServiceRequestDetail

• CodeSet

• CodeSetBundle

• CollabDocumentMetric

• CollabDocumentMetricRecord

• CollabTemplateMetric

• CollabTemplateMetricRecord

• CollabUserEngagementMetric

• CollabUserEngmtRecordLink

• CollaborationGroup

• CollaborationGroupMember

• CollaborationGroupMemberRequest

• CollaborationGroupRank

• CollaborationGroupRecord

1138


DetailsField

• CollaborationInvitation

• ColorDefinition

• CombinedAttachment

• CommChannelLayout

• CommChannelLayoutItem

• CommChannelLayoutMapping

• CommSubscription

• CommSubscriptionChannelType

• CommSubscriptionConsent

• CommSubscriptionTiming

• CommerceSearchDocChangelist

• CommerceSearchIndexInfo

• CommerceSearchIndexLog

• CommerceSearchIndexPayload

• Community

• CommunityCustomThemeLayoutType

• CommunityIqCtrMetric

• CommunityTemplateBundleInfo

• CommunityTemplateDefinition

• CommunityTemplatePageSetting

• CommunityThemeDefinition

• CommunityThemeRouteOverride

• CommunityThemeSetting

• CommunityWorkspacesNode

• CompactLayout

• CompactLayoutInfo

• CompactLayoutItem

• CompactLayoutItemInfo

• CompactLayoutMapping

• ComponentAppVersion

• ComponentFeatureDependency

• ComponentInstance

• ComponentInstanceProperty

• ComponentInstancePropertyListItem

• ComponentObjectDependency

• ComponentResourceLink

• ComponentResponseCache

• ComputedComponentMetadata

1139


DetailsField

• ConferenceNumber

• ConnectedAppOauthPolicy

• ConnectedAppPlugin

• ConnectedAppSessionPolicy

• ConnectedApplication

• ConnectedApplication2

• ConnectivityAttributes

• ConnectivityDevConfig

• ConsolePersonalization

• ConsoleSidebarContainer

• ConsolidatedCustomIndex

• Contact

• ContactEncounter

• ContactEncounterParticipant

• ContactPointAddress

• ContactPointConsent

• ContactPointEmail

• ContactPointEntityAssocSnapshotLocator

• ContactPointPhone

• ContactPointTypeConsent

• ContactRequest

• ContainerAsyncRequest

• ContentAsset

• ContentBody

• ContentBuilderChannel

• ContentDispositionAssignment

• ContentDistribution

• ContentDistributionView

• ContentDlvrNtwkUsageMetric

• ContentDocument

• ContentDocumentLink

• ContentDocumentListViewMapping

• ContentDocumentSubscription

• ContentExternalStorage

• ContentFolder

• ContentFolderDistribution

• ContentFolderItem

• ContentFolderLink

1140


DetailsField

• ContentFolderMember

• ContentHubItem

• ContentHubRepository

• ContentNote

• ContentNotification

• ContentNotificationParam

• ContentReference

• ContentRenditionPolicy

• ContentTagName

• ContentTagSubscription

• ContentUserSubscription

• ContentVersion

• ContentVersionComment

• ContentVersionMap

• ContentVersionRating

• ContentVersionRenditionContent

• ContentVersionTagName

• ContentVersioningPolicy

• ContentWorkspace

• ContentWorkspaceAllowedRecType

• ContentWorkspaceDoc

• ContentWorkspaceMember

• ContentWorkspacePermission

• ContentWorkspaceRecentEvent

• ContentWorkspaceSubscription

• ContextFieldAttributes

• Contract

• ContractContactRole

• ContractPaymentAgreement

• ContractStatus

• ConvCoachingRecommendation

• CopyEntityTally

• CopyEntityTally2

• CopyExport

• CopyExportChunk

• CopyExportChunk2

• CopyExportObserverInfo

• CopyImport

1141


DetailsField

• CopyImportChunk

• CopyImportChunk2

• CopySuspension

• CorsWhitelistEntry

• CoverageBenefit

• CoverageBenefitItem

• CoverageBenefitItemLimit

• CronJobDetail

• CronTrigger

• CrossOrgLimitUsageHistory

• CrossOrgSite

• CrtColumn

• CrtLayoutSection

• CrtObject

• CsnDomain

• CspTrustedSite

• CustIdxCandidate

• CustIdxCandidateInfo

• CustomBrand

• CustomBrandAsset

• CustomConsoleComponent

• CustomEntityDefinition

• CustomEntityTranslation

• CustomFieldDataColumn

• CustomFieldDefinition

• CustomFieldMap

• CustomFieldMember

• CustomHelpMenuItem

• CustomHelpMenuSection

• CustomHttpHeader

• CustomIndex

• CustomIndexCreator

• CustomIndexDefinition

• CustomIndexFieldDefinition

• CustomIndexInfo

• CustomIndexUsage

• CustomNotificationType

• CustomObjectUserLicenseMetrics

1142


DetailsField

• CustomPage

• CustomPageItem

• CustomPageProfile

• CustomPermission

• CustomPermissionDependency

• CustomPermissionSet

• CustomReportType

• CustomSetup

• CustomSetupDefinition

• CustomShareRowCause

• CustomTabDefinition

• Customer

• DBCThumbnail

• DBCThumbnailFilter

• Dashboard

• DashboardCompColResult

• DashboardComponent

• DashboardComponentColumn

• DashboardComponentResult

• DashboardComponentSort

• DashboardDynamicValue

• DashboardFilter

• DashboardFilterItem

• DashboardFilterRepCol

• DashboardGridComponent

• DashboardGridLayout

• DashboardStickyFilter

• DataAssessmentBIMetrics

• DataAssessmentConfigItem

• DataAssessmentFieldMetric

• DataAssessmentMetric

• DataAssessmentRecord

• DataAssessmentValueMetric

• DataAssetSemanticGraphEdge

• DataAssetUsageTrackingInfo

• DataCategory

• DataCategoryGroup

• DataCategoryMapping

1143


DetailsField

• DataClassification

• DataIntegrationPurchasedRecord

• DataIntegrationRecordPurchasePermission

• DataObjectDataChgEvent

• DataStatistics

• DataType

• DataUseLegalBasis

• DataUsePurpose

• DatacloudAddress

• Dataflow

• DataflowInstance

• DataflowNode

• DataflowNotification

• DataflowRequest

• DataflowTrigger

• DataflowTriggerEvent

• DataflowTriggerSource

• DataflowVersion

• DatasetAccess

• DatasetFetch

• DatasetRegister

• DbLockUsage

• DebugLevel

• DeclinedEventRelation

• DeflectionSignal

• DelegateGroup

• DelegateGroupGrant

• DelegateGroupMember

• DelegatedAccount

• DeleteEvent

• DependentPicklist

• DeployDirection

• DeployMessage

• DeployRequest

• DeployTestResult

• DevelopmentPackageVersion


• DiagnosticSummaryDetail

1144


DetailsField

• DigitalSignature

• DirectGroupMember

• DirectMessage

• DirectMessageMember

• DirectMessageMemberActivity

• DiscoveryAIModel

• DiscoveryActionableVariable

• DiscoveryAnalysisSetupData

• DiscoveryDeployedModel

• DiscoveryFieldMap

• DiscoveryFilter

• DiscoveryFilterValue

• DiscoveryGoal

• DiscoveryMdlTfrmFrcstSetup

• DiscoveryModelCard

• DiscoveryModelField

• DiscoveryModelTransform

• DiscoveryPrescriptionText

• DiscoveryRecipient

• DiscoveryRefreshConfig

• DiscoveryRefreshJob

• DiscoveryRefreshTask

• DiscoveryScoringJob

• DiscoveryScoringJobItem

• Document

• DocumentAttachmentMap

• DocumentChecklistItem

• DocumentType

• Domain

• DomainProvision

• DomainSite

• DoradoRequest

• DoradoRequestEvent

• DrDbHammerRequest

• DrugDisplayTerm

• DuplicateErrorLog

• DuplicateRecordItem

• DuplicateRecordSet

1145


DetailsField

• DuplicateRule

• DuplicateRuleFilter

• DuplicateRuleFilterItem

• DuplicateRuleMatchRule

• EaasEvent

• EclairNgMap

• EclairNgMapGeoJson

• EmailBrand

• EmailCapture

• EmailConfigEntitySetting

• EmailDisclaimer

• EmailDomainFilter

• EmailDomainKey

• EmailMessage

• EmailMessageRelation

• EmailRelay

• EmailRoutingAddress

• EmailServicesAddress

• EmailServicesFunction

• EmailStatus

• EmailSyncAdvancedSetting

• EmailSyncConfig

• EmailSyncEntitySetting

• EmailSyncFieldMapping

• EmailSyncValueMapping

• EmailTemplate

• EmailUserEntitySetting

• EmbeddedServiceAppointmentSettings

• EmbeddedServiceBranding

• EmbeddedServiceConfig

• EmbeddedServiceConfigPub

• EmbeddedServiceCustomComponent

• EmbeddedServiceCustomLabel

• EmbeddedServiceCustomization

• EmbeddedServiceDetail

• EmbeddedServiceFieldService

• EmbeddedServiceFlow

• EmbeddedServiceFlowConfig

1146


DetailsField

• EmbeddedServiceLabel

• EmbeddedServiceLabelsPub

• EmbeddedServiceLayout

• EmbeddedServiceLayoutRule

• EmbeddedServiceMenuItem

• EmbeddedServiceMenuSettings

• EmbeddedServiceResource

• Endorsement

• EngagementChannelType

• EngagementEvent

• EnhancedLetterhead

• EnrollmentEligibilityCriteria

• EntityAssociationDefinitionVersion

• EntityAttributes

• EntityAudienceMapping

• EntityBlacklist

• EntityCategoryGroup

• EntityDataSize

• EntityDefinition

• EntityFeedLayout

• EntityHistory

• EntityImplements

• EntityLimit

• EntityLock

• EntityParticle

• EntitySharingModel

• EntitySubscription

• EscalationRule

• EtlJobMetrics

• Event

• EventAssociationItem

• EventAttendee

• EventBusSubscriber

• EventComments

• EventDelivery

• EventDeliveryData

• EventDestination

• EventLogFile

1147


DetailsField

• EventLogFileAnalyticJob

• EventParameter

• EventParameterData

• EventRecurrenceException

• EventRelation

• EventSubscription

• EventSubscriptionData

• EventSubscriptionHandleData

• EventType

• EventTypeDefinition

• EventTypeFieldDefinition

• EventTypeParameter

• EventWhoRelation

• ExchangeUserMapping

• ExecutionPlan

• ExecutionPlanTask

• ExperienceDiagnosticEvent

• Experiment

• ExpressionFilter

• ExpressionFilterCriteria

• ExpressionSetView

• ExtLearningUsrContentRtng

• ExternalActionParameter

• ExternalDataSource

• ExternalDataSrcDescriptor

• ExternalDataUserAuth

• ExternalEvent

• ExternalEventMapping

• ExternalServiceAction

• ExternalServiceListType

• ExternalServiceMapType

• ExternalServiceObjectType

• ExternalServiceOperation

• ExternalServiceParameter

• ExternalServiceProperty

• ExternalServiceRegistration

• ExternalServiceSimpleType

• ExternalServiceType

1148


DetailsField

• ExternalSocialAccount

• ExternalString

• ExternalizedReference

• FeatureLicense

• FeeScheduleDefinition

• FeedActionDefinition

• FeedActionState

• FeedAttachment

• FeedChannel

• FeedChannelSubscription

• FeedClumpInfo

• FeedClumpMapping

• FeedComment

• FeedCrossReference

• FeedEntityRead

• FeedEntityUnpublished

• FeedEntry

• FeedFavorite

• FeedFieldHistory

• FeedFilterCriterion

• FeedFilterDefinition

• FeedItem

• FeedLike

• FeedMapping

• FeedMute

• FeedPollChoice

• FeedPollVote

• FeedPost

• FeedPostTemplate

• FeedPostTemplateItem

• FeedRead

• FeedRecommendationInfo

• FeedRevision

• FeedSignal

• FeedTrackedChange

• FieldAttributes

• FieldBasedPAC

• FieldDefinition

1149


DetailsField

• FieldHistory

• FieldImplements

• FieldMapping

• FieldMappingField

• FieldMappingRow

• FieldPermissions

• FieldRestrictionRule

• FieldSecurityClassification

• FieldSet

• FieldSetItem

• FileFieldData

• FileInspectionResult

• FileSearchActivity

• FiscalYearSettings

• FlexQueueItem

• FlexiPage

• FlexiPageRegion

• FlexipageEventPropMapping

• FlexipageEventProperty

• FlexipageEventSource

• FlexipageEventTarget

• FlexipageFieldInstance

• FlexipageFieldInstanceProperty

• FlexipageInfo

• FlowApexClassDescriptor

• FlowApexClassPropertyDesc

• FlowCategory

• FlowCategoryItem

• FlowDefinition

• FlowDefinitionView

• FlowElementSubtype

• FlowElementTestCoverage

• FlowEnvironmentDefinition

• FlowExecutionErrorEvent

• FlowExecutionEvent

• FlowExecutionEventMetric

• FlowExtension

• FlowExtensionGenericType

1150


DetailsField

• FlowExtensionParam

• FlowExtensionProcessType

• FlowInterview

• FlowInterviewEvent

• FlowInterviewLog

• FlowInterviewLogEntry

• FlowOrchActionEvent

• FlowOrchestrationErrorEvent

• FlowOrchestrationEvent

• FlowOrchestrationEventBatch

• FlowOrchestrationEventStore

• FlowOrchestrationHistory

• FlowOrchestrationInstance

• FlowOrchestrationStageInstance

• FlowOrchestrationStepInstance

• FlowOrchestrationWorkItem

• FlowRecordRelation

• FlowResumeSubscriber

• FlowResumeValue

• FlowSaveTrigger

• FlowSharedResumeSubscriber

• FlowStageRelation

• FlowTest

• FlowTestAssertion

• FlowTestCondition

• FlowTestCoverage

• FlowTestOperand

• FlowTestParameters

• FlowTestPoint

• FlowTestResult

• FlowTestView

• FlowTriggerTypeDefinition

• FlowVariableView

• FlowVersionView

• Folder

• FolderClosure

• FolderedContentDocument

• Form

1151


DetailsField

• FormItem

• FormSection

• FormulaFunction

• FormulaFunctionAllowedType

• FormulaFunctionCategory

• FormulaOperator

• FormulaParticle

• FormulaVariable

• GatherStatsTaskInfo

• GenericRecordUserAccess

• GenericVisitTask

• GenericVisitTaskContext

• GeoLocationPAC

• GlobalDbKey

• GlobalOrganization

• GlobalVariable

• GlobalVariableType

• GnrcVstKeyPerformanceInd

• GnrcVstTaskContextRelation

• GrantedByLicense

• GridforceJob

• Group

• GroupBlowout

• GroupGroupTrans

• GroupMember

• GroupSubscription

• HadoopCounter

• HadoopJob

• HawkingTenantProvStatus

• HealthCareDiagnosis

• HealthCareProcedure

• HealthCondition

• HealthConditionDetail

• HealthScore

• HealthScoreActionLog


• HealthcareFacilityNetwork

• HealthcarePayerNetwork

1152


DetailsField



• HealthcareProviderNpi

• HealthcareProviderSpecialty

• HealthcareProviderTaxonomy

• HistoricalDataFilter

• HistoricalDataFilterItem

• HistoricalEntityConfig

• HistoricalFieldConfig

• HistoricalSelector

• HistoricalSelectorValue

• HistoricalStaging

• HistoricalTransactionPrefix

• Holiday

• IDEPerspective

• IDEWorkspace

• IPAddressRange

• Icon

• IconDefinition

• Idea

• IdeaReputationLevel

• Identifier

• IdentityDocument

• IdentityVerificationProcDef

• IdentityVerificationProcDtl

• IdentityVerificationProcFld

• IdpEventLog

• IframeWhiteListUrl

• Image

• ImportQueue

• InboundChangeSet

• InboundNetworkConnProperty

• InboundNetworkConnection

• InboundSocialPost

• Incident

• IncidentRelatedItem

• IncrementalCandidate

• IndexKeyDefinition

1153


DetailsField

• IndexKeyDefinitionItem

• Individual

• IndividualApplication

• IndustriesTriggerHandler

• IndustriesTriggersRegistry

• InfoAuthRequestForm

• InfoAuthorizationRequest

• InsightsApplication

• InstalledMobileApp

• InstalledPackageVersion

• InstalledSubscriberPackage

• InstalledSubscriberPackageVersion

• InstanceDirective

• InstancePerm

• InsurancePolicy

• IntentExecutionResult

• InteractionActionCall

• InteractionActionCallParam

• InteractionAllocation

• InteractionAllocator

• InteractionApexCall

• InteractionChoice

• InteractionChoiceLookup

• InteractionCollMapItem

• InteractionCollSortOption

• InteractionCollectionProc

• InteractionCondition

• InteractionConnector

• InteractionConstant

• InteractionCountReport

• InteractionDataColumn

• InteractionDataInput

• InteractionDataOutput

• InteractionDataSource

• InteractionDecision

• InteractionDefinitionVersion

• InteractionDynTypeMapping

• InteractionFieldValue

1154


DetailsField

• InteractionForm

• InteractionFormula

• InteractionLCMetrics

• InteractionLanguageMetrics

• InteractionLayoutDetail

• InteractionLayoutGroup

• InteractionLoop

• InteractionMetadataValue

• InteractionOperand

• InteractionQuestion

• InteractionRefOrValue

• InteractionReference

• InteractionResource

• InteractionRollback

• InteractionScheduledPath

• InteractionScreenFieldParam

• InteractionScreenRule

• InteractionScreenRuleAction

• InteractionStage

• InteractionStageItemParam

• InteractionStageStepAssignee

• InteractionStart

• InteractionStatement

• InteractionSteppedStage

• InteractionSteppedStageItem

• InteractionSwitch

• InteractionTodo

• InteractionTranslMetrics

• InteractionUsageMetrics

• InteractionValueList

• InteractionValueListEntry

• InteractionVariable

• InteractionVisibilityRule

• InteractionWait

• InteractionWaitEvent

• InteractionWaitEventParam

• InvocableAction

• InvocableActionGenericType

1155


DetailsField

• InvocableActionParameter

• InvocableActionPicklist

• IpWhitelist

• JiffyTrace

• JigsawSavedSearch

• JournalReason

• KanbanView

• Keyword

• KeywordList

• KnowledgeKeywordSearchHistory

• KnowledgeLanguageConfig

• KnowledgeSearchEventHistory

• KnowledgeViewEventHistory

• KnowledgeVoteEventHistory

• KnowledgeableUser

• LabelData

• LabelDefinition

• Layout

• LayoutDefinition

• LayoutItem

• LayoutItemActionRef

• LayoutItemColumn

• LayoutParticle

• LayoutRightPanel

• LayoutSection

• LayoutSectionState

• Lead

• LeadConvertMapping

• LeadConvertSettings

• LeadStatus

• LearningAssignment

• LearningAssignmentProgress

• LearningAward

• LearningContent

• LearningContentItem

• LearningContentItemProgress

• LearningContentProgress

• LearningEarnedAward

1156


DetailsField

• LearningItem

• LearningItemAssignment

• LearningItemProgress

• LearningLink

• LearningLinkProgress

• LearningRank

• LearningUserSummary

• Lens

• LicenseDefinition

• LicenseDefinitionCustomPermission

• LicenseManagementOrgCertificate

• LicensedCustomPermission

• LightningBolt

• LightningBoltFeature

• LightningBoltImage

• LightningBoltItem

• LightningComponentBundle

• LightningComponentResource

• LightningComponentTarget

• LightningExitByPageMetrics

• LightningExperienceTheme

• LightningMessageChannel

• LightningMessageField

• LightningOnboardingConfig

• LightningToggleMetrics

• LightningUsageByAppTypeMetrics

• LightningUsageByBrowserMetrics

• LightningUsageByFlexiPageMetrics

• LightningUsageByPageMetrics

• LimitSnapshot

• LimitUsageHistory

• LimitUsageTracker

• LimitsTracker

• LinkReference

• LinkedInLeadGen

• LinkedInLeadGenAdAccount

• LinkedInLeadGenConfig

• LinkedInLeadGenToken

1157


DetailsField

• ListColumn

• ListEmail

• ListEmailIndividualRecipient

• ListEmailRecipientSource

• ListEmailSentResult

• ListLayout

• ListLayoutItem

• ListPoolUsage

• ListView

• ListViewChart

• ListViewChartInstance

• ListViewCriterion

• ListViewDisplayColumn

• LmaApiSession

• LocalNamespace

• LocalizedValue

• Location

• LocationTrustMeasure

• LogLicenseUpdates

• LogSearch

• LogSearchResult

• LoginBrand

• LoginBrandAsset

• LoginFlow

• LoginGeo

• LoginHistory

• LoginHours

• LoginIp

• LoginIpEmail

• LoginIpRange

• LogoutEventStream

• LookedUpFromActivity

• LpuAccessMapping

• MLDataDefinition

• MLEngagementEvent

• MLField

• MLFilter

• MLFilterValue

1158


DetailsField

• MLMigration

• MLModel

• MLModelFactor

• MLModelFactorComponent

• MLModelMetric

• MLPipelineEvent

• MLPredictionDefinition

• MLRecommendationDefinition

• Macro

• MacroAction

• MacroInstruction

• MacroUsage

• MailAppExchangeUserMap

• MailAppExchangeWhitelist

• MailAppOwaWhitelist

• MailAppSettings

• MailAssociationItem

• MailmergeTemplate

• MalformedTemplateTracker

• ManagedContent

• ManagedContentBlock

• ManagedContentBlockVersion

• ManagedContentBody

• ManagedContentBodyLink

• ManagedContentChannel

• ManagedContentChannelStatus

• ManagedContentDelivery

• ManagedContentDeployment

• ManagedContentDeploymentItem

• ManagedContentExportJobItem

• ManagedContentFolderDefinition

• ManagedContentFolderLink

• ManagedContentFolderMember

• ManagedContentImportExportJob

• ManagedContentInfo

• ManagedContentLink

• ManagedContentLink2

• ManagedContentMigration

1159


DetailsField

• ManagedContentNode

• ManagedContentNodeRefTree

• ManagedContentNodeRendition

• ManagedContentNodeType

• ManagedContentPolicy

• ManagedContentQueryCriterion

• ManagedContentQueryDefinition

• ManagedContentRecordShare

• ManagedContentRelease

• ManagedContentReleaseItem

• ManagedContentResource

• ManagedContentSet

• ManagedContentSetLink

• ManagedContentSpace

• ManagedContentSpaceChannel

• ManagedContentSpaceContentType

• ManagedContentSpaceFolder

• ManagedContentSpaceFolderMember

• ManagedContentSpaceItem

• ManagedContentSpaceLanguage

• ManagedContentSpaceLink

• ManagedContentSpaceMember

• ManagedContentSpaceModule

• ManagedContentSpacePermission

• ManagedContentSpaceResource

• ManagedContentSpaceRole

• ManagedContentTranslationJob

• ManagedContentTranslationJobItem

• ManagedContentTranslationJobLanguage

• ManagedContentTranslationTask

• ManagedContentType

• ManagedContentTypeBody

• ManagedContentTypeInfo

• ManagedContentTypeSearchBlackList

• ManagedContentTypeVersion

• ManagedContentVariant

• ManagedContentVariantDelivery

• ManagedContentVariantRendition

1160


DetailsField

• ManagedContentVersion

• ManagedContentVersionLanguage

• ManagedTopicLocation

• MassMail

• MatchIndexDefinition

• MatchIndexValue

• MatchingInformation

• MatchingRule

• MatchingRuleItem

• MaterializedFeedEntry

• Medication

• MedicationDispense



• MedicationStatementDetail

• MedicinalIngredient

• MemberPlan

• MenuItem

• MessageIdentifier

• MetadataChangeTemplate

• MetadataComponentDependency

• MetadataContainer

• MetadataContent

• MetadataIdentifier

• MetadataPackage

• MetadataPackageVersion

• MetricsDataFile

• MicrobatchEvent

• MktProfileActionOverride

• MlAppMigrationStatus

• MlQueryObservation

• MobileApplicationDetail

• MobileConfig

• MobileHomeConfiguration

• MobileMarkedRecord

• MobilePushServiceDevice

• MobilePushSetupRegistry

• ModelMetricWriteEvent

1161


DetailsField

• ModerationRule

• ModerationRuleEntityTypeMapping

• ModerationRuleKeywordCriteriaMapping

• ModerationRuleUserCriteriaMapping

• Module

• ModuleDependency

• Mru

• MultipartyInfoAuthRequest

• MutingPermissionSet

• MyDomainDiscoverableLogin

• MyS1BrokerNotification

• Name

• NameUnion

• NamedCredential

• NamedFilter

• NavigationLinkSet

• NavigationMenuItem

• Network

• NetworkActiveMemberMetrics

• NetworkActivityAudit

• NetworkActivityDailyMetrics

• NetworkAffinity

• NetworkCustMemberMetrics

• NetworkCustomerDailyLoginMetrics

• NetworkCustomerLoginMetrics

• NetworkDashboardSetting

• NetworkDefaultBadgeSetting

• NetworkDiscoverableLogin

• NetworkFeedResponseMetric

• NetworkMember

• NetworkMemberChunk

• NetworkMemberGroup

• NetworkMembershipDailyMetrics

• NetworkModeration

• NetworkPCustDailyLoginMetrics

• NetworkPageOverride

• NetworkPartnerDailyLoginMetrics

• NetworkPartnerLoginMetrics

1162


DetailsField

• NetworkPartnerMemberMetrics

• NetworkPowerCustomerLoginMetrics

• NetworkPowerCustomerMemberMetrics

• NetworkPublicUsageDailyMetrics

• NetworkPulseActionsMapping

• NetworkPulseSetting

• NetworkRegularMemberMetrics

• NetworkSearchQueryFrequency

• NetworkSelfRegistration

• NetworkTenantUsageEntitlementWklyMetrics

• NetworkUniqueContributorDailyMetrics

• NetworkUserHistory

• NetworkUserHistoryRecent

• NetworkUserParticipationDailyMetrics

• NetworkWorkspaceMetricSetting

• NewsFeed

• Note

• NoteAndAttachment

• NotifDeliveryUserPref

• NotifTypeOrgSetting

• NotifTypeUserSetting

• NotificationMember

• OauthClientRegistration

• OauthConsumer

• OauthConsumerAsset

• OauthConsumerScope

• OauthCustomScope

• OauthCustomScopeApp

• OauthStagedCredential

• OauthToken

• OauthTokenLocal

• ObjectHierarchyRelationship

• ObjectMapping

• ObjectMappingField

• ObjectPermissions

• OcrDocumentScanResult

• OcrSampleDocument

• OcrSampleDocumentField

1163


DetailsField

• OcrSampleDocumentPage

• OcrTargetObjFieldMapping

• OcrTargetObject

• OcrTemplate

• OcrTemplateSampleDocument

• OcrUsageMetric

• OmniRoutingEventStore

• OmniSupervisorConfig

• OmniSupervisorConfigGroup

• OmniSupervisorConfigProfile

• OmniSupervisorConfigQueue

• OmniSupervisorConfigSkill

• OmniSupervisorConfigUser

• OnboardingMetrics

• OpenActivity

• OperatingHours

• OperatingHoursHoliday

• OperationLog

• Opportunity

• OpportunityAlert

• OpportunityCompetitor

• OpportunityContactRole

• OpportunityHistory

• OpportunityLineItem

• OpportunityPartner

• OpportunityStage

• OpportunityUpdateReminder

• OracleAwrSqlignore

• OracleAwrSqlstat

• OracleAwrSqltext

• Order

• OrderItem

• OrderItemType

• OrderStatus

• OrgDeleteRequest

• OrgDomainLog

• OrgEmailAddressSecurity

• OrgLifecycleNotification

1164


DetailsField

• OrgMetric

• OrgMetricBenchmark

• OrgMetricScanResult

• OrgMetricScanSummary

• OrgSigningKey

• OrgSizingDataHolder

• OrgSizingInfo

• OrgWideEmailAddress

• Organization

• OrganizationValue

• OrganizationValueInfo

• OutboundField

• OutboundMessage

• OutboundNetworkConnProperty

• OutboundNetworkConnection

• OutgoingEmail

• OutgoingEmailRelation

• OvenExperiment

• OverridableEntities

• OwnedContentDocument

• Owner

• OwnerChangeOptionInfo

• PacCrudPermission

• Package2Member

• Package2UpgradeExport

• PackageBooleanValue

• PackageConversion

• PackageDateValue

• PackageDependency

• PackageEvent

• PackageExtension

• PackageIdMapping

• PackageInstallRequest

• PackageIntegerValue

• PackageLicense

• PackageMember

• PackageOperationError

• PackageSupportAccess

1165


DetailsField

• PackageUploadRequest

• PackageVersionInstallRequestError

• PackageVersionPatchOrg

• PackageVersionUninstallRequestError

• PackagingHammerResult

• PageAssignment

• PageAssignmentCriteria

• PageComponent

• PageContentAssignment

• ParallelJobItemData

• ParallelJobStatus

• PartitionLevelMember

• PartitionLevelScheme

• PartitionStatus

• Partner

• PartnerNetworkForwardChild

• PartnerNetworkQueue

• PartnerNetworkSetup

• PartnerRole

• PartyConsent

• PathAssistant

• PathAssistantStepInfo

• PathAssistantStepItem

• PatientApiRecordLock

• PatientHealthReaction



• PatientMedicalProcedureDetail

• PatientMedicationDosage

• PendingServiceRouting

• PendingServiceRoutingInteractionInfo

• PercentileBsdCareFeeAgreement

• Period

• PermissionDependency

• PermissionSet

• PermissionSetAssignment

• PermissionSetGroup

• PermissionSetGroupComponent

1166


DetailsField

• PermissionSetLicense

• PermissionSetLicenseAssign

• PermissionSetLicenseDefinition

• PermissionSetTabSetting

• PersonEducation

• PersonEmployment

• PersonLanguage

• PersonLifeEvent

• PersonName

• Personalization

• PersonalizationActivity

• PersonalizationResource

• PersonalizationTargetInfo

• PersonalizationTargetSet

• PersonalizedUnswdQuestion

• Photo

• PhotoItem

• PicklistItemProperty

• PicklistMaster

• PicklistSet

• PicklistValueInfo

• PinPlan

• PinnedEntity

• PlanBenefit

• PlanBenefitItem

• PlatformAction

• PlatformActionList

• PlatformActionListItem

• PlatformCachePartition

• PlatformCachePartitionType

• PlatformCacheTrial

• PlatformEventChannel

• PlatformEventChannelMember

• PlatformEventEnrichmentField

• PlatformEventSubscriberConfig

• PlatformEventUsageMetric

• PlatformStatusAlertEvent

• PlinyPhysicalDeleteJob

1167


DetailsField

• Portal

• PortalAccount

• PortalDelegablePermissionSet

• PortalMember

• PortalStyleConfig

• PostArchivalDeletionRequest

• PredictiveModel

• PresenceConfigDeclineReason

• PresenceDeclineReason

• PresenceUserConfig

• PresenceUserConfigInfo

• PresenceUserConfigProfile

• PresenceUserConfigUser

• PreventiveCareAgreement

• Pricebook

• Pricebook2

• Pricebook2Old

• PricebookEntry

• PricebookShare

• PrivacyConsent

• PrivacyConsentRow

• PrmAppInstallationStatus

• Problem

• ProblemIncident

• ProblemRelatedItem

• ProcessActionItem

• ProcessAllowedSubmitter

• ProcessDefinition

• ProcessException

• ProcessExceptionEvent

• ProcessInstance

• ProcessInstanceHistory

• ProcessInstanceNode

• ProcessInstanceStep

• ProcessInstanceWorkitem

• ProcessMetrics

• ProcessNode

• ProcessNodeSecurity

1168


DetailsField

• ProcessPalette

• ProcessPlugin

• ProcessPluginParameter

• ProcessTimeQueue

• ProcessTransition

• ProcessTransitionAction

• ProcessTransitionApprover

• ProcessTransitionCondition

• ProcessTransitionSecurity

• ProcessTypeDefinition

• ProcessWorkitemProperties

• ProdDbHammerFlaggedRequest

• Product

• Product2

• ProductAvailabilityProjection

• ProductFulfillmentLocation

• ProductRequest

• ProductRequestLineItem

• Profile

• ProfileActionOverride

• ProfileClientSettings

• ProfileLayout

• ProfilePasswordPolicy

• ProfilePortalDelegate

• ProfileRecordType

• ProfileSessionSetting

• ProfileSkill

• ProfileSkillEndorsement

• ProfileSkillUser

• Project

• Prompt

• PromptAction

• PromptError

• PromptVersion

• ProposedEventResponse

• ProposedEventTime

• ProviderNetworkContract

• ProviderNetworkTier

1169


DetailsField

• ProviderSearchSyncLog

• PublicSolution

• Publisher

• PurchaserPlan

• PurchaserPlanAssn

• PushBackDefinition

• PushIntent

• PushProfileMapping

• PushTopic

• PushUpgradeExcludedOrg

• PushUpgradeJob

• PushUpgradeJobError

• PushUpgradeRequest

• QmosEntityDefinition

• QmosInColMap1

• QmosMatCol1

• QmosMatEntityMeta

• QmosQuery1

• QmosQueryCol1

• QmosQueryStatus

• QmosSelCol1

• QoptimizerLimitOverride

• QoptimizerOption

• QuerySet

• QuerySetItem

• Queue

• QueueMember

• QueueRoutingConfig

• QueueSobject

• QuickActionDefinition

• QuickActionList

• QuickActionListItem

• QuickText

• QuickTextUsage

• RateLimitIntBuckets

• RateLimitingNotification

• RawEmail

• ReadOnlyLoginIpEmail

1170


DetailsField

• RecalcCampaignStats

• ReceivedDocument

• RecentlyViewed

• RecipeFiscalConfiguration

• Recommendation

• RecommendationAudience

• RecommendationDefinition

• RecommendationMetric

• RecommendationReaction

• RecommendationResponse

• RecommendationStrategy

• RecommendationStrategyNode

• RecommendedSkinnyTable

• RecommendedSkinnyTableField

• RecordAction

• RecordActionDefaultItem

• RecordActionDeployment

• RecordActionDeploymentChannel

• RecordActionDeploymentContext

• RecordActionHistory

• RecordActionRecommendation

• RecordActionSelectableItem

• RecordMergeHistory

• RecordOrigin

• RecordSalt

• RecordType

• RecordTypePicklist

• RecordVisibility

• RecoveryCopyJob

• RecoveryFlashback

• RecurrenceSchedule

• RedirectWhitelistUrl

• RegionToServersMap

• RelatedEntity

• RelatedListColumnDefinition

• RelatedListDefinition

• RelationshipDomain

• RelationshipInfo

1171


DetailsField

• ReleaseUpdate

• ReleaseUpdateStep

• ReleaseUpdateStepLog

• RemoteProxy

• Renderer

• Report

• ReportAggregate

• ReportBlock

• ReportBlockAggregate

• ReportBreak

• ReportBucketField

• ReportBucketFieldSourceValue

• ReportBucketFieldValue

• ReportChart

• ReportColorRange

• ReportColumn

• ReportCustomDetailField

• ReportFilterItem

• ReportFormattingRule

• ReportFormattingRuleValue

• ReportInstance

• ReportInstanceCsvResult

• ReportInstanceQuery

• ReportJob

• ReportJobFieldMap

• ReportJobRun

• ReportJobRunError

• ReportObjectFilterItem

• ReportParam

• ReportResultBlob

• ReportRunTracker

• ReputationLevel

• ReputationPointsRule

• RequestThrottle

• RequestTrace

• RequestsForAccessSIQ

• ResourceAbsence

• ResourcePreference

1172


DetailsField

• RestrictionRule

• RichTextAreaFieldData

• RuleFilter

• RuleFilterAction

• RuleFilterItem

• S2XAdminError

• S2XContactMap

• S2XEventMap

• S2XEventRecordMap

• S2XEventTxnProps

• S2XExchOAuthCredential

• S2XGoogleServiceAccount

• S2XPushSubscription

• S2XRecordMap

• S2XSandmanError

• S2XServiceAccount

• S2XTransaction

• S2XTransactionLock

• S2XUserMap

• SCSInboundSettings

• SCSTermsOfService

• SPSamlAttributes

• SalesAgreementSettings

• SalesforceCustomerAccount

• SalesforceCustomerCase

• SalesforceCustomerContact

• SalesforceCustomerProduct

• SalesforceIqDataSource

• SalesforceIqOrgBlacklist

• SalesforceIqSyncFailure

• SalesforceIqUser

• SamlSsoConfig

• SampledEntity

• SamplingStrategy

• SandOmBulkExport

• SandOmExportedBlob

• SandOmImportInfo

• SandOmImportInfoDetail

1173


DetailsField

• SandOmInfo

• SandOmInfoDetail

• SandOmObserver

• Sandbox

• SandboxInfo

• SandboxObserver

• SandboxObserver2

• SandboxProcess

• SandboxRelayObserver

• SandstormAllowlist

• ScheduledRecommendation

• SchemaBuilderLayout

• SchemaBuilderLayoutItem

• Scontrol

• ScoreCategory

• ScoreCategoryCalcInsight

• ScoreRangeClassification

• Scorecard

• ScorecardAssociation

• ScorecardMetric

• ScrutinyPkChunkData

• ScrutinyRun

• SearchActivity

• SearchLayout

• SearchPromotionRule

• SearchQuerySuggestion

• SearchSchemaOverride

• SearchableField

• SecurityCustomBaseline

• SecurityHealthCheck

• SecurityHealthCheckRisks

• SegmentSpace

• SegmentSpaceChunk

• Seller

• SendEmailActionDefinition

• Service


• ServiceAppointmentStatus

1174


DetailsField

• ServiceChannel

• ServiceChannelStatus

• ServiceDataType

• ServiceDeskAttributes

• ServiceDeskComponent

• ServiceDeskCustomStyling

• ServiceDeskHotkey

• ServiceFieldDataType

• ServicePresenceStatus

• ServicePresenceStatusInfo

• ServiceProvider

• ServiceProviderEvent

• ServiceResource

• ServiceResourceSkill

• ServiceSetupProvisioning

• ServiceTerritory

• ServiceTerritoryMember

• ServiceTerritoryRelationship

• ServiceTerritoryWorkType

• ServiceVersion

• SessionLevelPolicy

• SessionPermSetActivation

• SettingsTemplate

• SetupApp

• SetupAssistantAnswer

• SetupAssistantProgress

• SetupAssistantStep

• SetupAuditTrail

• SetupEntityAccess

• SetupFlowProgress

• SetupNode

• SfdcAuditableAction

• SfdcAuditableActionResult

• SfdcAuditableExecTracker

• SfdcOutboundMessage

• SfdcPartner

• SharedPicklistDefinition

• SharedSavingPaymentAgreement

1175


DetailsField

• SharingOperation

• SharingSet

• Shift

• ShiftStatus

• SidebarComponentLayout

• SiqExchangeConnection

• SiqExchangeSetting

• SiqUserBlacklist

• Site

• SiteAsset

• SiteChangelist

• SiteChangelistComponent

• SiteComponent

• SiteDetail

• SiteDomain

• SiteIframeWhiteListUrl

• SiteMarketingDataExtensionMapping

• SitePageOverride

• SitePub

• SitePubAsset

• SitePubComponent

• SitePubDomain

• SitePubDomainSite

• SiteRedirectMapping

• SitemapContent

• Skill

• SkillRequirement

• SkinnyIndex

• SkinnyIndexColumn

• SkinnyTable

• SkinnyTableExt

• SkinnyTableField

• SlackApp

• SmartAnswerSlaMetric

• SocialPersona

• SocialPost

• SocialUserAuth

• SoftDeletedStat

1176


DetailsField

• SoftphoneLayout

• SoftphoneLayoutCallType

• SoftphoneLayoutInfoField

• SoftphoneLayoutItem

• SoftphoneLayoutSection

• SoftphoneScreenPopOption

• SoftwareProduct

• Solution

• SolutionStatus

• SourceObjectAttributes

• Split

• SplitAction

• SplitActionResult

• SplitFrameworkResult

• SplitMapping

• SplitOrganization

• SplitPod

• SqlInfoPfes

• Stamp

• StampAssignment

• StandardAction

• StandardCareFeeAgreement

• StandardReportType

• StandardValueSet

• StaticResource

• StrategyContext

• StrategyContextArgument

• StrategyExecutionEvent

• StrategyMonthlyStats

• StreamActivityAccess

• StreamEmail

• StreamEvent

• StreamingChannel

• Subinteraction

• SubinteractionVariableAssignment

• SubscriberPackage

• SubscriberPackageVersion

• SubscriberPackageVersionInstallRequest

1177


DetailsField

• SubscriberPackageVersionUninstallRequest

• SubscriberTabSetMember

• SummaryLayout

• SummaryLayoutItem

• SummaryLayoutSliceInfo

• Survey

• SurveyEmailBranding

• SurveyEngagementContext

• SurveyInvitation

• SurveyPage

• SurveyQuestion

• SurveyQuestionChoice

• SurveyQuestionResponse

• SurveyQuestionScore

• SurveyResponse

• SurveySubject

• SurveyVersion

• SurveyVersionAddlInfo

• SyncTransactionLog

• Synonym

• SynonymDictionary

• SynonymGroup

• SystemStreamingChannel

• TabDefinition

• TabSet

• TabSetMember

• Task

• TaskAssociationItem

• TaskGroup

• TaskPriority

• TaskRecurrenceException

• TaskRelation

• TaskStatus

• TaskWhoRelation

• TemplateDeployment

• TemplateDeploymentItem

• TenantAddOnLicense

• TenantEditionLicense

1178


DetailsField

• TenantLicensingRequest

• TenantPlatformLicense

• TenantSecret

• TenantSecurityLogin

• TenantSecurityMonitorMetric

• TenantSecurityTenantInfo

• TenantUsageEntitlement

• TenantUserLicense

• TestSuiteMembership

• ThirdPartyAccountLink

• ThirdPartyAccountLinkLocal

• TimeSlot

• TimelineObjectDefinition

• TodayGoal

• Tombstone

• Topic

• TopicAssignment

• TopicComputeStatus

• TopicDataCategoryRule

• TopicGroupActivity

• TopicIndex

• TopicNameChange

• TopicOntology

• TopicRecordSetting

• TopicSuggestionSetting

• TopicTerm

• TopicUserActivity

• TopicUserEvent

• TraceFlag

• Training

• Translation

• TranslationImportExportJob

• TranslationUser

• TrendIntervalLookup

• TrendingTopic

• TrialMaster

• TrialTemplate

• TrialTemplateVersion

1179


DetailsField

• TwoFactorAuthPairing

• TwoFactorInfo

• TwoFactorMethodsInfo

• TwoFactorMethodsInfoLocal

• TwoFactorTempCode

• TwoFactorU2F

• UIObjectRelationConfig

• UIObjectRelationFieldConfig

• UhsCategorySyncState

• UiFormulaCriterion

• UiFormulaRule

• UndecidedEventRelation

• UninstallExport

• UnitOfMeasure

• User

• UserActivityTimelineFilter

• UserAppInfo

• UserAppMenuCustomization

• UserAppMenuItem

• UserAssistantSummary

• UserComponentData

• UserCriteria

• UserCriteriaGroup

• UserCustomBadge

• UserEmailPreferredPerson

• UserEntityAccess

• UserFavorite

• UserFeedChannel

• UserFieldAccess

• UserLicense

• UserLicenseMetrics

• UserListPreference

• UserListPrefs

• UserListView

• UserListViewCriterion

• UserLogin

• UserMembershipSharingRule

• UserMetrics

1180


DetailsField

• UserNavItem

• UserPackageLicense

• UserPermissionAccess

• UserPreference

• UserProfile

• UserProfileFeed

• UserProfileSearchScope

• UserProfileSearchScopeItem

• UserProvAccount

• UserProvAccountStaging

• UserProvMockTarget

• UserProvisioningConfig

• UserProvisioningLog

• UserProvisioningRequest

• UserQuestionnaireAnswer

• UserQuestionnaireSummary

• UserRecSummary

• UserRecordAccess

• UserRole

• UserRoleGroupLockUsage

• UserRoleTrans

• UserServicePresence

• UserSetupAppInfo

• UserSetupEntityAccess

• UserVerificationMessageUse

• ValidationFormula

• ValidationRuleMember

• VerificationHistory

• VersionSet

• VideoCall

• VideoCallParticipant

• ViewDefinition

• VirtualVisitConfig

• VisibilityUpdateEvent

• Visit

• VisitedParty

• Visitor

• VisualforceAccessMetrics

1181


DetailsField

• VisualforceMetrics

• Vote

• VoteConfig

• VoteStats

• WaveAssetVersion

• WaveAutoInstallRequest

• WaveBaseDataset

• WaveBaseField

• WaveCompatibilityCheckItem

• WaveDataConnector

• WaveExternalConnProperty

• WaveReplicationFilterItem

• WaveSyncOut

• WebAppResource

• WebAppResourceDependency

• WebLink

• WebServiceDefinition

• WindowsPushApplicationSetup

• WorkAccess

• WorkBadge

• WorkBadgeDefinition

• WorkOrder

• WorkOrderLineItem

• WorkOrderLineItemStatus

• WorkOrderStatus

• WorkPlan

• WorkPlanTemplate

• WorkPlanTemplateEntry

• WorkStep

• WorkStepStatus

• WorkStepTemplate

• WorkThanks

• WorkType

• WorkTypeCareSpecialty

• WorkTypeCodeSetBundle

• WorkTypeGroup

• WorkTypeGroupMember

• WorkflowAlertMember

1182


DetailsField

• WorkflowFieldUpdateMember

• WorkflowOutboundMessageMember

• WorkflowRule

• WorkflowRuleMember

• WorkflowTaskMember

• WorkflowTimeAction

• WorkflowTimeQueue

• WorkflowTimeTrigger

• WqtRSktRequestMap

• WsdlDataType

• XCleanBulkJob

• XCleanMatchRateMetrics

• XmlSchema

• ZeroDataOrgTenant

Typetextarea

Definition


DescriptionThe timeline definition stored in JSON format.

Typestring

DeveloperName


DescriptionThe developer name of the timeline.

Typeboolean

IsActive


DescriptionIndicates whether the timeline is active or not.

The default value is false.

Typepicklist

Language

1183


DetailsField




• da—Danish

• de—German

• en_US—English

• es—Spanish


• fi—Finnish

• fr—French

• it—Italian

• ja—Japanese

• ko—Korean

• nl_NL—Dutch

• no—Norwegian


• ru—Russian

• sv—Swedish

• th—Thai



Typestring

MasterLabel


DescriptionThe label of the Timeline Object Definition record.

Typestring

NamespacePrefix



1184


DetailsField




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

• Moderate Chatter

Note: Users with the Moderate Chatter permission can delete only the feed items and comments they can see.

1185

Health Cloud Associated ObjectsHealth Cloud Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/system_fields.htm

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


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


DescriptionThe number of comments associated with this feed item.

Typereference

ConnectionId


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.

Typereference

InsertedById

PropertiesGroup, Nillable, Sort

1186

StandardObjectNameFeedHealth Cloud Developer Guide

DetailsField

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


DescriptionIndicates whether the feed item Body contains rich text. If you post a rich text feed commentusing SOAP API, set IsRichText to true and escape HTML entities from the body.Otherwise, the post is rendered as plain text.

Rich text supports the following HTML tags:

• 

Tip: Though the tag isn’t supported, you can use to create lines.

• <a>

• 

• <code>

• 

• 

• <s>

• <ul>

• <ol>

• <li>

• <img>

The <img> tag is accessible only through 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


DescriptionThe number of likes associated with this feed item.

1187

DetailsField

Typeurl

LinkUrl


DescriptionThe URL of a LinkPost.

Typepicklist

NetworkScope

PropertiesGroup, Nillable, Restricted picklist, Sort

DescriptionSpecifies whether this feed item is available in the default Experience Cloud site, a specificExperience Cloud site, or all sites. This field is available in API version 26.0 and later, if digitalexperiences is enabled for your org.

NetworkScope can have the following values:

• NetworkId—The ID of the Experience Cloud site in which the FeedItem is available.If left empty, the feed item is only available in the default Experience Cloud site.

• AllNetworks—The feed item is available in all Experience Cloud sites.

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


DescriptionID of the record that is tracked in the feed. The detail page for the record displays the feed.

Typereference

RelatedRecordId


DescriptionID of the ContentVersion record associated with a ContentPost. This field is null for allposts except ContentPost.

1188


DetailsField

Typestring

Title


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.

• 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.

1189


DetailsField

• 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


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.

• AccreditationFeed

• ApplicationCaseFeed

• AuthorNoteFeed

• BoardCertificationFeed

• BundledCareFeeAgreementFeed

1190


• CapitationCareFeeAgreementFeed

• CareBarrierDeterminantFeed

• CareBarrierFeed

• CareBarrierTypeFeed

• CareDeterminantFeed

• CareDeterminantTypeFeed

• CareDiagnosisFeed

• CareFeeScheduleItemFeed

• CareInterventionTypeFeed

• CareMetricTargetFeed

• CareObservationFeed

• CareObservationComponentFeed

• CarePerformerFeed

• CarePgmProvHealthcareProviderFeed

• CarePreauthFeed

• CarePreauthItemFeed

• CareProgramCampaignFeed

• CareProgramEligibilityRuleFeed

• CareProgramEnrolleeFeed

• CareProgramEnrolleeProductFeed

• CareProgramEnrollmentCardFeed

• CareProgramFeed

• CareProgramGoalFeed

• CareProgramProductFeed

• CareProgramProviderFeed

• CareProgramTeamMemberFeed

• CareProviderFacilitySpecialtyFeed

• CareRegisteredDeviceFeed

• CareRequestDrugFeed

• CareRequestExtensionFeed

• CareRequestFeed

• CareRequestItemFeed

• CareRequestReviewerFeed

• CareSpecialtyFeed

• CareSpecialtyTaxonomyFeed

• CareTaxonomyFeed

• CategorizedCareFeeAgreementFeed

• ClinicalAlertFeed

• ClinicalDetectedIssueFeed

• ClinicalDetectedIssueDetailFeed

1191


• ClinicalEncounterDiagnosisFeed

• ClinicalEncounterFacilityFeed

• ClinicalEncounterFeed

• ClinicalEncounterIdentifierFeed

• ClinicalEncounterProviderFeed

• ClinicalEncounterReasonFeed

• ClinicalEncounterSvcRequestFeed

• ClinicalServiceRequestDetailFeed

• ClinicalServiceRequestFeed

• ContractPaymentAgreementFeed

• CoverageBenefitFeed

• CoverageBenefitItemFeed

• DiagnosticSummaryFeed

• EnrollmentEligibilityCriteriaFeed

• FeeScheduleDefinitionFeed

• HealthcareFacilityFeed

• HealthcareFacilityNetworkFeed

• HealthcarePayerNetworkFeed

• HealthcarePractitionerFacilityFeed

• HealthcareProviderFeed

• HealthcareProviderNpiFeed

• HealthcareProviderSpecialtyFeed

• HealthcareProviderTaxonomyFeed

• MedicationDispenseFeed

• MedicationReconciliationFeed

• MedicationRequestFeed

• MedicationStatementDetailFeed

• MedicationStatementFeed

• MedReconRecommendationFeed

• MedReconStmtRecommendationFeed

• MemberPlanFeed

• PatientHealthReactionFeed

• PatientMedicalProcedureDetailFeed

• PercentileBsdCareFeeAgreementFeed

• PlanBenefitFeed

• PlanBenefitItemFeed

• PreventiveCareAgreementFeed

• ProviderNetworkContractFeed

• ProviderNetworkTierFeed

• PurchaserPlanAssnFeed

1192


• PurchaserPlanFeed

• SharedSavingPaymentAgreementFeed

• StandardCareFeeAgreementFeed

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


DescriptionID of the standard object.

Typepicklist

DataType


DescriptionData type of the field that was changed.

1193

StandardObjectNameHistoryHealth Cloud Developer Guide

DetailsField Name

Typepicklist

Field

PropertiesFilter, Group, Restricted picklist, Sort

DescriptionName of the field that was changed.

TypeanyType

NewValue


DescriptionNew value of the field that was changed.

TypeanyType

OldValue


DescriptionOld value of the field that was changed.


• AccreditationHistory

• ApplicationCaseHistory

• AuthorNoteHistory

• BoardCertificationHistory

• BundledCareFeeAgreementHistory

• CapitationCareFeeAgreementHistory

• CareBarrierDeterminantHistory

• CareBarrierHistory

• CareBarrierTypeHistory

• CareDeterminantHistory

• CareDeterminantTypeHistory

• CareDiagnosisHistory

• CareFeeScheduleItemHistory

• CareInterventionTypeHistory

• CareMetricTargetHistory

• CareObservationComponentHistory

1194


• CareObservationHistory

• CarePerformerHistory

• CarePgmProvHealthcareProviderHistory

• CarePreauthHistory

• CarePreauthItemHistory

• CareProgramCampaignHistory

• CareProgramEligibilityRuleHistory

• CareProgramEnrolleeHistory

• CareProgramEnrolleeProductHistory

• CareProgramEnrollmentCardHistory

• CareProgramGoalHistory

• CareProgramHistory

• CareProgramProductHistory

• CareProgramProviderHistory

• CareProgramTeamMemberHistory

• CareProviderFacilitySpecialtyHistory

• CareRegisteredDeviceHistory

• CareRequestDrugHistory

• CareRequestExtensionHistory

• CareRequestHistory

• CareRequestItemHistory

• CareRequestReviewerHistory

• CareSpecialtyHistory

• CareSpecialtyTaxonomyHistory

• CareTaxonomyHistory

• CategorizedCareFeeAgreementHistory

• ClinicalAlertHistory

• ClinicalDetectedIssueHistory

• ClinicalDetectedIssueDetailHistory

• ClinicalEncounterDiagnosisHistory

• ClinicalEncounterFacilityHistory

• ClinicalEncounterHistory

• ClinicalEncounterIdentifierHistory

• ClinicalEncounterProviderHistory

• ClinicalEncounterReasonHistory

• ClinicalEncounterSvcRequestHistory

• ClinicalServiceRequestDetailHistory

• ClinicalServiceRequestHistory

• ContractPaymentAgreementHistory

• CoverageBenefitHistory

1195


• CoverageBenefitItemHistory

• DiagnosticSummaryHistory

• EnrollmentEligibilityCriteriaHistory

• FeeScheduleDefinitionHistory

• HealthCareDiagnosisHistory

• HealthcareFacilityHistory

• HealthcareFacilityNetworkHistory

• HealthcarePayerNetworkHistory

• HealthcarePractitionerFacilityHistory

• HealthCareProcedureHistory

• HealthcareProviderHistory

• HealthcareProviderNpiHistory

• HealthcareProviderSpecialtyHistory

• HealthcareProviderTaxonomyHistory

• MedicationDispenseHistory

• MedicationReconciliationHistory

• MedicationRequestHistory

• MedicationStatementDetailHistory

• MedicationStatementHistory

• MedReconRecommendationHistory

• MedReconStmtRecommendationHistory

• MemberPlanHistory

• PatientHealthReactionHistory

• PatientMedicalProcedureDetailHistory

• PercentileBsdCareFeeAgreementHistory

• PlanBenefitHistory

• PlanBenefitItemHistory

• PreventiveCareAgreementHistory

• ProviderNetworkContract

• ProviderNetworkTier

• PurchaserPlanAssnHistory

• PurchaserPlanHistory

• SharedSavingPaymentAgreementHistory

• StandardCareFeeAgreementHistory

• VisitedPartyHistory

• VisitorHistory

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.

1196

StandardObjectNameOwnerSharingRuleHealth Cloud Developer Guide

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


DescriptionDetermines the level of access users have to records. Values are:

• Read (read only)

• Edit (read/write)

Typetextarea

Description


DescriptionDescription of the sharing rule. Maximum length is 1000 characters.

Typestring

DeveloperName


1197


https://developer.salesforce.com/docs/atlas.en-us.238.0.api_meta.meta/api_meta/meta_sharingrules.htm

DetailsField Name

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 slows down while Salesforce generates one foreach record.

Typereference

GroupId


DescriptionID of the source group. Records that are owned by users in the source grouptrigger the rule to give access.

Typestring

Name


DescriptionLabel of the sharing rule as it appears in the UI. Maximum length is 80 characters.

Typereference

UserOrGroupId


DescriptionID of the user or group that you are granting access to.


• AccreditationOwnerSharingRule

• BoardCertificationOwnerSharingRule

• CareBarrierDeterminantOwnerSharingRule

1198


• 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

StandardObjectNameShareStandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharingentry on the standard object.

1199

StandardObjectNameShareHealth Cloud Developer Guide

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.


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


DescriptionThe level of access allowed. Values are:

• All (owner)

• Edit (read/write)

• Read (read only)

Typereference

ParentId


DescriptionID of the parent record.

Typepicklist

RowCause

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

DescriptionReason that the sharing entry exists.

Typereference

UserOrGroupId

1200


DetailsField Name


DescriptionID of the user or group that has been given access to the object.


• AccreditationShare

• AuthorNoteShare

• BoardCertificationShare

• CareBarrierDeterminantShare

• CareBarrierShare

• CareBarrierTypeShare

• CareDeterminantShare

• CareDeterminantTypeShare

• CareInterventionTypeShare

• CareMetricTargetShare

• CarePreauthItemShare

• CarePreauthShare

• CareProgramEligibilityRuleShare

• CareProgramEnrolleeProductShare

• CareProgramEnrollmentCardShare

• CareProgramGoalShare

• CareProgramProductShare

• CareProgramProviderShare

• CareProgramShare

• CareProviderFacilitySpecialtyShare

• CareSpecialtyShare

• CareTaxonomyShare

• ClinicalAlertShare

• CoverageBenefitItemShare

• CoverageBenefitShare

• EnrollmentEligibilityCriteriaShare

• FeeScheduleDefinitionShare

• HealthCareDiagnosisShare

• HealthcareFacilityNetworkShare

• HealthcarePayerNetworkShare

1201


• HealthcarePractitionerFacilityShare

• 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.


Fields

DetailsField

Typereference

BestCommentId



Typetextarea

Body


DescriptionThe body of the post. Required when Type is TextPost. Optional when Type is ContentPostor LinkPost.

Typeint

CommentCount

1202

VisitedPartyFeedHealth Cloud Developer Guide

DetailsField



Typereference

InsertedById


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


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.


• 


• <a>

• 

• <code>

• 

• 

• <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

1203

DetailsField



Typeurl

LinkUrl



Typepicklist

NetworkScope










Typereference

ParentId



Typereference

RelatedRecordId

1204


DetailsField



Typestring

Title



Typepicklist

Type


Description


• ActivityEvent

• AdvancedTextPost—created when a user posts a group announcement and whena user shares a post.

• AnnouncementPost

• ApprovalPost

• AttachArticleEvent

• BasicTemplateFeedItem—Basic Template Post

• CallLogPost


• CaseCommentPost

• ChangeStatusPost

• ChatTranscriptPost

• CollaborationGroupCreated

• CollaborationGroupUnarchived

• ContentPost

• CreateRecordEvent

• DashboardComponentSnapshot

• EmailMessageEvent

• FacebookPost

1205


DetailsField

• LinkPost

• MilestoneEvent

• PollPost

• ProfileSkillPost

• QuestionPost

• ReplyPost


• SocialPost

• TextPost

• TrackedChange

• UserStatus

Typepicklist

Visibility












1206


VisitorFeedThis object represents the posts and feed-tracked changes of the Visitor object. This object is available in API version 49.0 and later.


Fields

DetailsField

Typereference

BestCommentId



Typetextarea

Body


DescriptionThe body of the post. Required when Type is TextPost. Optional when Type is ContentPostor LinkPost.

Typeint

CommentCount



Typereference

InsertedById


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

1207

VisitorFeedHealth Cloud Developer Guide

DetailsField


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.


• 


• <a>

• 

• <code>

• 

• 

• <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



Typeurl

LinkUrl



Typepicklist

NetworkScope

1208

DetailsField










Typereference

ParentId



Typereference

RelatedRecordId



Typestring

Title



1209


DetailsField

Typepicklist

Type


Description


• ActivityEvent

• AdvancedTextPost—created when a user posts a group announcement and whena user shares a post.

• AnnouncementPost

• ApprovalPost

• AttachArticleEvent

• BasicTemplateFeedItem—Basic Template Post

• CallLogPost


• CaseCommentPost

• ChangeStatusPost

• ChatTranscriptPost

• CollaborationGroupCreated

• CollaborationGroupUnarchived

• ContentPost

• CreateRecordEvent

• DashboardComponentSnapshot

• EmailMessageEvent

• FacebookPost

• LinkPost

• MilestoneEvent

• PollPost

• ProfileSkillPost

• QuestionPost

• ReplyPost


• SocialPost

• TextPost

• TrackedChange

• UserStatus

1210


DetailsField

Typepicklist

Visibility












Health Cloud Fields on Standard Objects

Health Cloud adds standard and custom fields to some standard Salesforce objects to represent information about individuals.

Health Cloud Fields on Account

Standard and custom fields extend the standard Account object for use in Health Cloud to represent information about an individual.

Health Cloud Fields on Contact

Standard and 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.

1211

Health Cloud Fields on Standard ObjectsHealth Cloud Developer Guide

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 referral management.

Health Cloud Fields on Service Appointment

Standard and custom fields extend the standard Service Appointment object for use in Health Cloud to represent information abouta healthcare appointment.

Health Cloud Fields on AccountStandard and custom fields extend the standard Account object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typereference

CarePlan__c


DescriptionRefers to Case object. This field is the lookup to the care plan.

TypedateTime

EffectiveDate


DescriptionThe date from when the person account is active.

TypedateTime

EndDate


DescriptionThe date from when the person account is no longer active.

Typestring

IndividualId__c

1212

Health Cloud Fields on AccountHealth Cloud Developer Guide

DetailsField


DescriptionIdentifier for the individual.

Typepicklist

IndividualType__c


DescriptionIdentifier for the individual, such as group or individual.

Typeboolean

IsActive


DescriptionIndicates whether the person account for the individual is active.


Typestring




Typereference

PrimaryContact__c

PropertiesCreate, Filter, Group, Nillable, Sort

DescriptionRefers to Contact object.

Typestring

SourceSystemId__c

PropertiesCreate, Filter, Group, idLookup, NillableSort


1213

Health Cloud Fields on AccountHealth Cloud Developer Guide

DetailsField

Typestring




TypedateTime

SourceSystemModifiedDate



Health Cloud Fields on ContactStandard and custom fields extend the standard Contact object for use in Health Cloud to represent information about an individual.

Fields

DetailsField

Typestring

Age__c


DescriptionAge. Calculated from Contact.Birthdate.

Typestring

BirthDate__c


DescriptionDate of birth.

Typepicklist

CountryOfBirth__c


1214

Health Cloud Fields on ContactHealth Cloud Developer Guide

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

1215


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

1216


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

1217


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

1218


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

1219


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

1220


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


DescriptionIndicates whether the individual was created from a converted lead (true) or not (false).

TypedateTime

DeceasedDate


DescriptionThe date and time when the individual passed away.

Typepicklist

Gender


DescriptionThe individual’s gender. This is a standard field.


• Female

• Male

• Other

• Unknown

1221


DetailsField

Typepicklist

Gender__c


DescriptionThe individual’s gender. This is a custom field in the Health Cloud managed package. Validvalues:

• Female

• Male

• Decline to Specify

• Other

Typestring

IndividualId__c


DescriptionIdentifier for the individual.

Typepicklist

IndividualType__c


DescriptionType of individual. Valid values:

• Individual

Typepicklist

MaritalStatus


DescriptionThe individual’s marital status.


• Divorced

• Married

• Separated

• Single

• Widowed

1222


DetailsField

Typestring




Typestring

PreferredName__c


DescriptionIndividual’s preferred name.

Typepicklist

PrimaryLanguage__c


DescriptionIndividual’s primary language.

Valid values:

• Abkhaz

• Adyghe

• Afrikaans

• Akan

• Albanian

• American Sign Language

• Amharic

• Ancient Greek

• Arabic

• Aragonese

• Aramaic

• Armenian

• Aymara

• Balinese

• Basque

• Betawi

• Bosnian

• Breton

1223


DetailsField

• 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

• Hindi

• Hungarian

• Icelandic

• Indonesian

• Interlingua

• Inuktitut

• Irish

1224


DetailsField

• 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

• Pangasinan

• Papiamentu

• Pashto

• Persian

• Pitjantjatjara

• Polish

• Portuguese

1225


DetailsField

• 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

• Vilamovian

• Volapük

• Võrro

• Welsh

• Xhosa

• Yiddish

• Zazaki

1226


DetailsField

Typepicklist

SecondaryLanguage__c


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

• Coptic

• Cornish

• Corsican

• Crimean Tatar

• Croatian

• Czech

• Danish

1227


DetailsField

• 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

• Kashubian

• Khmer

• Kinyarwanda

• Korean

• Kurdish/Kurdî

• Ladin

• Latgalian

1228


DetailsField

• 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

• Scots

• Scottish Gaelic

• Serbian

• Serbo-Croatian

• Sinhalese

• Slovak

• Slovene

1229


DetailsField

• 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

Typeint

SequenceInMultipleBirth


DescriptionIf the individual is part of a birth involving multiple babies, the sequence of the individual inthat multiple birth.

Typestring

SourceSystemId__c

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


1230


DetailsField

Typestring

SourceSystem__c


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


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


DescriptionLookup to User object. If populated, assigns the care coordinator role based on the userrecord.

Typedate

BirthDate__c


DescriptionThe patient’s birthdate.

Typeboolean

CreatedFromLead__c

1231

Lead Standard and Custom FieldsHealth Cloud Developer Guide

DetailsField


DescriptionIndicates whether the individual was created from a converted lead (true) or not(false).

Typestring

InsuranceGroupId__c


DescriptionGroup ID of the patient or member’s insurance.

Typestring

InsuranceMemberId__c


DescriptionMember ID of the patient or member’s insurace.

Typepicklist

InsuranceType__c


DescriptionType of primary insurance: Medicare, Medicaid, commercial or self-pay.

Typeboolean

IsMarkedForPatientConversion__c


DescriptionWhether the lead will be converted to a patient record.

Typeboolean

IsOutOfNetwork__c


DescriptionIndicates that the referral is out-of-network.

1232


DetailsField

Typestring




Typedouble

NumberOfLocations__c


DescriptionNumber of locations associated with the lead.

Typepicklist

Primary__c


DescriptionIndicates whether the individual is the primary member of the household (true) or not(false).

Typereference

PrimaryDiagnosis__c


DescriptionLookup to the HealthcareDiagnosis object.

Typepicklist

PrimaryInsurance__c


DescriptionPrimary health insurance company associated with the patient.

Typepicklist

Priority__c


1233


DetailsField

DescriptionPriority of the referral as designated by the referring provider.

Typepicklist

ReasonForOutOfNetworkReferral__c


DescriptionReason the referral is sent out-of-network.

Typepicklist

ReasonForReferral__c


DescriptionReason for the referral.

Typepicklist

ReferralStatus__c


DescriptionIndicates status of referral processing.

Typereference

ReferredToOrganization__c


DescriptionName of the organization receiving or fulfilling the referral.

Typereference

ReferredToPractitioner__c


DescriptionName of the practitioner to whom the patient or member is being referred.

Typereference

ReferredToUser__c


1234


DetailsField

DescriptionName of the user to whom the referral is sent.

Typereference

ReferringOrganization__c


DescriptionName of the referring organization.

Typereference

ReferringPractitioner__c


DescriptionName of the practitioner who submitted the referral.

Typereference

ReferringUser__c


DescriptionName of the user who submitted the referral.

Typereference

RelatedAccount__c


DescriptionLook up to the account of the patient or member who is being referred.

Typereference

SecondaryDiagnosis__c



Typestring

SourceSystemId__c


1235


DetailsField


Typestring

SourceSystem__c


DescriptionThe system that created the record and owns updating rights for it.

Typepicklist

Specialty__c


DescriptionSpecialty associated with the referral.

Typereference

TertiaryDiagnosis__c



Typepicklist

TypeOfService__c


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.

1236

Opportunity Standard and Custom FieldsHealth Cloud Developer Guide

Fields

DetailsField

Typereference

AssignCareCoordinatorContact__c


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


DescriptionLookup to User object. If populated, assigns the care coordinator role based onthe user record.

Typedate

BirthDate__c


DescriptionThe patient’s birthdate.

Typeboolean

CreatedFromLead__c


DescriptionIndicates whether the individual was created from a converted lead (true) ornot (false).

Typereference

PrimaryDiagnosis__c



Typestring

InsuranceGroupId__c

1237


DetailsField


DescriptionGroup ID of the patient or member’s insurance.

Typestring

InsuranceMemberId__c


DescriptionMember ID of the patient or member’s insurace.

Typepicklist

InsuranceType__c


DescriptionType of primary insurance: Medicare, Medicaid, commercial or self-pay.

Typeboolean

IsMarkedForPatientConversion__c


DescriptionWhether the lead will be converted to a patient record.

Typeboolean

IsOutOfNetwork__c


DescriptionIndicates that the referral is out-of-network.

Typestring




Typedouble

NumberofLocations__c

1238


DetailsField


DescriptionNumber of locations associated with the lead.

Typepicklist

Primary__c


DescriptionIndicates whether the individual is the primary member of the household (true)or not (false).

Typepicklist

PrimaryInsurance__c


DescriptionPrimary health insurance company associated with the patient.

Typepicklist

Priority__c


DescriptionPriority of the referral as designated by the referring provider.

Typepicklist

ReasonForOutOfNetworkReferral__c


DescriptionReason the referral is sent out-of-network.

Typepicklist

ReasonForReferral__c


DescriptionReason for the referral.

1239


DetailsField

Typedate

ReferralReceivedDate__c


DescriptionDate referral was received by the organization.

Typereference

ReferredToOrganization__c


DescriptionName of the organization receiving or fulfilling the referral.

Typereference

ReferredToPractitioner__c


DescriptionName of the practitioner to whom the patient or member is being referred.

Typereference

ReferredToUser__c


DescriptionName of the user to whom the referral is sent.

Typereference

ReferringOrganization__c


DescriptionName of the referring organization.

Typereference

ReferringPractitioner__c


DescriptionName of the practitioner who submitted the referral.

1240


DetailsField

Typereference

ReferringUser__c


DescriptionName of the user who submitted the referral.

Typereference

SecondaryDiagnosis__c



Typestring

SourceSystemId__c



Typestring

SourceSystem__c


DescriptionThe system that created the record and owns updating rights for it.

Typepicklist

Specialty__c


DescriptionSpecialty associated with the referral.

Typereference

TertiaryDiagnosis__c



1241


DetailsField

Typepicklist

TypeOfService__c


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


DescriptionRepresents the intended objectives of carrying out a care plan.

Typereference

CarePlanProblem__c


DescriptionRepresents the conditions, problems, concerns, diagnoses, and so on, whose managementand mitigation are handled by this plan.

Typedouble

SortOrder___c


DescriptionThe order in which the task appears among other tasks associated with a goal.

Typepicklist

TaskType__c

1242

Task Custom FieldsHealth Cloud Developer Guide

DetailsField


DescriptionThe list of healthcare-related tasks configured in the org.

Referral Management Custom Fields on Standard ObjectsThese custom fields on standard Salesforce objects support referral 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.

• AnticipatedDischargeDate__c

• Diagnosis__c

• DischargeDate__c

• EmergencyContactFirstName__c

• EmergencyContactLastName__c

• EmergencyContactPhone__c

• EmergencyContactRelationship__c

• Face-to-FaceEncounterDate__c

• Gender__c

• Homebound__c

• InsuranceGroupId__c

• InsuranceMemberId__c

• InsuranceType__c

• IsOutOfNetwork__c

• Language__c

• PrimaryCareProvider__c

• PrimaryDiagnosisDescription__c

• PrimaryInsurance__c

• Priority__c

• ReasonforDisqualification

1243

Referral Management Custom Fields on Standard ObjectsHealth Cloud Developer Guide

• ReasonForOutOfNetworkReferral__c

• ReasonForReferral__c

• ReferralStatus__c

• ReferredToOrganization__c

• ReferredToPractitioner__c

• ReferredToUser__c

• ReferrerAdmitDate__c

• ReferringContactName__c

• ReferringContactPhone__c

• ReferringNPI__c

• ReferringOrganization__c

• ReferringPractitioner__c

• ReferringUser__c

• RelatedAccount__c

• SecondaryDiagnosisDescription__c

• SecondaryInsurance__c

• SecondaryInsuranceID__c

• SigningProvider__c

• Specialty__c

• SSN__c

• Start/ResumptionofCareDate__c

• TypeOfService__c

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

1244

Referral Management Custom Fields on Standard ObjectsHealth Cloud Developer Guide

• ReferringUser__c

• Specialty__c

• TypeOfService__c

Health Cloud Fields on Service AppointmentStandard and custom fields extend the standard Service Appointment object for use in Health Cloud to represent information about ahealthcare appointment.

Fields

DetailsField

Typereference

StatusReason


DescriptionA higher-level category for explaining the value given as the status of the appointment. Thepicklist includes the following values, which can be customized:

• None—Default value.

• Proposed

• NoShow

• Rejected

HealthCloudExt Namespace


The HealthCloudExt namespace includes these classes and interfaces.

HealthCloudExt Namespace for Intelligent Appointment Management


HealthCloudExt Namespace for Benefit Verification


HealthCloudExt Namespace for Intelligent Appointment ManagementThe HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic healthrecords (EHR) system.

1245

Health Cloud Fields on Service AppointmentHealth Cloud Developer Guide

The HealthCloudExt namespace includes these classes and interface.

AppointmentBase Class

An abstract base class that represents the care provider or the practitioner information.

AppointmentBookingInterop Interface

Contains default Apex implementation for healthcare appointment availability and booking.

AppointmentBookingInteropFhirAdapter Class

Represents the global class that implements the AppointmentBookingInterop interface.

AppointmentProvider Class

Represents additional information about the care provider and an appointment.

BookAppointmentRequest Class

Contains set of options to book a healthcare appointment.

BookAppointmentResponse Class

Represents the appointment booking details from the external scheduling system.

CancelAppointmentRequest Class

Contains set of options to cancel the booked appointment.

CancelAppointmentResponse Class

Represents the appointment cancellation details from the external scheduling system.

FindSlotsRequest Class

Contains set of options to find available time slots for providers who match the patient’s needs. This class extends theAppointmentBase class and inherits its properties.

GetSlotStatusRequest Class

Contains set of options to retrieve the slot status.

Slot Class

Represents the time period slot details for the appointment.

BookingStatus Enum

Represents a possible status of a healthcare appointment.

SEE ALSO:


AppointmentBase ClassAn abstract base class that represents the care provider or the practitioner information.

Namespacehealthcloudext on page 1245

AppointmentBase Properties

1246

HealthCloudExt Namespace for Intelligent AppointmentManagement

Health Cloud Developer Guide

AppointmentBase PropertiesThe following are properties for AppointmentBase.

careProviders

Represents details about the care provider or the practitioner.

careProviders

Represents details about the care provider or the practitioner.

Signature

public List<healthcloudext.AppointmentProvider> careProviders {get; set;}

Property Value

Type: List<healthcloudext.AppointmentProvider on page 1254>

AppointmentBookingInterop InterfaceContains default Apex implementation for healthcare appointment availability and booking.


UsageManaging appointments from Health Cloud requires identifying the source system's time slot support; implementing the Health Cloudglobal AppointmentBookingInterop interface; transforming the input request to fit the source electronic health records (EHR)system; routing the request to the EHR system; and getting the appointment information back from an external appointment bookingsystem.

The external appointment management system is commonly part of a larger electronic health records (EHR) system. The integrationbetween Health Cloud and the EHR can be direct or via integration middleware such as Mulesoft.

The OrgPermissions.HealthCloud permission must be enabled in your Salesforce org to access the Health CloudAppointmentBookingInterop interface and its methods.

You can use the default implementation AppointmentBookingInteropFhirAdapter provided by Health Cloud to makea call out to an external scheduling system of truth for appointment availability and booking. All communications with the externalsystem use the FHIR 4 standard.

If implementing the default Health Cloud global interface is not right for your context, you can provide your own Apex class and integratewith your appointment management system in your own way. An ISV or a Salesfore partner having Health Cloud license can distributecustomized Apex code to your organization using packages.

Use Salesforce platform Named Credentials to configure the class name and authentication for Apex callouts. Then, map the NameCredential name in the AppointmentBookingConfig setup object. The Apex delegator class uses the setup object to invokethe corresponding implementation between the default implementation or your own provided Apex implementation. See NamedCredentials as Callout Endpoints in the Apex Developer Guide.

1247



https://developer.salesforce.com/docs/atlas.en-us.238.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm

AppointmentBookingInterop Methods

AppointmentBookingInterop Example Implementation

AppointmentBookingInterop MethodsThe following are methods for AppointmentBookingInterop.

bookAppointment(var1)

Creates the healthcare appointment in the external scheduling system.

cancelAppointment(var1)

Cancels the booking appointment in the external scheduling system.

findSlots(var1)

Finds the available time slots for providers who match the patient’s needs.

getSlotStatus(var1)

Retrieves the status of the time period slot that’s assigned to the appointment.

bookAppointment(var1)

Creates the healthcare appointment in the external scheduling system.

Signature

public healthcloudext.BookAppointmentResponsebookAppointment(healthcloudext.BookAppointmentRequest var1)

Parameters

var1Type: healthcloudext.BookAppointmentRequest

Return Value

Type: healthcloudext.BookAppointmentResponse

cancelAppointment(var1)

Cancels the booking appointment in the external scheduling system.

Signature

public healthcloudext.CancelAppointmentResponsecancelAppointment(healthcloudext.CancelAppointmentRequest var1)

Parameters

var1Type: healthcloudext.CancelAppointmentRequest

1248



Return Value

Type: healthcloudext.CancelAppointmentResponse

findSlots(var1)

Finds the available time slots for providers who match the patient’s needs.

Signature

public Map<String,List<healthcloudext.Slot>> findSlots(healthcloudext.FindSlotsRequestvar1)

Parameters

var1Type: healthcloudext.FindSlotsRequest

Return Value

Type: Map<String,List<healthcloudext.Slot>>

getSlotStatus(var1)

Retrieves the status of the time period slot that’s assigned to the appointment.

Signature

public healthcloudext.Slot getSlotStatus(healthcloudext.GetSlotStatusRequest var1)

Parameters

var1Type: healthcloudext.GetSlotStatusRequest

Return Value

Type: healthcloudext.Slot

AppointmentBookingInterop Example ImplementationThis is an example implementation of the default class AppointmentBookingInteropFhirAdapter that implements thehealthcloudext.AppointmentBookingInterop interface.

global class AppointmentBookingInteropFhirAdapter implements AppointmentBookingInterop{static final String DEFAULT_ERROR_MESSAGE = 'Error during callout to the external

system';static final String DEFAULT_ERROR_CODE = '500';

/*@Method Name: findSlots

1249

@Param: request Type: FindSlotsRequest@Desc: FindSlot implementation

*/global Map<String,List<Slot>> findSlots(FindSlotsRequest request){

Map<String,List<Slot>> response = new Map<String,List<Slot>>();try {HttpRequest httpReq = FindSlotsMapper.mapHttpRequest(request);Http http = new Http();HTTPResponse res = http.send(httpReq);System.debug('Response Body >>>>'+res.getBody());Integer statusCode = res.getStatusCode();if(statusCode == 200) {

FHIR.Bundle bundle = FHIRParser.parseSlotBundle(res.getBody());return FindSlotsMapper.mapResponse(request,bundle);

} else {processErrorResponse(res);

}} catch(AppointmentManagementException e) {throw e;

} catch(Exception e){throw new AppointmentManagementException(e.getMessage(), DEFAULT_ERROR_CODE, '',

e);}return response;

}public void processErrorResponse(HTTPResponse res){

try {FHIR.OperationOutcome outcome = FHIRParser.parseOperationOutcome(res.getBody());throw new AppointmentManagementException(getErrorMessage(outcome),

String.valueOf(res.getStatusCode()), res.getBody());}catch(Exception e){//If couldn't able to parse to OperationOutcome, issue might be

from Middlewareif(res.getStatusCode() == 404) {

throw new AppointmentManagementException('Find available slots endpoint notfound, check the Appointment Booking Config & Appointment Booking URL Config',String.valueOf(res.getStatusCode()), res.getBody());

}else {throw new AppointmentManagementException(e.getMessage(), DEFAULT_ERROR_CODE,

'');}

}}/*

@Method Name: bookAppointment@Param: request Type: BookAppointmentRequest@Desc: Book Appointment implementation

*/global BookAppointmentResponse bookAppointment(BookAppointmentRequest request){BookAppointmentResponse response;

try{HttpRequest httpReq = BookAppointmentMapper.mapHttpRequest(request);Http http = new Http();HTTPResponse res = http.send(httpReq);System.debug('Response Body >>>>'+res.getBody());

1250

Integer statusCode = res.getStatusCode();if(statusCode == 200 || statusCode == 201) {

FHIR.Appointment appointment = FHIRParser.parseAppointment(res.getBody());response = BookAppointmentMapper.mapResponse(request, appointment, res.getBody());

} else {FHIR.OperationOutcome outcome = FHIRParser.parseOperationOutcome(res.getBody());

throw new AppointmentManagementException(getErrorMessage(outcome),String.valueOf(statusCode), res.getBody());

}}catch (Exception e){throw new AppointmentManagementException(DEFAULT_ERROR_MESSAGE, DEFAULT_ERROR_CODE,

'');}return response;

}

/*@Method Name: getSlotStatus@Param: request Type: GetSlotStatusRequest@Desc: getSlotStatus implementation*/global Slot getSlotStatus(GetSlotStatusRequest request){

try{HttpRequest httpReq = GetSlotStatusMapper.mapHttpRequest(request);Http http = new Http();HTTPResponse res = http.send(httpReq);if(res.getStatusCode() == 200) {

FHIR.Slot slot = FHIRParser.parseSlot(res.getBody());return GetSlotStatusMapper.mapResponse(slot);

}else {FHIR.OperationOutcome outcome = FHIRParser.parseOperationOutcome(res.getBody());

throw new AppointmentManagementException(getErrorMessage(outcome),String.valueOf(res.getStatusCode()), res.getBody());

}}catch (Exception e){throw new AppointmentManagementException(DEFAULT_ERROR_MESSAGE, DEFAULT_ERROR_CODE,

'');}

}

/*@Method Name: cancelAppointment@Param: request Type: CancelAppointmentRequest@Desc: Cancel Appointment implementation*/global CancelAppointmentResponse cancelAppointment(CancelAppointmentRequest request){

try{HttpRequest httpReq = CancelAppointmentMapper.mapHttpRequest(request);Http http = new Http();HTTPResponse res = http.send(httpReq);

1251



System.debug('Response Body >>>>'+res.getBody());Integer statusCode = res.getStatusCode();CancelAppointmentResponse response;if(statusCode == 200 || statusCode == 201) {

FHIR.Appointment appointment = FHIRParser.parseAppointment(res.getBody());response = CancelAppointmentMapper.mapResponse( appointment, res.getBody());

} else {FHIR.OperationOutcome outcome = FHIRParser.parseOperationOutcome(res.getBody());

throw new AppointmentManagementException(getErrorMessage(outcome),String.valueOf(statusCode), res.getBody());

}return response;}catch (Exception e){throw new AppointmentManagementException(DEFAULT_ERROR_MESSAGE, DEFAULT_ERROR_CODE,

'');}

}

public static String getErrorMessage(FHIR.OperationOutcome outcome){String errorMessage = DEFAULT_ERROR_MESSAGE;if(outcome != null) {if(outcome.issue != null && outcome.issue.size() > 0) {

if(outcome.issue[0].details != null && outcome.issue[0].details.text != null){

errorMessage = outcome.issue[0].details.text;} else if(outcome.issue[0].diagnostics != null) {

errorMessage = outcome.issue[0].diagnostics;}

}}return errorMessage;

}}

AppointmentBookingInteropFhirAdapter ClassRepresents the global class that implements the AppointmentBookingInterop interface.


AppointmentBookingInteropFhirAdapter Methods

AppointmentBookingInteropFhirAdapter MethodsThe following are methods for AppointmentBookingInteropFhirAdapter.

bookAppointment(request)

Contains set of options to book a healthcare appointment with the external scheduling system.

1252



cancelAppointment(request)

Contains set of options to cancel the booked appointment from the external scheduling system.

findSlots(request)

Contains set of options to find available time slots for healthcare providers who match the patient’s needs.

getSlotStatus(request)


bookAppointment(request)

Contains set of options to book a healthcare appointment with the external scheduling system.

Signature

public healthcloudext.BookAppointmentResponsebookAppointment(healthcloudext.BookAppointmentRequest request)

Parameters

requestType: healthcloudext.BookAppointmentRequest

Return Value

Type: healthcloudext.BookAppointmentResponse

cancelAppointment(request)

Contains set of options to cancel the booked appointment from the external scheduling system.

Signature

public healthcloudext.CancelAppointmentResponsecancelAppointment(healthcloudext.CancelAppointmentRequest request)

Parameters

requestType: healthcloudext.CancelAppointmentRequest

Return Value

Type: healthcloudext.CancelAppointmentResponse

findSlots(request)

Contains set of options to find available time slots for healthcare providers who match the patient’s needs.

1253



Signature

public Map<String,List<healthcloudext.Slot>> findSlots(healthcloudext.FindSlotsRequestrequest)

Parameters

requestType: healthcloudext.FindSlotsRequest

Return Value

Type: Map<String,List<healthcloudext.Slot>>

getSlotStatus(request)


Signature

public healthcloudext.Slot getSlotStatus(healthcloudext.GetSlotStatusRequest request)

Parameters

requestType: healthcloudext.GetSlotStatusRequest

Return Value

Type: healthcloudext.Slot

AppointmentProvider ClassRepresents additional information about the care provider and an appointment.


AppointmentProvider Properties

AppointmentProvider PropertiesThe following are properties for AppointmentProvider.

appointmentTypeCode

Represents the code for the appointment type.

careProviderId

Represents the ID of the care provider.

1254

npi

Represents the unique National Provider Identifier that is assigned to each facility and licensed practitioner.

practitionerFacilityId

Represents the facility ID of the practitioner.

serviceTypeCode

Represents the code of the service type to be performed at the appointment.

sourceFacilityId

Represents the ID in the source system of the facility where the encounter will occur.

sourcePractitionerId

Represents the ID in the source system of the practitioner with whom the encounter will occur.

sourceSystem

Represents the name of the source system the provider record came from.

appointmentTypeCode

Represents the code for the appointment type.

Signature

public String appointmentTypeCode {get; set;}

Property Value

Type: String

careProviderId

Represents the ID of the care provider.

Signature

public String careProviderId {get; set;}

Property Value

Type: String

npi

Represents the unique National Provider Identifier that is assigned to each facility and licensed practitioner.

Signature

public String npi {get; set;}

Property Value

Type: String

1255



practitionerFacilityId

Represents the facility ID of the practitioner.

Signature

public String practitionerFacilityId {get; set;}

Property Value

Type: String

serviceTypeCode

Represents the code of the service type to be performed at the appointment.

Signature

public String serviceTypeCode {get; set;}

Property Value

Type: String

sourceFacilityId


Signature

public String sourceFacilityId {get; set;}

Property Value

Type: String



Signature

public String sourcePractitionerId {get; set;}

Property Value

Type: String

sourceSystem

Represents the name of the source system the provider record came from.

1256



Signature

public String sourceSystem {get; set;}

Property Value

Type: String

BookAppointmentRequest ClassContains set of options to book a healthcare appointment.


UsageTo book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloudqueries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system.

Practitioner and Facility IDs:

• The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination.

• The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the samesource system as the Healthcare Practitioner Facility record.

• The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same sourcesystem as the Healthcare Practitioner Facility record.

The source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selectedby the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to CodeSet Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with.

BookAppointmentRequest Properties

BookAppointmentRequest PropertiesThe following are properties for BookAppointmentRequest.

appointmentType

Represents the type of appointment, such as annual physical or intake examination.

note

Represents optional extra information about the appointment.

serviceType

Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery.

slot

Represents the time period slot that’s assigned to the appointment.

sourceFacilityId


1257



sourcePatientId

Represents the ID in the source system of the patient.



sourceSystem

Represents the name of the source system the patient record came from.

appointmentType


Signature

public String appointmentType {get; set;}

Property Value

Type: String

note

Represents optional extra information about the appointment.

Signature

public String note {get; set;}

Property Value

Type: String

serviceType


Signature

public String serviceType {get; set;}

Property Value

Type: String

slot


Signature

public String slot {get; set;}

1258



Property Value

Type: String

sourceFacilityId


Signature


Property Value

Type: String

sourcePatientId

Represents the ID in the source system of the patient.

Signature

public String sourcePatientId {get; set;}

Property Value

Type: String



Signature


Property Value

Type: String

sourceSystem

Represents the name of the source system the patient record came from.

Signature


Property Value

Type: String

1259



BookAppointmentResponse ClassRepresents the appointment booking details from the external scheduling system.


BookAppointmentResponse Properties

BookAppointmentResponse PropertiesThe following are properties for BookAppointmentResponse.

appointmentId

Represents the unique identifier of the appointment in Health Cloud.

jsonResponse

Represents the response from the external scheduling system encoded as JSON.

note

Represents optional extra information added to the appointment.

patientId

Represents the unique identifier of the patient in Health Cloud.

slotEnd

Represents the date and time that the available time slot ends.

slotStart

Represents the date and time that the available time slot starts.

sourceAppointmentId

Represents the unique identifier of the appointment in the source system.

sourcePatientId

Represents the ID of the patient in the source system.

sourceSystem

Represents the name of the external scheduling system from which the record was sourced.

status

Represents the status of the appointment.

appointmentId

Represents the unique identifier of the appointment in Health Cloud.

Signature

public String appointmentId {get; set;}

1260



Property Value

Type: String

jsonResponse


Signature

public String jsonResponse {get; set;}

Property Value

Type: String

note

Represents optional extra information added to the appointment.

Signature

public String note {get; set;}

Property Value

Type: String

patientId

Represents the unique identifier of the patient in Health Cloud.

Signature

public String patientId {get; set;}

Property Value

Type: String

slotEnd

Represents the date and time that the available time slot ends.

Signature

public String slotEnd {get; set;}

Property Value

Type: String

1261



slotStart

Represents the date and time that the available time slot starts.

Signature

public String slotStart {get; set;}

Property Value

Type: String

sourceAppointmentId

Represents the unique identifier of the appointment in the source system.

Signature

public String sourceAppointmentId {get; set;}

Property Value

Type: String

sourcePatientId

Represents the ID of the patient in the source system.

Signature


Property Value

Type: String

sourceSystem


Signature


Property Value

Type: String

status

Represents the status of the appointment.

1262



Signature

public healthcloudext.BookingStatus status {get; set;}

Property Value

Type: healthcloudext.BookingStatus on page 1271

CancelAppointmentRequest ClassContains set of options to cancel the booked appointment.


CancelAppointmentRequest Properties

CancelAppointmentRequest PropertiesThe following are properties for CancelAppointmentRequest.

appointmentId

Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object.

appointmentType


cancelationReason

Represents the reason for canceling the appointment.

serviceType


slot


sourceFacilityId

Represents the healthcare facility where the encounter will occur in the external scheduling system.

sourcePatientId

Represents the ID of the patient in the external scheduling system.


ID of the practitioner who is performing care in the encounter.

sourceSystem

Name of the external scheduling system from which the record was sourced.

appointmentId

Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object.

1263



Signature

public String appointmentId {get; set;}

Property Value

Type: String

appointmentType


Signature

public String appointmentType {get; set;}

Property Value

Type: String

cancelationReason

Represents the reason for canceling the appointment.

Signature

public String cancelationReason {get; set;}

Property Value

Type: String

serviceType


Signature


Property Value

Type: String

slot


Signature

public String slot {get; set;}

1264



Property Value

Type: String

sourceFacilityId

Represents the healthcare facility where the encounter will occur in the external scheduling system.

Signature


Property Value

Type: String

sourcePatientId

Represents the ID of the patient in the external scheduling system.

Signature


Property Value

Type: String


ID of the practitioner who is performing care in the encounter.

Signature


Property Value

Type: String

sourceSystem

Name of the external scheduling system from which the record was sourced.

Signature


Property Value

Type: String

1265



CancelAppointmentResponse ClassRepresents the appointment cancellation details from the external scheduling system.


CancelAppointmentResponse Properties

CancelAppointmentResponse PropertiesThe following are properties for CancelAppointmentResponse.

externalAppointmentId

Represents the appointment identifier from the external scheduling system.

jsonResponse


serviceAppointmentId

Represents the ID of the service appointment that you want to update.

status

Represents the status of the healthcare appointment.

externalAppointmentId

Represents the appointment identifier from the external scheduling system.

Signature

public String externalAppointmentId {get; set;}

Property Value

Type: String

jsonResponse


Signature


Property Value

Type: String

1266



serviceAppointmentId

Represents the ID of the service appointment that you want to update.

Signature

public String serviceAppointmentId {get; set;}

Property Value

Type: String

status

Represents the status of the healthcare appointment.

Signature

public healthcloudext.BookingStatus status {get; set;}

Property Value

Type: healthcloudext.BookingStatus on page 1271

FindSlotsRequest ClassContains set of options to find available time slots for providers who match the patient’s needs. This class extends theAppointmentBase class and inherits its properties.


FindSlotsRequest Properties

FindSlotsRequest PropertiesThe following are properties for FindSlotsRequest.

slotRangeEnd

Represents the start of date range for slots in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.

slotRangeStart

Represents the end of date range for slots in ISO 8601 format, for example , 2021-02-25T18:24:31.000Z.

isNextAvailSlot

In the default Apex class, if the property is set to True, gets a provider's next 160 available slots for appointment scheduling. If setto False, gets the next 500 available slots of providers in general.

patientId

Represents a patient's AccountId.

1267



slotRangeEnd

Represents the start of date range for slots in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.

Signature

public String slotRangeEnd {get; set;}

Property Value

Type: String

slotRangeStart

Represents the end of date range for slots in ISO 8601 format, for example , 2021-02-25T18:24:31.000Z.

Signature

public String slotRangeStart {get; set;}

Property Value

Type: String

isNextAvailSlot

In the default Apex class, if the property is set to True, gets a provider's next 160 available slots for appointment scheduling. If set toFalse, gets the next 500 available slots of providers in general.

Signature

public Boolean isNextAvailSlot {get; set;}

Property Value

Type: Boolean

patientId

Represents a patient's AccountId.

Signature

public Boolean patientId {get; set;}

Property Value

Type: String

GetSlotStatusRequest ClassContains set of options to retrieve the slot status.

1268




GetSlotStatusRequest Properties

GetSlotStatusRequest PropertiesThe following are properties for GetSlotStatusRequest.

slotId

Unique identifier for the time period slot in the external scheduling system that’s assigned to the appointment.

slotSourceSystem

Name of the external scheduling system from which the time period slot record came from. This information comes from HealthcarePractitioner Facility.

slotSourceSystemId

Represents the ID of the source system from which the request was sourced.

slotId

Unique identifier for the time period slot in the external scheduling system that’s assigned to the appointment.

Signature

public String slotId {get; set;}

Property Value

Type: String

slotSourceSystem

Name of the external scheduling system from which the time period slot record came from. This information comes from HealthcarePractitioner Facility.

Signature

public String slotSourceSystem {get; set;}

Property Value

Type: String

slotSourceSystemId

Represents the ID of the source system from which the request was sourced.

1269



Signature

public String slotSourceSystemId {get; set;}

Property Value

Type: String

Slot ClassRepresents the time period slot details for the appointment.


Slot Properties

Slot PropertiesThe following are properties for Slot.

slotEnd

Represents the date and time that the appointment time slot ends in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z..

slotStart

Represents the date and time that the appointment time slot starts in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z..

slotStatus

Represents the status of the time slot.

sourceSlotId

Represents the ID of the time slot in the external scheduling system.

sourceSystem


slotEnd

Represents the date and time that the appointment time slot ends in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z..

Signature

public String slotEnd {get; set;}

Property Value

Type: String

slotStart

Represents the date and time that the appointment time slot starts in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z..

1270



Signature

public String slotStart {get; set;}

Property Value

Type: String

slotStatus

Represents the status of the time slot.

Signature

public String slotStatus {get; set;}

Property Value

Type: String

sourceSlotId

Represents the ID of the time slot in the external scheduling system.

Signature

public String sourceSlotId {get; set;}

Property Value

Type: String

sourceSystem


Signature


Property Value

Type: String

BookingStatus EnumRepresents a possible status of a healthcare appointment.


1271



Enum ValuesThe following are the values of the healthcloudext.BookingStatus enum.

DescriptionValue

Indicates that a scheduled appointment has been canceled.Canceled

Indicates that a patient didn’t show up for a scheduled appointment.NoShow

Indicates that a new date and time has been proposed for a scheduled appointment.Proposed

Indicates that a scheduled appointment has been rejected.Rejected

Indicates that an appointment has been scheduled.Scheduled

HealthCloudExt Namespace for Benefit VerificationThe HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic healthrecords (EHR) system.

Integrate benefit verification into the end-to-end patient access workflow to help caregivers and patients reduce the time and effort ittakes to find out what coverage is available under each patient's health benefits.

The HealthCloudExt namespace includes these classes and interface.

BenefitsItem Class

Specific service covered by the insurance plan.

BenefitsItemLimit Class

Services not covered, or expenditures required for coverage.

BenefitsVerificationRequest Class

Request for verification of benefits.

BenefitsVerificationResponse Class

Response for verification of benefits.

IBenefitsVerificationInterOp Interface

Contains default Apex implementation for verification of benefits.

SEE ALSO:

Health Cloud Administration Guide: Setting up Benefit Verification

BenefitsItem ClassSpecific service covered by the insurance plan.

NamespaceHealthCloudExt

BenefitsItem Properties

1272

HealthCloudExt Namespace for Benefit VerificationHealth Cloud Developer Guide

https://help.salesforce.com/articleView?id=sf.admin_benefit_verification_setup.htm&language=en_US

BenefitsItem PropertiesThe following are properties for BenefitsItem.

benefitsCategory

Name of the category this benefit is in.

benefitsItemLimit

inPlanNetworkIndicator

Indicates if the benefit is only available in the plan network. The default value is 'false'.

notes

Description of the coverage for non-preferred providers.

serviceType

The type of service this plan benefit item provides.

serviceTypeCode

The code for the type of service this plan benefit item provides.

benefitsCategory

Name of the category this benefit is in.

Signature

public String benefitsCategory {get; set;}

Property Value

Type: String

benefitsItemLimit

Signature

public List<healthcloudext.BenefitsItemLimit> benefitsItemLimit {get; set;}

Property Value

Type: List<healthcloudext.BenefitsItemLimit>

inPlanNetworkIndicator

Indicates if the benefit is only available in the plan network. The default value is 'false'.

Signature

public Boolean inPlanNetworkIndicator {get; set;}

1273

Property Value

Type: Boolean

notes

Description of the coverage for non-preferred providers.

Signature

public String notes {get; set;}

Property Value

Type: String

serviceType

The type of service this plan benefit item provides.

Signature


Property Value

Type: String

serviceTypeCode

The code for the type of service this plan benefit item provides.

Signature

public String serviceTypeCode {get; set;}

Property Value

Type: String

BenefitsItemLimit ClassServices not covered, or expenditures required for coverage.


BenefitsItemLimit Properties

1274


BenefitsItemLimit PropertiesThe following are properties for BenefitsItemLimit.

benefitCode

benefitMetricType

benefitValue

coverageLevel

Defines the persons eligible for the benefit item. Possible values are EmployeeSpouse, Family, Individual.

limitNotes

General information about the limit.

networkType

Specifies whether the provider is eligible for reimbursement. Possible values are In, NA, Out.

termType

Specifies the type of time period during which the benefit item is available. Possible values are Calendar Year, Day, Month, Year toDate.

benefitCode

Signature

public String benefitCode {get; set;}

Property Value

Type: String

benefitMetricType

Signature

public String benefitMetricType {get; set;}

Property Value

Type: String

benefitValue

Signature

public String benefitValue {get; set;}

Property Value

Type: String

1275


coverageLevel

Defines the persons eligible for the benefit item. Possible values are EmployeeSpouse, Family, Individual.

Signature

public String coverageLevel {get; set;}

Property Value

Type: String

limitNotes

General information about the limit.

Signature

public String limitNotes {get; set;}

Property Value

Type: String

networkType

Specifies whether the provider is eligible for reimbursement. Possible values are In, NA, Out.

Signature

public String networkType {get; set;}

Property Value

Type: String

termType

Specifies the type of time period during which the benefit item is available. Possible values are Calendar Year, Day, Month, Year to Date.

Signature

public String termType {get; set;}

Property Value

Type: String

BenefitsVerificationRequest ClassRequest for verification of benefits.

1276



BenefitsVerificationRequest Properties

BenefitsVerificationRequest PropertiesThe following are properties for BenefitsVerificationRequest.

benefitsRequestId

Identifies the associated case.

encounterDate

groupNumber

memberAccountId

memberNumber

payerId

providerNpi

Default National Provider Identifier to be used in the benefits verification request.

providerOrganizationName

Specifies the organization name to use for the benefits verification request service.

providerType

serviceTypeCodes

Represents the code of the service type to be performed.

benefitsRequestId

Identifies the associated case.

Signature

public String benefitsRequestId {get; set;}

Property Value

Type: String

encounterDate

Signature

public String encounterDate {get; set;}

Property Value

Type: String

1277


groupNumber

Signature

public String groupNumber {get; set;}

Property Value

Type: String

memberAccountId

Signature

public String memberAccountId {get; set;}

Property Value

Type: String

memberNumber

Signature

public String memberNumber {get; set;}

Property Value

Type: String

payerId

Signature

public String payerId {get; set;}

Property Value

Type: String

providerNpi

Default National Provider Identifier to be used in the benefits verification request.

Signature

public String providerNpi {get; set;}

1278


Property Value

Type: String

providerOrganizationName

Specifies the organization name to use for the benefits verification request service.

Signature

public String providerOrganizationName {get; set;}

Property Value

Type: String

providerType

Signature

public String providerType {get; set;}

Property Value

Type: String

serviceTypeCodes

Represents the code of the service type to be performed.

Signature

public List<String> serviceTypeCodes {get; set;}

Property Value

Type: List<String>

BenefitsVerificationResponse ClassResponse for verification of benefits.


BenefitsVerificationResponse Properties

1279

BenefitsVerificationResponse PropertiesThe following are properties for BenefitsVerificationResponse.

benefitPeriodEndDate

Last day of the coverage benefit period.

benefitPeriodStartDate

First day of the coverage benefit period.

benefitsItem


benefitsRequestId

Identifies the benefit verification request that this message responds to.

errorResponse

Use to respond with an error indication following errors such as request-forbidden responses, custom validation errors, or expiredAPI tokens.

groupNumber

isCoverageActive

Indicates whether the coverage benefit is currently in force.

jsonResponse

Full JSON response from external system.

memberNumber

benefitPeriodEndDate

Last day of the coverage benefit period.

Signature

public String benefitPeriodEndDate {get; set;}

Property Value

Type: String

benefitPeriodStartDate

First day of the coverage benefit period.

Signature

public String benefitPeriodStartDate {get; set;}

Property Value

Type: String

1280


benefitsItem


Signature

public List<healthcloudext.BenefitsItem> benefitsItem {get; set;}

Property Value

Type: List<healthcloudext.BenefitsItem>

benefitsRequestId

Identifies the benefit verification request that this message responds to.

Signature

public String benefitsRequestId {get; set;}

Property Value

Type: String

errorResponse

Use to respond with an error indication following errors such as request-forbidden responses, custom validation errors, or expired APItokens.

Signature

public String errorResponse {get; set;}

Property Value

Type: String

groupNumber

Signature

public String groupNumber {get; set;}

Property Value

Type: String

isCoverageActive

Indicates whether the coverage benefit is currently in force.

1281

Signature

public Boolean isCoverageActive {get; set;}

Property Value

Type: Boolean

jsonResponse

Full JSON response from external system.

Signature


Property Value

Type: String

memberNumber

Signature

public String memberNumber {get; set;}

Property Value

Type: String

IBenefitsVerificationInterOp InterfaceContains default Apex implementation for verification of benefits.


IBenefitsVerificationInterOp Methods

IBenefitsVerificationInterOp Example Implementation

IBenefitsVerificationInterOp MethodsThe following are methods for IBenefitsVerificationInterOp.

verifyBenefits(var1)

Verifies the benefits.

1282


verifyBenefits(var1)

Verifies the benefits.

Signature

public List<healthcloudext.BenefitsVerificationResponse>verifyBenefits(List<healthcloudext.BenefitsVerificationRequest> var1)

Parameters

var1Type: List<healthcloudext.BenefitsVerificationRequest>

Return Value

Type: List<healthcloudext.BenefitsVerificationResponse>

IBenefitsVerificationInterOp Example ImplementationThis is an example implementation of the healthcloudext.IBenefitsVerificationInterOp interface.

global class BenefitsVerificationInterImpl implementshealthcloudext.IBenefitsVerificationInterOp {

/*@Method Name: verifyBenefits@Param: List of BenefitsVerificationRequests@Desc: Method which will do external callout to get the benefits verification

information and transform this information in the form of the BenefitsVerificationResponse

*/public List<healthcloudext.BenefitsVerificationResponse>

verifyBenefits(List<healthcloudext.BenefitsVerificationRequest> request) {List<healthcloudext.BenefitsVerificationResponse> responses = new

List<healthcloudext.BenefitsVerificationResponse>();

// Customer code to perform external callout to retrieve benefits verificationinformation and transform response

return responses;}

}

Creating and Importing Documents

You can integrate a fax system with Health Cloud's Intelligent Document Automation features by creating and importing documentsprogrammatically.

To bring a new document into Health Cloud from an external source, such as a fax system, create a Content Document record and aReceived Document record and link them together with a Content Document Link record.

Health Cloud supports the PDF, JPG, JPEG, and PNG file types.

1283

Creating and Importing DocumentsHealth Cloud Developer Guide

Tip: For help getting set up, see the Quick Start section of the Salesforce REST API Developer Guide.

1. Make sure your users have access to the Intelligent Document Automation features.

See Set Up Intelligent Document Automation Users for the user setup requirements.

2. Create a Content Document record.

See Inserting a New Document in the Salesforce REST API Developer Guide for instructions.

This gives you a Content Document ID.

3. Create a Received Document record.

See ReceivedDocument in the Health Cloud Developer Guide for details.

For the Name field, use the name of the uploaded content document.

a. If you have the Intelligent Form Reader license, keep Disable Auto OCR = false (unchecked).

b. Keep Active = true (checked).

This gives you a Received Document ID.

Note: See the Developer Guide for other fields you can use for mapping metadata.

4. Create a Content Document Link record to join these two IDs, with the sharing mode to I (inferred).

See ContentDocumentLink in the Salesforce Object Reference for details.

To optimize the operation, consider these alternative approaches:

• You can use the Composite API to combine steps 2 and 3.

• If the content document is under 35 MB, you can use the Composite API to combine all three steps.


Health Cloud integrates with a customer’s appointment management system to provide a patient appointment booking experience inSalesforce for call center agents and care coordinators. The Health Cloud data model for appointments enables you to work with multiplesource systems operating on different EHR platforms.

Architecture

Managing appointments from Health Cloud requires identifying the source system's time slot support; implementing the HealthCloud global interface; transforming the input request to fit the source electronic health records (EHR) system; routing the requestto the EHR system; and getting the appointment information back.

Data Model

To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, HealthCloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system.

User Workflow

Intelligent Appointment Management enables call center agents and care coordinators to select visit types, dates, and providersfrom a facility's EHR system to match a patient's needs.

1284


https://developer.salesforce.com/docs/atlas.en-us.238.0.api_rest.meta/api_rest/quickstart.htm

https://help.salesforce.com/articleView?id=admin_document_automation_users.htm&language=en_US

https://developer.salesforce.com/docs/atlas.en-us.238.0.api_rest.meta/api_rest/dome_sobject_insert_update_blob.htm

https://developer.salesforce.com/docs/atlas.en-us.228.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_receiveddocument.htm

https://developer.salesforce.com/docs/atlas.en-us.228.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_receiveddocument.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.api_rest.meta/api_rest/resources_composite_composite.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.api_rest.meta/api_rest/resources_composite_composite.htm

Operations

The available operations include finding available appointment time slots, determining the status of an appointment slot, creatingan appointment, getting a scheduled appointment, and canceling an appointment.

SEE ALSO:

HealthCloudExt Namespace for Intelligent Appointment Management

Salesforce Developer Guide: Named Credentials

ArchitectureManaging appointments from Health Cloud requires identifying the source system's time slot support; implementing the Health Cloudglobal interface; transforming the input request to fit the source electronic health records (EHR) system; routing the request to the EHRsystem; and getting the appointment information back.

The external appointment management system is commonly part of a larger electronic health records (EHR) system. The integrationbetween Health Cloud and the EHR can be direct or via integration middleware such as Mulesoft.

The Salesforce Provider data model provides the getProviders() call to filter and show providers in the UI.

REST callouts from Health Cloud point to the source system of truth for appointment availability and booking. If implementing the defaultREST endpoints called by Health Cloud is not right for your context, you can provide your own Apex class and integrate with yourappointment management system in your own way.

Health Cloud makes appointment scheduling requests to the external system, and does not persist provider availability or replace theexisting systems that healthcare teams directly use in practice facilities. The external appointment management system manages allinformation about health care provider availability and is the ultimate authority on appointment status.

Use Salesforce platform Named Credentials to configure the endpoint base URI and authentication.

1285

ArchitectureHealth Cloud Developer Guide


https://developer.salesforce.com/docs/atlas.en-us.238.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_provider_data_model.htm


Data ModelTo book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloudqueries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system.

Practitioner and Facility IDs• The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination.

• The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the samesource system as the Healthcare Practitioner Facility record.

• The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same sourcesystem as the Healthcare Practitioner Facility record.

Booking an appointment against a facility alone, such as an X-Ray, lab work, or dialysis, is not supported. A practitioner must be definedfor the facility, even if it is a placeholder.

Note: What's the difference between an ID and an Identifier?

• An Identifier is a record type that represents real-world identifying information about a facility or practitioner, such as dates ofvalidity, jurisdiction, and the issuing authority.

• An ID is a machine-generated foreign key that identifies a record in a remote EHR system.

Appointment Type and Service TypeThe source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selectedby the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to CodeSet Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with.

Appointments booked by the call center agent result in a Service Appointment record being created along with a Healthcare PractitionerFacility Appointment junction between the Service Appointment and Healthcare Practitioner Facility. The Service Appointment statusfield is set to Booked upon record creation.

1286

Data ModelHealth Cloud Developer Guide

SEE ALSO:


User WorkflowIntelligent Appointment Management enables call center agents and care coordinators to select visit types, dates, and providers froma facility's EHR system to match a patient's needs.

Booking an appointment in Health Cloud involves these steps by the call center agent:

1. Select an appropriate “visit type” for the service the patient needs.

2. View a set of available time slots for the resulting practitioners, facilities, date range and visit type.

3. Discuss them with the patient and select a time slot.

4. Book an appointment for that time slot.

5. Handle any rejection of the booking request by the source system.

OperationsThe available operations include finding available appointment time slots, determining the status of an appointment slot, creating anappointment, getting a scheduled appointment, and canceling an appointment.

The URL for each operation is formed from two parts:

Protocol + DomainThis is defined in a Named Credential for appointment management.

1287

User WorkflowHealth Cloud Developer Guide

• The named credential is specified in Setup under Appointment Scheduling.

• The name of the credential must be Appointment_Management.

PathFor each operation this defines the URI path following the value obtained from the Named Credential.

• The default URI path for each operation can be overridden in Setup under Appointment Scheduling.

• The URIs must use the defaults shown below.

Note: The comments in these JSON samples are for documentation purposes only and are not meant to be valid JSON.

Find Available Time Slots for an AppointmentWhen a call center agent wants to schedule an appointment, the first step is to find the available time slots for providers who matchthe patient’s needs. The call center agent gathers selection criteria and then initiates a search to obtain the available slots for providerswho match the criteria.

Type: Controller

Verb: POST

Default URL Path: <base-url>/Slot/_search

Content-Type (Header): application/x-www-form-urlencoded

Your Base URL is configured in Setup > Appointment Scheduling.

All communications with the external system use the FHIR R4 standard.

Request Body

schedule:Schedule.actor:Practitioner.identifier=http://hl7.org/fhir/sid/us-npi|323,434,567,342,234,224,423&schedule:Schedule.actor:Location._id=epic|555,epic|123,allscripts|124,allscripts|221,cerner|222,cerner|223,athena|331,athena|332&schedule:Schedule.actor:Practitioner._id=epic|2342342,&start=ge2020-10-10&start=le2021-03-31&appointment-type=epic|ROUTINE,epic|ROUTINE,cerner|RTN,athena|REGULAR&service-type=epic|H999,cerner|E100,athena|C200,allscripts|A300&status=free&_include=Slot:schedule&_sort=start

Note: The request payload is sent as single line. It is listed here in separate lines for readability.

Multiple Source SystemsIf you are working with more than one source system, the Location._id gets the source system name and ID in pipe-delimited pairs,separated by commas, like this:

schedule:Schedule.actor:Location._id=epic|1404774,cerner|1476569

For a single source system, the Location._id is the ID only, like this:

schedule:Schedule.actor:Location._id=1404774,1476569

Response Codes200: Success

1288

OperationsHealth Cloud Developer Guide

400: Bad request

401: Unauthorized

5xx: Server error

Response Body

• To map slots, resource, resourceType, id, schedule, actor, start, and end are required in the FHIR response.

• Response is a map keyed by CareProvider.careProviderId to give all available slots within the start/end range for asingle practitioner+facility pair that can fulfill an appointment for the serviceTypeCode+appointmentTypeCode.

• If a practitioner+facility pair is not found in the source system, the provider is ignored and nothing is returned for thatcareProviderId. If a practitioner+facility pair does not have availability that matches the slot range and codes, thecareProviderId is returned without any slots.

• By default, the list of returned slots for each provider is sorted by date/time in ascending order.

• The sourceSlotId for a slot is the ID of a time slot in the source system for a care provider (eg. practitioner+facility) that canfulfill a specific serviceTypeCode+appointmentTypeCode. Given this ID during appointment booking, the source systemis able to identify the practitioner, facility, time slot, service type and appointment type.

{"resourceType": "Bundle","id": "","meta": {"lastUpdated":},"type": "searchset","total": n,"entry": [

"fullUrl" : "" ,"resource" : {

"resourceType" : "Slot","id" : "<String>","identifier" : [{ Identifier }],"serviceCategory" : [{ CodeableConcept }],"serviceType" : [{ CodeableConcept }],"specialty" : [{ CodeableConcept }],"appointmentType" : { CodeableConcept },"schedule" : { Reference(Schedule) }, //expects to get actor in this object"status" : "<code>","start" : "<instant>","end" : "<instant>","overbooked" : <boolean>,"comment" : "<string>"

}]

}

Error Response for Multiple Source Systems

{"resourceType": "Bundle",......."entry": [{

1289

"fullUrl": "http://hapi.fhir.org/baseR4/Slot/1939809","resource": {"resourceType": "Slot",.......},"search": {"mode": "match"}},{"fullUrl": "http://hapi.fhir.org/baseR4/Schedule/1939822","resource": {"resourceType": "Schedule","id": "1939822",.....},"search": {"mode": "include"}},{ //If the targeting system is FHIR R4, you get OperationOutcome resource as error.

Pass it back with one of the elements in "Bundle.entry" and "extension" to identify thetarget system.

"resourceType": "OperationOutcome",...."extension" : [{"url" :

"https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/_search33",

"value" : "cerner"}]"issue": [ {"severity": "error","code": "processing","diagnostics": "Invalid request: The FHIR endpoint on this server does not know how

to handle GET operation[Slot/_search33] with parameters [[_include, _pretty,schedule:Schedule.actor:Practitioner.identifier, appointment-type, service-type,schedule:Schedule.actor:Practitioner._id, schedule:Schedule.actor:Location._id]]"

}]}]}

Identifier

{"use" : "<code>", // usual | official | temp | secondary | old (If known)"type" : { CodeableConcept }, // OPTIONAL Description of identifier"system" : "<uri>", // The namespace for the identifier value"value" : "$lt;string>", // The value that is unique"period" : { Period }, // OPTIONAL Time period when id is/was valid for use"assigner" : { Reference(Organization) } // OPTIONAL Organization that issued id (maybe just text)}

1290

CodeableConcept

{// from Element: extension"coding" : [{ Coding }], // Code defined by a terminology system"text" : "<string>" // Plain text representation of the concept

}

Coding

{"system" : "<uri>", // Identity of the terminology system"version" : "<string>", // OPTIONAL Version of the system - if relevant"code" : "<code>", // Symbol in syntax defined by the system"display" : "<string>", // Representation defined by the system"userSelected" : <boolean> // OPTIONAL If this coding was chosen directly by the user

}

SEE ALSO:

FHIR Resource: Slot

Get Slot StatusType: Resource

Verb: GET

Default URL Path for Single-Source System: <base-url>/Slot/{sourceSlotId}

Default URL Path for Multi-Source System: <base-url>/Slot/{sourceSystem}/{sourceSlotId}

Where:

sourceSystem identifies the source system.

sourceSlotId is the ID of a time slot in the SourceSystem returned from the Find Available Slots operation.




401: Unauthorized

404: Slot not found

5xx: Server error

1291


https://www.hl7.org/fhir/slot.html

Response BodyTo map slots, resourceType, id, status, start, and end are required in the FHIR response.

{"resourceType" : "Slot","id" : "<string>""identifier" : [{ Identifier }],"serviceCategory" : [{ CodeableConcept }],"serviceType" : [{ CodeableConcept }],"specialty" : [{ CodeableConcept }],"appointmentType" : { CodeableConcept },"schedule" : { Reference(Schedule) },//As we are passing _include=Slot:schedule

in query, it should include the "Schedule" resource as one of the item in "entry" field.

"status" : "<code>","start" : "<instant>","end" : "<instant>","overbooked" : <boolean>,"comment" : "<string>"

}

The valid values for slotStatus are:

busy

free

busy-unavailable

busy-tentative

entered-in-error

SEE ALSO:

FHIR Resource: Slot

Create AppointmentWhen the patient selects an available slot, the call center agent books the appointment, which triggers a Get Slot Status RESTcall to the EHR system.

1. Health Cloud makes a Get Slot Status REST call.

An error is displayed to the call center agent if the slot is no longer available.

2. Health Cloud creates a Service Appointment record and a Healthcare Practitioner Facility Appointment junction between the ServiceAppointment and Healthcare Practitioner Facility.

3. Health Cloud makes a Create (Book) Appointment REST call.

• Service Appointment is updated with the response.

• An error is displayed to the call center agent if the booking is rejected.

Type: Resource

Verb: POST

Default URL Path: [base]/Appointment/[sourceSystem]

1292


https://www.hl7.org/fhir/slot.html

Request BodyThe resourceType, identifier, cancelationReason, serviceType, appointmentType, slot, comment,and status are the minimum required fields in the request that Health Cloud sends.

{"resourceType" : "Appointment","identifier" : [{ Identifier }], //See Note below"cancelationReason" : { CodeableConcept },"serviceType" : [{ CodeableConcept }], // From WorkType --> AppointmentType"appointmentType" : { CodeableConcept }, // From WorkType --> serviceType"slot" : [{ Reference(Slot) }], //Health Cloud sends the slot ID received from the

Find Slots API response."comment" : "<string>","participant" : [{"type" : [{ CodeableConcept }], //Health Cloud sends sourcePatientId

"actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson| Device|HealthcareService|Location) }, //Health Cloud sends the source practitioner

id"status" : "<code>",]

}

Note: For "identifier," Health Cloud sends 3 records:

• Salesforce unique appointment id

• Salesforce unique patient id

• Source system (for multi-source systems only)


400: Bad request

401: Unauthorized

404: Slot or patient not found

5xx: Server error

Response BodyTo map slots, resourceType, id, identifier, serviceType, appointmentType, slot, participant, actor,and status are required in the FHIR response.

{"resourceType" : "Appointment","id" : "<string>""identifier" : [{ Identifier }], //Source system identifier mandatory in the response

if there are multiple source systems

1293

"cancelationReason" : { CodeableConcept },"serviceCategory" : [{ CodeableConcept }],"serviceType" : [{ CodeableConcept }],"specialty" : [{ CodeableConcept }],"appointmentType" : { CodeableConcept },"reasonCode" : [{ CodeableConcept }],"reasonReference" : [{

Reference(Condition|Procedure|Observation|ImmunizationRecommendation) }],"priority" : "<unsignedInt>","description" : "<string>","supportingInformation" : [{ Reference(Any) }],"start" : "<instant>",// start of the appointment - ISO 8601 format"end" : "<instant>",// end of the appointment - ISO 8601 format"minutesDuration" : "<positiveInt>","slot" : [{ Reference(Slot) }],"created" : "<dateTime>","comment" : "<string>","patientInstruction" : "<string>","basedOn" : [{ Reference(ServiceRequest) }],"participant" : [{"type" : [{ CodeableConcept }],//Patient EHR id"actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson |

Device|HealthcareService|Location) }, //Practitioner EHR id"required" : "<code>","status" : "<code>", // Mandatory in the response"period" : { Period }}],"requestedPeriod" : [{ Period }]

}

Note: "Cancelation" is spelled with one L, per the FHIR R4 specification.

The valid values for status are:

proposed

pending

booked

arrived

fulfilled

cancelled

noshow

entered-in-error

checked-in

waitlist

If the request cannot be processed for any reason (e.g. it’s unsupported, there’s a timeout, etc.) status is returned as proposed.

SEE ALSO:

FHIR Resource: Appointment

1294


https://www.hl7.org/fhir/Appointment.html

Cancel AppointmentType: Controller

Verb: POST

Default URL Path for Single-Source System: <base-url>/Appointment/{sourceAppointmentId}

Default URL Path for Multi-Source System:* <base-url>/Appointment/{sourceSystem}/{sourceAppointmentId}

Where:

sourceSystem identifies the source system.

sourceAppointmentId is the ID of an appointment in the source system.



Request Body

{"resourceType": "Appointment","id": "1839594","status": "cancelled","cancelationReason" : {"coding" : [{

"system" : "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason",

"code" : "pat-mv"}]}}


401: Unauthorized

404: Appointment not found

5xx: Server error

To map slots, resourceType, id, identifier, serviceType, appointmentType, slot, participant, actor,and status are required in the FHIR response.

{"resourceType" : "Appointment","id" : "<string>""identifier" : [{ Identifier }], //Source system identifier mandatory in the response

if there are multiple source systems"cancelationReason" : { CodeableConcept },"serviceCategory" : [{ CodeableConcept }],"serviceType" : [{ CodeableConcept }],"specialty" : [{ CodeableConcept }],"appointmentType" : { CodeableConcept },

1295

"reasonCode" : [{ CodeableConcept }],"reasonReference" : [{

Reference(Condition|Procedure|Observation|ImmunizationRecommendation) }],"priority" : "<unsignedInt>","description" : "<string>","supportingInformation" : [{ Reference(Any) }],"start" : "<instant>",// start of the appointment - ISO 8601 format"end" : "<instant>",// end of the appointment - ISO 8601 format"minutesDuration" : "<positiveInt>","slot" : [{ Reference(Slot) }],"created" : "<dateTime>","comment" : "<string>","patientInstruction" : "<string>","basedOn" : [{ Reference(ServiceRequest) }],"participant" : [{"type" : [{ CodeableConcept }],//Patient EHR id"actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson |

Device|HealthcareService|Location) }, //Practitioner EHR id"required" : "<code>","status" : "<code>", // Mandatory in the response"period" : { Period }}],"requestedPeriod" : [{ Period }]

}

Note: "Cancelation" is spelled with one L, per the FHIR R4 specification.

The valid values for status are:

proposed

pending

booked

arrived

fulfilled

cancelled

noshow

entered-in-error

checked-in

waitlist

If the request cannot be processed for any reason (e.g. it’s unsupported, there’s a timeout, etc.) status is returned as proposed.

SEE ALSO:

FHIR Resource: Appointment


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.

1296

Working With Electronic Health RecordsHealth Cloud Developer Guide

https://www.hl7.org/fhir/Appointment.html

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.

Mapping FHIR v4.0 to Salesforce Standard Objects

The Fast Health Interoperability Resources (FHIR) standard defined by Health Level Seven (HL7) enables healthcare systems to workseamlessly together enhancing their interoperability. Health Cloud’s Clinical Data Model is built to align with HL7’s FHIR R4. However,because of the way the Salesforce platform works, the Salesforce implementation of FHIR R4 isn’t identical to how it’s defined byHL7. Here’s how various FHIR resources map to fields in different standard objects in Salesforce.

Store HL7 v2.3 Messages in Salesforce Standard Objects

Like the Fast Health Interoperability Resources (FHIR) standard defined by Health Level Seven (HL7), HL7 v2.3 is also a databaseframework defined by HL7 to facilitate interoperability between electronic healthcare systems. Because Health Cloud’s Clinical DataModel was built to align with FHIR v4.0, it is also compatible with its predecessor HL7 v2.3. However, because of the way the Salesforceplatform works, the Salesforce implementation varies from the HL7 recommendations in certain cases such as the data types thatare used.

Storing HL7 Admission, Discharge, Transfer (ADT) Data in the Packaged EHR Data Model

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 in the packaged EHR data model. Elements are listed here in order of sequence number in theHL7 standard.

Storing HL7 Clinical Document Architecture (CDA) Data in the Packaged EHR Data Model

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 the Packaged EHR Data Model

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).

Storing FHIR Data in the Packaged EHR Data Model

The FHIR (Fast Healthcare Interoperability Resources) specification is offered as a consistent, easy to implement, and rigorousmechanism for exchanging data between healthcare applications. It can be used as a stand-alone data exchange standard or incombination with other standards, such as HL7.

SEE ALSO:


Mapping FHIR v4.0 to Salesforce Standard ObjectsThe Fast Health Interoperability Resources (FHIR) standard defined by Health Level Seven (HL7) enables healthcare systems to workseamlessly together enhancing their interoperability. Health Cloud’s Clinical Data Model is built to align with HL7’s FHIR R4. However,because of the way the Salesforce platform works, the Salesforce implementation of FHIR R4 isn’t identical to how it’s defined by HL7.Here’s how various FHIR resources map to fields in different standard objects in Salesforce.

1297

Mapping FHIR v4.0 to Salesforce Standard ObjectsHealth Cloud Developer Guide

Considerations for Integration

The Salesforce implementation of FHIR resources differs from the FHIR specification. Built on the core Salesforce platform, theFHIR-aligned clinical data model comes with field mappings that help you integrate with the FHIR R4 specification.

Address

The Address FHIR resource maps to the ContactPointAddress object in Salesforce.

AllergyIntolerance

The allergyIntolerance FHIR resource maps to the AllergyIntolerance and PatientHealthReactionobjects in Salesforce.

Annotation

The Annotation FHIR resource maps to the AuthorNote object in Salesforce.

Attachment

The Attachment FHIR resource maps to the Attachment object in Salesforce.

CodeableConcept

The CodeableConcept FHIR resource maps to the CodeSetBundleBundle object in Salesforce.

Coding

The Coding FHIR resource maps to the CodeSet object in Salesforce.

Condition

The Condition FHIR resource maps to the HealthCondition object in Salesforce.

ContactPoint

The ContactPoint FHIR resource maps to the ContactPointPhone object in Salesforce.

Device

The Device FHIR resource maps to the Asset and CareRegisteredDevice objects in Salesforce.

DiagnosticReport

The diagnosticReport FHIR resource maps to the DiagnosticSummary object in Salesforce.

DocumentReference

The DocumentReference FHIR resource maps to the DiagnosticSummary and DiagnosticSummaryDetailobjects in Salesforce.

Dosage

The Dosage FHIR resource maps to the PatientMedicationDosage object in Salesforce.

Encounter

The Encounter FHIR resource maps to the ClinicalEncounter, ClinicalEncounterDiagnosis, ClinicalEncounterFacility, ClinicalEncounterIdentifier, ClinicalEncounterProvider, ClinicalEncounterReason, and ClinicalEncounterSvcRequest objects in Salesforce.

Flag

The Flag FHIR resource maps to the ClinicalAlert object in Salesforce.

HumanName

The HumanName FHIR resource maps to the PersonName object in Salesforce.

Identifier

The Identifier FHIR resource maps to the Identifier object in Salesforce.

1298


Immunization

The Immunization FHIR resource maps to the PatientImmunization and PatientHealthReaction objects inSalesforce.

Location

The Location FHIR resource maps to the HealthcareFacility and Location objects in Salesforce.

Medication

The medication FHIR resource maps to the Medication object in Salesforce.

MedicationRequest

The MedicationRequest FHIR resource maps to the MedicationRequest object in Salesforce.

MedicationStatement

The medicationStatement FHIR resource maps to the MedicationStatement object in Salesforce.

Observation

The observation FHIR resource maps to the CareObservation and CareObservationComponent objects inSalesforce.

Organization

The Organization FHIR resource maps primarily to the Account object in Salesforce.

Patient

The Patient FHIR resource maps to the Account and Contact objects in Salesforce. Patients in Health Cloud are modeledusing Person Accounts.

Practitioner

The Practitioner FHIR resource maps to the HealthcareProvider object and person accounts in Salesforce.

PractitionerRole

The practitionerRole FHIR resource maps to the HealthcarePractitionerFacility andCareProviderFacilitySpecialty objects in Salesforce.

Procedure

The procedure FHIR resource maps to the PatientMedicalProcedure and PatientMedicalProcedureDetailobjects in Salesforce.

RelatedPerson

The relatedPerson FHIR resource maps to the Account and Contact objects in Salesforce, and is connected to theperson that person’s related to using the ContactContactRelation__c object.

ServiceRequest

The serviceRequest FHIR resource maps to the ClinicalServiceRequest and ClinicalServiceRequestDetail objects in Salesforce.

Timing

The Timing FHIR resource maps to the ActivityTiming object in Salesforce.

SEE ALSO:

Clinical Data Model


1299


Considerations for Integration

EDITIONS

Available in: Enterprise andUnlimited Editions.

The Salesforce implementation of FHIR resources differs from the FHIR specification. Built on thecore Salesforce platform, the FHIR-aligned clinical data model comes with field mappings that helpyou integrate with the FHIR R4 specification.

A middleware integration solution is required to convert messages from HL7 and FHIR-basedsystems to the fields and objects in Health Cloud. But before you integrate, here are a few thingsto remember:

• The HumanName FHIR resource maps to the PersonName field in Salesforce. The FHIR resource stores names in the FirstName,MiddleName, and LastName fields, while Salesforce’s clinical data model stores information in the FirstName, LastName,and FullName fields. LastName can store the family name and any middle name, or any consequent names after the firstname. FullName stores the combination of the patient’s first and last name. The ParentRecordId field relates this nameto the person by referencing the Account or Contact record of the person’s Person Account.

• If a coding or codeable concept in FHIR has a value set with conceptually simple values, then Salesforce uses a picklist. For example,the FHIR identifier.use resource, which is a code data type, maps to the Identifier.IdUsageType field of theIdentifier object, which is a picklist in Salesforce.

• For resources that FHIR defines as code data types, Salesforce uses a string. For example, the FHIR coding.code resource, whichis code data type, maps to the CodeSet.Code field of the CodeSet object, which is a string in Salesforce.

• For two resources that FHIR defines as URI, Salesforce uses a string. These two resources are the Identifier.SourceSystemfield and the CodeSet.SourceSystem field. The FHIR identifier.system resource, which is a URI, maps to theIdentifier.SourceSystem field of the Identifier object, which is a string in Salesforce. Similarly, the FHIR coding.systemresource, which is a URI, maps to the CodeSet.SourceSystem field of the CodeSet object, which is also a string in Salesforce.

• According to FHIR, CodeableConcept has a zero-to-many coding resource. Because Salesforce doesn’t support zero-to-manyreferences, Code Set Bundle flattens this zero-to-many reference to 15 zero-to-one Code Set references. The Code Set referencesare CodeSet1Id, CodeSet2Id, CodeSet3Id, and so on, until CodeSet15Id.

Salesforce doesn’t have data types for periods, quantities, ranges, and ratios. Instead, resources that need these data types are flattenedto sets of two or three fields in their implementation.

• Period fields are flattened into a set of start date and end date fields. For example, allergyIntolerance.onset.onsetPeriod in the FHIR specification maps to the AllergyIntolerance.OnsetStartDateTime and AllergyIntolerance.OnsetEndDateTime fields in Salesforce.

• Quantity fields are flattened into a combination of a numeric quantity and unit fields. The unit field indicates the unit of measure.The quantity field, which is a double field, represents the numeric value. For example, medicationRequest.dispenseRequest.initialFill.quantity is flattened into a set of quantity and unit fields.

• Range fields are flattened into a set of upper and lower limits and unit fields. To reference the unit, we have a Lookup to theUnitofMeasure object. For example, procedure.performed.performedRange in the FHIR specification maps to thePatientMedicalProcedure.PerformedAtAgeLowerLimit, PatientMedicalProcedure.PerformedAtAgeUpperLimit, and PatientMedicalProcedure.PerformedAgeRangeUnit fields in Salesforce.

• Ratio fields are flattened into a set of numerator and denominator fields. If the ratio refers to a quantity, then a unit field is added.To reference the unit, we have a Lookup to the UnitofMeasure object. For example, serviceRequest.quantity.quantityRatio in the FHIR specification maps to the ClinicalServiceRequest.QuantityNumerator, ClinicalServiceRequest.QuantityDenominator, and ClinicalServiceRequest.QuantityNumeratorUnitId fields inSalesforce.

AddressThe Address FHIR resource maps to the ContactPointAddress object in Salesforce.

1300


FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Address map to the fields in Salesforce.

Table 1: Address - Salesforce

NotesSalesforceCardinality

TypeSalesforce FieldAddressResource

FHIR defines ContactPointAddress.useas a code set. However, the Salesforce

0.1PicklistContactPointAddress.UsageType

use

implementation of ContactPointAddress.ContentType is a picklist.

Not supportedN/AN/AN/Atype

Not supportedN/AN/AN/Atext

While FHIR defines address.line aszero-many, Salesforce supports only one string

0.1StringContactPointAddress.Street

line

for each record. If you have multiple lines, it’srecommended to merge them into a single stringbefore passing it to Salesforce.

N/A0.1StringContactPointAddress.City

city

Not supportedN/AN/AN/Adistrict

N/A0.1StringContactPointAddress.State

state

N/A0.1StringContactPointAddress.PostalCode

postalCode

N/A0.1StringContactPointAddress.Country

country

Because Salesforce doesn’t support a native perioddata type, the Salesforce implementation flattens

0.1DateContactPointAddress.ActiveFromDate

period

address.period to a set of from and todates.0.1DateContactPointAddress

.ActiveToDate

AllergyIntoleranceThe allergyIntolerance FHIR resource maps to the AllergyIntolerance and PatientHealthReaction objectsin Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for allergyIntolerance map to the fields in Salesforce.

1301


https://www.hl7.org/fhir/datatypes.html#Address

https://www.hl7.org/fhir/allergyintolerance.html

Table 2: allergyIntolerance - Salesforce


TypeSalesforce FieldAllergyIntoleranceResource

The identifier information for an allergyintolerance is represented as Identifier

0.MObjectIdentifieridentifier

records that reference the AllergyIntolerancerecord using their Identifier.ParentRecordId field.

While FHIR defines allergyIntolerance.clinicalStatus as a code set bundle, the

0.1PicklistAllergyIntolerance.Status

clinicalStatus

Salesforce implementation of AllergyIntolerance.Status is picklist.

While FHIR defines allergyIntolerance.verificationStatus as a code set

0.1PicklistAllergyIntolerance.VerificationStatus

verificationStatus

bundle, the Salesforce implementation ofAllergyIntolerance.VerificationStatus is picklist.

While FHIR defines allergyIntolerance.category as a code set bundle, the

0.1PicklistAllergyIntolerance.Type

type

Salesforce implementation of AllergyIntolerance.Categories is a picklist.

While FHIR defines allergyIntolerance.category as a code set bundle, the

0.MMulti-SelectPicklist

AllergyIntolerance.Category

category

Salesforce implementation of AllergyIntolerance.Category is a picklist.

While FHIR defines allergyIntolerance.criticality as a code set bundle, the

0.1PicklistAllergyIntolerance.Severity

criticality

Salesforce implementation of AllergyIntolerance.Severity is picklist.

N/A1.1Lookup:CodeSetBundle

AllergyIntolerance.CodeId

code

N/A1.1Master-DetailReference:Account

AllergyIntolerance.PatientId

patient

N/A0.1Lookup:ClinicalEncounter

AllergyIntolerance.ClinicalEncounterId

encounter

AllergyIntolerance.OnsetStartDateTime is used as both the equivalent of

0.1DateTimeAllergyIntolerance.OnsetStartDateTime

onset.onsetDateTime allergyIntolerance.onset.onset

DateTime and the start date of allergyIntolerance.onset.onsetPeriod

1302




Not supportedN/AN/AN/Aonset.onsetAge

Since Salesforce doesn’t natively support theperiod data type, allergyIntolerance

0.1DateTimeAllergyIntolerance.OnsetStartDateTime

onset.onsetPeriod .onset.onsetPeriod is flattened into a

set of start date and end date fields. The start date0.1DateTimeAllergyIntolerance.OnsetEndDateTime field is also used as the equivalent of allergy

Intolerance.onset.onsetDateTime

Not supportedN/AN/AN/Aonset.onsetRange

Not supportedN/AN/AN/Aonset.onsetString

N/A0.1DateTimeAllergyIntolerance.RecordCreationDateTime

recordedDate

N/A0.1PolymorphicLookup:

AllergyIntolerance.RecordCreatorId

recorder

Account,Healthcare.Provider


AllergyIntolerance.AssertionSourceId

asserter

Account,Healthcare.Provider

N/A0.1DateTimeAllergyIntolerance.LastOccurenceDateTime

lastOccurrence

Not supportedN/AN/AN/Anote

The reaction information for an allergy intoleranceis represented as PatientHealth

0.MObjectPatientHealthReactionreaction

Reaction records that reference the AllergyIntolerance record using their PatientHealthReaction.ParentId field.


PatientHealthReaction.CausativeSubstanceId

reaction.substance

1303




While FHIR defines allergyIntolerance.reaction.manifestation as a

0.1Lookup:CodeSetBundle

PatientHealthReaction.ManifestedSymptomId

reaction.manifestation

one-to-many resource, the Salesforceimplementation of PatientHealthReaction.ManifestedSymptomId iszero-to-one.

N/A0.1StringPatientHealthReaction.Details

reaction.description

N/A0.1DateTimePatientHealthReaction.ReactionDateTime

reaction.onset

While FHIR defines allergyIntolerance.reaction.severity as a code set bundle,

0.1PicklistPatientHealthReaction.Severity

reaction.severity

the Salesforce implementation of PatientHealthReaction.Severity is a picklist.


PatientHealthReaction.ExposureRouteId

reaction.exposureRoute

Not supportedN/AN/AN/Areaction.note

SEE ALSO:

AllergyIntolerance

AnnotationThe Annotation FHIR resource maps to the AuthorNote object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Annotation map to the fields in Salesforce.

Table 3: Annotation - Salesforce


TypeSalesforce FieldAnnotationResource

N/A0.1Lookup:Account,

AuthorNote.AuthorIdauthor.authorReference Contact,

HealthcareProvider

1304


https://www.hl7.org/fhir/datatypes.html#Annotation


TypeSalesforce FieldAnnotationResource

N/A0.1StringAuthorNote.AuthorNameauthor.authorString

N/A0.1DateTimeAuthorNote.AuthoredDateTime

time

N/A0.1DoubleActivityTiming.NoteText

text

AttachmentThe Attachment FHIR resource maps to the Attachment object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Attachment map to the fields in Salesforce.

Table 4: Attachment - Salesforce


TypeSalesforce FieldAttachmentResource

FHIR defines Attachment.use as a code set.However, the Salesforce implementation ofAttachment.ContentType is a string.

0.1StringAttachment.ContentType

contentType

FHIR defines Attachment.use as a code set.However, the Salesforce implementation of

0.1StringDiagnosticSummary.AttachmentLanguage

language

DiagnosticSummary.AttachmentLanguage is a string.

N/A0.1Base64Attachment.Bodydata

Not supportedN/AN/AN/Aurl

N/A0.1DoubleAttachment.BodyLengthsize

Not supportedN/AN/AN/Ahash

N/A0.1StringAttachment.Nametitle

N/A0.1DateTimeAttachment.CreatedDate

Creation

CodeableConceptThe CodeableConcept FHIR resource maps to the CodeSetBundleBundle object in Salesforce.

1305


https://www.hl7.org/fhir/datatypes.html#Attachment

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for CodeableConcept map to the fields in Salesforce.

Table 5: CodeableConcept - Salesforce


TypeSalesforce FieldCodeableConceptResource

FHIR defines CodeableConcept.codingas a zero-to-many reference. However, the

0.1Lookup:CodeSet

CodeSetBundle.CodeSet1Id,CodeSet

coding

Salesforce implementation has flattened this intofifteen zero-to-one references to CodeSetBundle.CodeSet2Id,

CodeSetBundle.CodeSet3Id,…and CodeSetBundle.CodeSet15Id

N/A0.1StringCodeSetBundle.Nametext

SEE ALSO:

CodeSetBundle

CodingThe Coding FHIR resource maps to the CodeSet object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Coding map to the fields in Salesforce.

Table 6: Coding - Salesforce


TypeSalesforce FieldCodingResource

FHIR defines coding.system as a URI.However, the Salesforce implementation of

0.1StringCodeSet.SourceSystemsystem

CodeSet.SourceSystem is a stringbecause Salesforce doesn’t support the URI datatype.

N/A0.1StringCodeSet.SystemVersionversion

FHIR defines coding.code as a code datatype. However, the Salesforce implementation of

0.1StringCodeSet.Codecode

CodeSet.Code is a string because Salesforcedoesn’t support the Code data type.

N/A0.1StringCodeSet.Namedisplay

1306


https://www.hl7.org/fhir/datatypes.html#CodeableConcept

https://www.hl7.org/fhir/datatypes.html#Coding


TypeSalesforce FieldCodingResource

N/A0.1BooleanCodeSet.IsPrimaryuserSelected

SEE ALSO:

CodeSet

ConditionThe Condition FHIR resource maps to the HealthCondition object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Condition map to the fields in Salesforce.

Table 7: Condition - Salesforce


TypeSalesforce FieldConditionResource

The identifier information for a health conditionis represented as Identifier records that


reference the health condition record using theirIdentifier.ParentRecordId field.

While FHIR defines Condition.clinicalStatus as a code set bundle, the Salesforce

0.1PicklistHealthCondition.ConditionStatus

clinicalStatus

implementation of HealthCondition.ConditionStatus is picklist.

While FHIR defines condition.verificationStatus as a code set

0.1PicklistHealthCondition.DiagnosticStatus

verificationStatus

bundle, the Salesforce implementation ofHealthCondition.DiagnosticStatus is picklist.

While FHIR defines Condition.categoryas a zero-to-many code set bundle, the Salesforce

0.1PicklistHealthCondition.Typecategory

implementation of HealthCondition.Categories is a zero-to-one picklist.

While FHIR defines condition.severityas a code set bundle, the Salesforce

0.1PicklistHealthCondition.Severity

severity

implementation of HealthCondition.Severity is picklist.

While FHIR defines condition.code as azero-to-one resource, the Salesforceimplementation is a one-to-one field.


HealthCondition.ConditionCodeId

code

1307


https://www.hl7.org/fhir/condition.html



Use this field if only one bodySite value is requiredfor the condition.


HealthCondition.SiteId

bodySite

Use the child object to specify BodySite values fora condition if multiple bodySite values arereuqired.

0.MObjectHealthConditionDetail

The Salesforce implementation of Condition.subject doesn’t support groups.

1.1Master-DetailReference:Account

HealthCondition.PatientId

subject

N/A0.1Lookup:Encounter

HealthCondition.ClinicalEncounterId

encounter

HealthCondition.OnsetStartDateTime is used as both the equivalent of

0.1DateTimeHealthCondition.OnsetStartDateTime

onset.onsetDateTime condition.onset.onsetDateTime

and the start date of condition.onset.onsetPeriod

Not supportedN/AN/AN/Aonset.onsetAge

Since Salesforce doesn’t natively support theperiod data type, condition.onset

0.1DateTimeHealthCondition.OnsetStartDateTime

onset.onsetPeriod .onsetPeriod is flattened into a set of start

date and end date fields. The start date field is0.1DateTimeHealthCondition.OnsetEndDateTime also used as the equivalent of condition

.onset.onsetDateTime

Not supportedN/AN/AN/Aonset.onsetRange

Not supportedN/AN/AN/Aonset.onsetString

HealthCondition.AbatementStartDateTime is used as both the equivalent of

0.1DateTimeHealthCondition.AbatementStartDateTime

abatement.abatementDateTime condition.abatement.abatement

DateTime and the start date of condition.abatement.abatementPeriod

Not supportedN/AN/AN/Aabatement.abatementAge

1308




Since Salesforce doesn’t natively support theperiod data type, condition.abatement

0.1DateTimeHealthCondition.AbatementStartDateTime

abatement.abatementPeriod .abatementPeriod is flattened into a set

of start date and end date fields. The start date0.1DateTimeHealthCondition

.AbatementEndDateTimefield is also used as the equivalent ofcondition.abatement.abatementDateTime

Not supportedN/AN/AN/Aabatement.abatementRange

Not supportedN/AN/AN/Aabatement.abatementString

N/A0.1DateTimeHealthCondition.RecordCreationDateTime

recordedDate


HealthCondition.RecordCreatorId

recorder

Account,HealthcareProvider


HealthCondition.AssertionSourceId

asserter


The child resources of condition.stage iscombined into a single code set bundle reference


HealthCondition.StageId

stage

field. While FHIR defines condition.stageas a zero-to-many resource, the Salesforceimplementation is a zero-to-one field.

Not supportedN/AN/AN/Aevidence

The notes for a health condition is represented asAuthorNote records that reference the health

0.MObjectAuthorNotenote

condition record using their AuthorNote.ParentRecordId field.

SEE ALSO:

HealthCondition

1309


ContactPointThe ContactPoint FHIR resource maps to the ContactPointPhone object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for ContactPoint map to the fields in Salesforce.

Table 8: ContactPoint - Salesforce


TypeSalesforce FieldContactPointResource

While FHIR defines contactPoint.systemas a reference to a code set bundle, the Salesforceimplementation is a picklist.

0.1PicklistContactPointPhone.PhoneType

system

While FHIR defines contactPoint.valueas a string, ContactPointPhone.TelephoneNumber is a phone data type.

0.1PhoneContactPointPhone.TelephoneNumber

value

N/A0.1StringContactPointPhone.AreaCode

N/A0.1StringContactPointPhone.ExtensionNumber

While FHIR defines contactPoint.valueas a string, Contact.Email is an email datatype.

0.1EmailContact.Email

While FHIR defines contactPoint.use asa code, the Salesforce implementation is a picklist.

0.1PicklistContactPointPhone.UsageType

use

0.1PicklistContactPointEmail.UsageType

N/A0.1DoubleContactPointPhone.PreferenceRank

rank

N/A0.1DoubleContactPointEmail.PreferenceRank

Because Salesforce doesn’t support a native perioddata type, the Salesforce implementation of

0.1DateContactPointPhone.ActiveFromDate

period

contactPoint.period is flattened to aset of from and to dates.0.1DateContactPointPhone

.ActiveToDate

Because Salesforce doesn’t support a nativeperiod data type, the Salesforce implementation

0.1DateContactPointEmail.ActiveFromDate

of contactPoint.period is flattened toa set of from and to dates.0.1DateContactPointEmail

.ActiveToDate

1310


https://www.hl7.org/fhir/datatypes.html#ContactPoint

DeviceThe Device FHIR resource maps to the Asset and CareRegisteredDevice objects in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Device map to the fields in Salesforce.

Table 9: Patient - Salesforce


TypeSalesforce FieldDeviceResource

The identifier information for a device isrepresented as Identifier records that


reference the CareRegisteredDevice record usingtheir Identifier.ParentRecordId field.

While FHIR defines uidCarrier.DeviceIdentifier as a zero-to-many value, the

0.3ExternalLookup


uidCarrier.DeviceIdentifier Salesforce implementation supports a maximum

of three values using three fields.ExternalLookup


ExternalLookup


While FHIR defines uidCarrier.Issuer asa zero-to-many value, the Salesforce

0.3URLCareRegisteredDevice.UniqueDeviceId1Issuer

uidCarrier.Issuer

implementation supports a maximum of threevalues using three fields.

URLCareRegisteredDevice.UniqueDeviceId2Issuer

URLCareRegisteredDevice.UniqueDeviceId3Issuer

Not supportedN/AN/AN/AuidCarrier.jurisdiction

Not supportedN/AN/AN/AuidCarrier.carrierAIDC

Not supportedN/AN/AN/AuidCarrier.arrierHRF

Not supportedN/AN/AN/AuidCarrier.entryType

While FHIR defines device.status as code,the Salesforce implementation is a picklist.

0.1PicklistAsset.Statusstatus

1311


https://www.hl7.org/fhir/device.html



While FHIR defines device.statusReasonas a zero-to-many codeable concept, the

0.1PicklistAsset.StatusReasonstatusReason

Salesforce implementation is a zero-to-one picklist.

N/A0.1StringAsset.UuiddistinctIdentifier

While FHIR defines device.manufactureras string, the Salesforce implementation is alookup to Account (Organization).

0.1Lookup:Account

Asset.AssetProviderBymanufacturer

While FHIR definesdevice.manufactureDate as DateTime,

0.1DateAsset.ManufactureDatemanufactureDate

the Salesforce implementation is a of the datatype Date.

While FHIR definesdevice.expirationDate as DateTime,

0.1DateAsset.UsageEndDateexpirationDate

the Salesforce implementation is a of the datatype Date.

Not supportedN/AN/AN/AlotNumber

N/A0.1StringAsset.SerialNumberserialNumber

While FHIR defines device.deviceName asa zero-to-many resource, the Salesforceimplementation is zero-to-one.

0.1StringCareRegisteredDevice.Name

deviceName.name


Lookup: CareRegisteredDevice.NameType

deviceName.type

N/A0.1StringAsset.ProductCodemodelNumber

Not supportedN/AN/AN/ApartNumber

While FHIR defines device.type as acodeable concept value, the Salesforceimplementation is a code set.

0.1Lookup: CodeSet

CareRegisteredDevice.DeviceTypeId

type

Not supportedN/AN/AN/Aspecialization

Not supportedN/AN/AN/Aversion

Not supportedN/AN/AN/Aproperty

N/A0.1Lookup:Account

CareRegisteredDevice.PatientId

patient

1312





Asset.AssetServicedByowner

While FHIR defines device.contact as acontact point value, the Salesforceimplementation is a string.

0.1StringCareRegisteredDevice.SupportContactDetail

contact

N/AN/AN/AN/Alocation

N/A0.1URLAsset.Product2Id.DisplayUrl

url

Not supportedN/AN/AN/Aaccount

The notes for a device are represented asAuthorNote records that reference the

0.MObjectAuthorNotenote.

CareRegisteredDevice record using theirAuthorNote.ParentRecordId field.

While FHIR defines device.safety as acodeable concept, the Salesforce implementationis a string field.

0.1StringCareRegisteredDevice.SafetyInformation

safety

N/A0.1Lookup AssetAsset.ParentIdparent

DiagnosticReportThe diagnosticReport FHIR resource maps to the DiagnosticSummary object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for diagnosticReport map to the fields in Salesforce.

Table 10: diagnosticReport - Salesforce


TypeSalesforce FieldDiagnosticReportResource

The identifier information for a diagnosticsummary is represented as Identifier


records that reference the DiagnosticSummary record using their Identifier.ParentRecordId field.

While FHIR defines diagnosticReport.basedOn as a zero-to-many reference, the

0.1PolymorphicLookup:Medication

DiagnosticSummary.BasedOnId

basedOn

Salesforce implementation is a zero-to-one textfield.Statement,

Clinical

1313


https://www.hl7.org/fhir/diagnosticreport.html



Only references to medication statement andclinical service request records are supported.

ServiceRequest

While FHIR defines diagnosticReport.status as a reference to code set bundle, theSalesforce implementation is a picklist.

1.1PicklistDiagnosticSummary.Status

status

While FHIR defines diagnosticReport.category as a reference to code set bundle,


DiagnosticSummary.Category

category

the Salesforce implementation is a multi-selectpicklist.


DiagnosticSummary.CodeId

code

The Salesforce implementation of diagnosticReport.subject supports references toonly patients.

1.1Master-Detail:Account

DiagnosticSummary.PatientId

subject


DiagnosticSummary.ClinicalEncounterId

encounter

N/A0.1DateTimeDiagnosticSummary.EffectiveStartDateTime

effective.effectiveDateTime

Because Salesforce doesn’t support a native perioddata type, the diagnosticReport

0.1DateTimeDiagnosticSummary.EffectiveStartDateTime

effective.effectivePeriod .effective.effectivePeriod field is

flattened into a set of start date and end datefields.0.1DateTimeDiagnosticSummary

.EffectiveEndDateTime

Because Salesforce doesn’t support a nativeinstant data type, the diagnosticReport

0.1DateTimeDiagnosticSummary.IssuedDateTime

issued

.issued FHIR resource is implemented as adate time field in Salesforce.

While FHIR defines diagnosticReport.performer as a zero-to-many resource, the

0.1Lookup: CarePerformer

DiagnosticSummary.IssuedById

performer

Salesforce implementation is a zero-to-onereference to CarePerformer.

While FHIR defines diagnosticReport.resultsInterpreter as a zero-to-many


DiagnosticSummary.InterpretedById

resultsInterpreter

resource, the Salesforce implementation is azero-to-one reference to CarePerformer.

1314




Not supportedN/AN/AN/Aspecimen

While FHIR defines diagnosticReport.result as a zero-to-many resource, the

0.1Lookup: CareObservation

DiagnosticSummary.CareObservationId

result

Salesforce implementation is a zero-to-onereference to CareObservation.

Not supportedN/AN/AN/AimagingStudy

The zero-to-many diagnosticReport.media resource is flattened to five separate

0.1StringDiagnosticSummary.ImageComments1

media.comment

zero-to-one text fields and five separateStringDiagnosticSummary

.ImageComments2zero-to-one URL fields in the Salesforceimplementation.




0.1URLDiagnosticSummary.ImageUrl1

media.link





N/A0.1StringDiagnosticSummary.Summary

conclusion

While FHIR defines diagnosticReport.conclusionCode as a zero-to-many


DiagnosticSummary.SummaryCodeId

conclusionCode

resource, the Salesforce implementation is azero-to-one reference.

Not supportedN/AN/AN/ApresentedForm

1315


Sample Record DiagramHere's a diagram that shows an example of how this resource is represented in Salesforce.

SEE ALSO:

DiagnosticSummary

DocumentReferenceThe DocumentReference FHIR resource maps to the DiagnosticSummary and DiagnosticSummaryDetail objectsin Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for DocumentReference map to the fields in Salesforce.



TypeSalesforce FieldDocumentReferenceResource

Not supportedN/AN/AN/AMasterIdentifier

The identifier information fora documentReference is


represented asIdentifier records thatreference theDiagnosticSummary recordusing their Identifier.ParentRecordId field.

1316


https://www.hl7.org/fhir/documentreference.html



While FHIR definesdocument

1.1PicklistDiagnosticSummary.Statusstatus

Reference.status asa code, the Salesforceimplementation is a picklist.


0.1PicklistDiagnosticSummary.DocumentStage

docStatus

Reference.docStatusas a code, the Salesforceimplementation is a picklist.


DiagnosticSummary.DocumentTypeCodeId

type

While FHIR definesdocumentReference.category


DiagnosticSummary.Categorycategory

as a codeable concept, theSalesforce implementation isa picklist.

The Salesforceimplementation supports only

1.1Maste-Detail:Account

DiagnosticSummary.PatientIdsubject

patients as subjects of adocument reference.

N/A0.1DateTimeDiagnosticSummary.IssuedDateTime

date

The author information of adocument reference is

0.MObjectDiagnosticSummaryDetailauthor

represented using theDiagnosticSummaryDetailchild object. TheDetailRecordId fieldreferences the author, theDetailTypefield specifiesthe child record type asAuthor, and theDiagnosticSummaryIdfield references the parentDiagnosticSummaryrecord that represents thedocument reference.

The Salesforceimplementation doesn’t

0.1Lookup:Healthcare

DiagnosticSummary.AuthenticatorId

authenticator

directly supportProvider,

1317




Account,Contact,User

practitionerRole orHealthcarePractitionerFacilityrecords as authenticators.


DiagnosticSummary.CustodianId

custodian

The related documentinformation of a document

0.MPicklistDiagnosticSummaryDetail.DocumentRelationType

relatesTo.code

reference is represented using0.MLookup:

DiagnosticSummary

DiagnosticSummaryDetail.DetailRecord

relatesTo.target theDiagnosticSummaryDetailchild object. TheDetailRecordId fieldreferences the relateddocument, the DocumentRelationType fieldspecifies the type of relation,the DetailTypefieldspecifies the child record typeas Related Document, and theDiagnosticSummaryIdfield references the parentDiagnosticSummaryrecord that represents thedocument reference.


0.1StringDiagnosticSummary.Summarydescription

Reference.statusReason as a zero-to-manycodeable concept, theSalesforce implementation isa zero-to-one picklist.


DiagnosticSummary.DocumentSecurityCode

securityLabel

While FHIR definesdocumentReference.Content

0.1Lookup:Attachment

DiagnosticSummary.ReportAttachmentId

content.attachment

as a one-to-many resource,the Salesforce implementationis zero-to-one.

N/A0.1Lookup:CodeSet

DiagnosticSummary.DocumentFormatCode

content.format

1318




The encounter contextinformation of a document

0.MObjectDiagnosticSummaryDetailcontext.encounter

reference is represented usingtheDiagnosticSummaryDetailchild object. TheDetailRecordId fieldreferences the clincialencounter record, theDetailTypefield specifiesthe child record type asClinical Encounter, and theDiagnosticSummaryIdfield references the parentDiagnosticSummaryrecord that represents thedocument reference.

Not supportedN/AN/AN/Acontext.event

Not supportedN/AN/AN/Acontext.period

Not supportedN/AN/AN/Acontext.facilityType

Not supportedN/AN/AN/Acontext.practiceSetting

Not supportedN/AN/AN/Acontext.sourcePatientInfo

Not supportedN/AN/AN/Acontext.related


1319


DosageThe Dosage FHIR resource maps to the PatientMedicationDosage object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Dosage map to the fields in Salesforce.

Table 12: Dosage - Salesforce


TypeSalesforce FieldDosageResource

N/A0.1DoublePatientMedicationDosage.Sequence

sequence

Both dosage.text and dosage.timingare mapped to the PatientMedicationDosage.Comments field in Salesforce.

0.1StringPatientMedicationDosage.Comments

text

While FHIR defines Dosage.additionalInstruction as a zero-to-many reference to

0.1StringPatientMedicationDosage.AdditionalInstruction

additionalInstruction

code set bundle, the Salesforce implementationis a zero-to-one text field.

N/A0.1StringPatientMedicationDosage.PatientInstruction

patientInstruction

N/A0.1StringPatientMedicationDosage.TimingId

timing

N/A0.1BooleanPatientMedicationDosage.IsAsNeeded

asNeeded.asNeededBoolean

Not supportedN/AN/AN/AasNeeded.asNeeded

1320


https://www.hl7.org/fhir/dosage.html#Dosage



CodeableConcept


PatientMedicationDosage.SiteId

site


PatientMedicationDosage.RouteId

route


PatientMedicationDosage.MethodId

method

While FHIR defines dosage.doseAndRateas a zero-to-many block of child resources, the

0.1N/AN/AdoseAndRate

Salesforce implementation supports only azero-to-one set of information per record.

While FHIR defines dosage.doseAndRate.type as a code set bundle, the Salesforceimplementation is a picklist.

0.1PicklistPatientMedicationDosage.DosageDefinitionType

doseAndRate.type

A Salesforce-original field that determineswhether the dosage.doseAndRate.dose

0.1PicklistPatientMedicationDosage.DosageQuantityType

doseAndRate.dose

value in the record is a dose range or a dosequantity.

Because Salesforce doesn’t support nativequantity or range data types, the dosage

0.1DoublePatientMedicationDosage.DosageQuantityNumerator .doseAndRate.dose FHIR resource is

flattened to a set of numerator, denominator, andunit fields.0.1DoublePatientMedication

Dosage.DosageQuantityDenominator

0.1Lookup:UnitOfMeasure

PatientMedicationDosage.DosageUnitId

A Salesforce-original field that determineswhether the dosage.doseAndRate.rate

0.1PicklistPatientMedicationDosage.DosageRateType

doseAndRate.rate

value in the record is a simple frequency,frequency range, or frequency ratio.

Because Salesforce doesn’t support nativequantity, range, or ratio data types, the dosage

0.1DoublePatientMedicationDosage.DosageRateNumerator .doseAndRate.dose FHIR resource is

flattened to a set of numerator, denominator, andunit fields.

1321




0.1DoublePatientMedicationDosage.DosageRateDenominator


PatientMedicationDosage.DosageRateUnitId

Not supportedN/AN/AN/AdoseAndRate.maxDosePerPeriod

Not supportedN/AN/AN/AdoseAndRate.maxDosePerAdministration

Not supportedN/AN/AN/AdoseAndRate.maxDosePerLifetime

SEE ALSO:


EncounterThe Encounter FHIR resource maps to the ClinicalEncounter, ClinicalEncounterDiagnosis, ClinicalEncounterFacility, ClinicalEncounterIdentifier, ClinicalEncounterProvider, ClinicalEncounterReason, and ClinicalEncounterSvcRequest objects in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Encounter map to the fields in Salesforce.



TypeSalesforce FieldEncounterResource

The identifier information for an encounter isrepresented as ClinicalEncounter

0.MObjectClinicalEncounterIdentifier

identifier

Identifier records that reference theencounter record using their ClinicalEncounterIdentifier.ParentRecordId field.

1322


https://www.hl7.org/fhir/encounter.html



While FHIR defines encounter.status asa code, its Salesforce implementation is a picklist.

1.1PicklistClinicalEncounter.Status

status

Not supportedN/AN/AN/AstatusHistory

While FHIR defines encounter.class as acode set, its Salesforce implementation is a picklist.

1.1PicklistClinicalEncounter.Category

class

Not supportedN/AN/AN/AclassHistory

While FHIR defines encounter.type as azero-to-many resource, the Salesforceimplementation is zero-to-one.


ClinicalEncounter.TypeId

type

While FHIR defines encounter.serviceType as a code set bundle, its Salesforceimplementation is a picklist.

0.1PicklistClinicalEncounter.ServiceType

serviceType


ClinicalEncounter.PriorityId

priority

While FHIR defines encounter.subject asa zero-to-one resource, the Salesforceimplementation is one-to-one.

1.1Lookup:Account

ClinicalEncounter.PatientId

subject

Not supportedN/AN/AN/AepisodeOfCare

The service request information that an encounteris based on is represented as Clinical

0.MObjectClinicalEncounterSvcRequest

basedOn

EncounterSvcRequest records thatreference the encounter record using theirClinicalEncounterSvcRequest.ClinicalEncounterId field.

The participant information for an encounter isrepresented as ClinicalEncounter

0.MObjectClinicalEncounterProvider

participant

Provider records that reference the encounterrecord using their ClinicalEncounterProvider.ClinicalEncounterId field.

While FHIR defines encounter.participant.type as a zero-to-many


ClinicalEncounterProvider.PractitionerTypeId

participant.type

resource, the Salesforce implementation iszero-to-one.

1323




Because Salesforce doesn’t have a native perioddata type, the encounter.participant

0.1DateTimeClinicalEncounterProvider.StartDate

participant.period

.period resource is flattened into a set of start0.1DateTimeClinicalEncounter

Provider.EndDatedate and end date fields, and set of duration andduration unit fields.

0.1DoubleClinicalEncounterProvider.Duration


ClinicalEncounterProvider.DurationUnitId

N/A0.1Lookup:HealthcareProvider

ClinicalEncounterProvider.PractitionerId

participant.individual

Not supportedN/AN/AN/Aappointment

Because Salesforce doesn’t have a native perioddata type, the encounter.period resource

0.1DateTimeClinicalEncounter.StartDate

period

is flattened into a set of start date and end datefields.0.1DateTimeClinicalEncounter.End

Date

Because Salesforce doesn’t have a native durationdata type, the encounter.length resource

0.1DoubleClinicalEncounter.Duration

length

is flattened into a set of duration and durationunit fields.0.1Lookup:

UnitOfMeasure

ClinicalEncounter.DurationUnitId

The reason for an encounter is represented asClinicalEncounterReason records that

0.MLookup:CodeSetBundle

ClinicalEncounterReason.ReasonCodeId

reasonCode

reference the encounter record using theirClinicalEncounterReason.ClinicalEncounterId field.

The reason for an encounter is represented asClinicalEncounterReason records that

0.MPolymorphicLookup:Health

ClinicalEncounterReason.ReasonReferenceId

reasonReference

reference the encounter record using theirClinicalEncounterReason.ClinicalEncounterId field.

Condition,CareObservation,andPatientMedicalProcedure

The diagnosis information for an encounter isrepresented as ClinicalEncounter

0.MObjectClinicalEncounterDiagnosis

diagnosis

1324




Diagnosis records that reference theencounter record using their ClinicalEncounterDiagnosis.ClinicalEncounterId field.


ClinicalEncounterDiagnosis.DiagnosisId

diagnosis.condition

HealthCondition,andPatientMedicalProcedure


ClinicalEncounterDiagnosis.UsageTypeId

diagnosis.use

N/A0.1DoubleClinicalEncounterDiagnosis.DiagnosisRank

diagnosis.rank

Not supportedN/AN/AN/Aaccount

N/A0.1Lookup:Clinical

ClinicalEncounter.PreAdmissionIdentifierId

hospitalization.preAdmission Encounter

IdentifierIdentifier.

While FHIR defines encounter.hospitalization.origin as a single

0.1Lookup:HealthcareFacility

ClinicalEncounter.PreviousFacilityId

hospitalization.origin

resource, the Salesforce implementation flattensit into two fields.

0.1Lookup:Account

ClinicalEncounter.PreviousOrganizationId

While FHIR defines encounter.hospitalization.admitSource as

0.1PicklistClinicalEncounter.AdmissionSource

hospitalization.admitSource

a code set bundle, its Salesforce implementationis a picklist.


ClinicalEncounter.ReadmissionCodeId

hospitalization.reAdmission

While FHIR defines encounter.hospitalization.dietPreference


ClinicalEncounter.DietPreference

hospitalization.dietPreference

1325




as a code set bundle, its Salesforceimplementation is a picklist.

While FHIR defines encounter.hospitalization.special

0.1PicklistClinicalEncounter.SpecialCourtesy

hospitalization.specialCourtesy Courtesy as a zero-to-many code set bundle,

its Salesforce implementation is a zero-to-onepicklist.

Not supportedN/AN/AN/Ahospitalization.specialArrangement

While FHIR defines encounter.hospitalization.destination as


ClinicalEncounter.DestinationFacilityId

hospitalization.destination

a single resource, the Salesforce implementationflattens it into two fields.

0.1Lookup:Account

ClinicalEncounter.DestinationOrganizationId


ClinicalEncounter.DischargeDispositionId

hospitalization.dischargeDisposition

The facility information for an encounter isrepresented as ClinicalEncounter

0.MObjectClinicalEncounterFacility

location

Facility records that reference the encounterrecord using their ClinicalEncounterFacility.ClinicalEncounterId field.

N/A0.1Lookup:HealthcareFacility

ClinicalEncounterFacility.FacilityId

location.location

While FHIR defines encounter.location.status as a code, its Salesforceimplementation is a picklist.

0.1PicklistClinicalEncounterFacility.Status

location.status


ClinicalEncounterFacility.FacilityTypeId

location.physicalType

Because Salesforce doesn’t have a native perioddata type, the encounter.location

0.1DateTimeClinicalEncounterFacility.StartDate

location.period

.period resource is flattened into a set of start0.1DateTimeClinicalEncounter

Facility.EndDatedate and end date fields, and set of duration andduration unit fields.

1326




0.1DoubleClinicalEncounterFacility.Duration


ClinicalEncounterFacility.DurationUnitId

While FHIR defines encounter.serviceProvider as referencing an organization, theSalesforce implementation references a facility.


ClinicalEncounter.FacilityId

serviceProvider


ClinicalEncounter.RelatedClinicalEncounterId

partOf


SEE ALSO:

ClinicalEncounter







1327


FlagThe Flag FHIR resource maps to the ClinicalAlert object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Flag map to the fields in Salesforce.

Table 14: Flag - Salesforce


TypeSalesforce FieldFlagResource

The identifier information for a clinical alert isrepresented as Identifier records that


reference the clinical alert record using theirIdentifier.ParentRecordId field.

While FHIR defines Flag.status as a code,the Salesforce implementation of ClinicalAlert.Status is picklist.

0.1PicklistClinicalAlert.Statusstatus

While FHIR defines Flag.category as a codeset bundle, the Salesforce implementation of


ClinicalAlert.Categories

category

ClinicalAlert.Categories is amulti-select picklist.

While FHIR defines Flag.code as a code setbundle only, the Salesforce implementation


ClinicalAlert.CodeIdcode

flattens it into ClinicalAlert.Code andClinicalAlert.CodeDescription.

0.1StringClinicalAlert.CodeDescription

The latter is meant to display non-codedinformation to users as required.

The Salesforce implementation of flag.subject doesn’t support plan definitions.

1.1PolymorphicLookup:Location,

ClinicalAlert.Subjectsubject

AccountHealthcareProvider,Medication,andPatientMedicalProcedure

In Salesforce’s implementation, Flag.periodis split into two fields, ClinicalAlert

0.1Date TimeClinicalAlert.StartDate

period

.StartDate and ClinicalAlert.EndDate.

0.1Date TimeClinicalAlert.EndDate

1328


https://www.hl7.org/fhir/flag.html#Flag


TypeSalesforce FieldFlagResource


ClinicalAlert.RelatedEncounterId

encounter

The Salesforce implementation of flag.author doesn’t support patients, andorganizations.

0.1PolymorphicLookup:HealthcareProvider,

ClinicalAlert.RaisedById

author

CareRegisteredDevice, andHealthcarePractitionerFacility

SEE ALSO:

ClinicalAlert

HumanNameThe HumanName FHIR resource maps to the PersonName object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for HumanName map to the fields in Salesforce.

Table 15: HumanName - Salesforce


TypeSalesforce FieldHumanNameResource

In cases where a person has a middle name,PersonName.LastName is supposed to

0.1StringPersonName.LastNamefamily

store a combination of the middle name and thelast name.

While the cardinality defined by FHIR for HumanName.Given is zero-to-many, the Salesforce

0.1StringPersonName.FirstNameGiven

implementation in PersonName.FirstName is zero-to-one.

N/A0.1StringPersonName.FullNametext

While FHIR defines HumanName.use as a code,Salesforce implements PersonName.NameUsageType as a dynamic picklist.

0.1Dynamicpicklist

PersonName.NameUsageType

use

1329


https://www.hl7.org/fhir/datatypes.html#HumanName


TypeSalesforce FieldHumanNameResource

While the cardinality defined by FHIR for HumanName.prefix is zero-to-many, the Salesforce

0.1StringPersonName.Prefixprefix

implementation in PersonName.Prefix iszero-to-one.

While the cardinality defined by FHIR for HumanName.suffix is zero-to-many, the Salesforce

0.1StringPersonName.Suffixsuffix

implementation in PersonName.Suffix iszero-to-one.

In Salesforce’s implementation, HumanName.period is split into two fields, PersonName

0.1Date TimePersonName.EffectiveDate

period

.EffectiveDate and PersonName.EndDate.

0.1Date TimePersonName.EndDate

SEE ALSO:

PersonName

IdentifierThe Identifier FHIR resource maps to the Identifier object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Identifier map to the fields in Salesforce.

Table 16: Identifier - Salesforce


TypeSalesforce FieldIdentifierResource

FHIR defines identifier.use as a code set.However, the Salesforce implementation of

0.1PicklistIdentifier.IdUsageType

use

Identifier.IdUsageType is a dynamicpicklist because of the limited list of possiblevalues.


Identifier.IdTypeIdtype

CodeSet,CodeSetBundle

FHIR defines identifier.system as a URI.However, the Salesforce implementation of

0.1StringIdentifier.SourceSystem

system

Identifier.SourceSystem is a string

1330


https://www.hl7.org/fhir/datatypes.html#Identifier


TypeSalesforce FieldIdentifierResource

because Salesforce doesn’t support the URI datatype.

N/A0.1StringIdentifier.IdValuevalue

In Salesforce’s implementation, identifier.period is split into two fields, Identifier

0.1DateTimeIdentifier.EffectiveDate

period

.EffectiveDate and Identifier.EndDate.

0.1DateTimeIdentifier.EndDate


Identifier.IssuingAuthorityId

assigner

SEE ALSO:

Identifier

ImmunizationThe Immunization FHIR resource maps to the PatientImmunization and PatientHealthReaction objects inSalesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Immunization map to the fields in Salesforce.

Table 17: Immunization - Salesforce


TypeSalesforce FieldImmunizationResource

The identifier information for an immunization isrepresented as Identifier records that


reference the PatientImmunization record usingtheir Identifier.ParentRecordId field.

While FHIR defines immunization.statusas a code set bundle, the Salesforce

0.1PicklistPatientImmunization.Status

status

implementation of PatientImmunization.Status is picklist.


PatientImmunization.StatusReasonCodeId

statusReason


PatientImmunization.VaccineCodeId

vaccineCode

1331


https://www.hl7.org/fhir/immunization.html



N/A1.1Master-DetailReference:Account

PatientImmunization.PatientId

patient


PatientImmunization.ClinicalEncounterId

encounter

N/A0.1DateTimePatientImmunization.VaccinationDate

occurrence.occurrenceDateTime

N/A0.1StringPatientImmunization.VaccinationPeriod

occurrence.occurrenceString

N/A0.1DateTimePatientImmunization.RecordCreationDateTime

recorded

N/A0.1BooleanPatientImmunization.IsRecordedByVaccinator

primarySource


PatientImmunization.InformationSourceId

reportOrigin

N/A0.1Lookup:Healthcare.Facility

PatientImmunization.FacilityId

location

Use this field if only the name of the organizationis required.

0.1StringPatientImmunization.Manufacturer

manufacturer

N/ALookup:Account

PatientImmunization.ManufacturerAccountId

N/A0.1StringPatientImmunization.LotNumber

lotNumber

N/A0.1DateTimePatientImmunization.ExpirationDate

expirationDate


PatientImmunization.SiteId

site

1332





PatientImmunization.RouteId

route

The Salesforce equivalent of immunization.dose is represented used the fields Patient

0.1DoublePatientImmunization.Dose

dose

Immunization.Dose for the quantity and0.1Lookup:

UnitOfMeasure

PatientImmunization.DoseUnitId

PatientImmunization.DoseUnitIdfor the unit.

The performer information for an immunizationis represented as CarePerformer records

0.MObjectCarePerformerperformer

that reference the PatientImmunization recordusing their CarePerformer.ParentRecordId field.


CarePerformer.RoleIdperformer.function


CarePerformer.PersonId

performer.actor

AccountandHealthcareProvider



PatientImmunization.ReasonCodeId

reasonCode

The FHIR resourceimmunization.reasonReference is flattened into three separate

0.1Lookup:HealthCondition

PatientImmunization.HealthConditionId

reasonReference

zero-to-one references to HealthCondition,CareObservation, and DiagnosticSummary in the Salesforce implementation.


PatientImmunization.CareObservationId

0.1Lookup:DiagnosticSummary

PatientImmunization.DiagnosticSummaryId

N/A0.1BooleanPatientImmunization.IsSubpotent

isSubpotent

While FHIR defines immunization.subpotentReason as a zero-to-many


PatientImmunization.SubpotencyReasonCodeId

subpotentReason

resource, the Salesforce implementation of

1333




PatientImmunization.SubpotencyReasonCodeId is a zero-to-one reference.

Not supportedN/AN/AN/Aeducation

Not supportedN/AN/AN/AprogramEligibility

Not supportedN/AN/AN/AfundingSource

The reaction information for an immunization isrepresented as PatientHealthReaction

0.MObjectPatientHealthReactionreaction

records that reference the PatientImmunizationrecord using their PatientHealthReaction.ParentId field.

N/A0.1DateTimePatientHealthReaction.ReactionDateTime

reaction.date

N/A0.1Lookup: CareObservation

PatientHealthReaction.ObservationId

reaction.detail

N/A0.1BooleanPatientHealthReaction.IsSelfReported

reaction.reported

While FHIR defines immunization.protocolApplied as a zero-to-many

0.1N/AN/AprotocolApplied

reference, the Salesforce implementation of itschild resources is zero-to-one.

N/A0.1StringPatientImmunization.ImmunizationRecommendation

protocolApplied.series

While FHIR defines immunization.protocolApplied.authority as a

0.1StringPatientImmunization.RecommendingAuthority

protocolApplied.authority reference to organization, the Salesforce

implementation of PatientImmunization.RecommendingAuthority is a text field.


PatientImmunization.TargetDiseaseCodeId

protocolApplied.targetDisease

N/A0.1DoublePatientImmunization.CurrentDose

protocolApplied.doseNumber

1334




PositiveInt

The Salesforce implementation ofimmunization.protocolApplied.doseNumber supports only integer values.

N/AN/AN/AprotocolApplied.doseNumberString

N/A0.1DoublePatientImmunization.RecommendedDoses

protocolApplied.seriesDosesPositiveInt

The Salesforce implementation ofimmunization.protocolApplied

N/AN/AN/AprotocolApplied

.seriesDoses supports only integer values.

.seriesDosesString

SEE ALSO:

PatientImmunization

LocationThe Location FHIR resource maps to the HealthcareFacility and Location objects in Salesforce.


FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Location map to the fields in the Salesforce.

Table 18: Location - Salesforce


TypeSalesforce FieldLocationResource

The identifier information for a facility isrepresented as Identifier records that


reference the facility record using theirIdentifier.ParentRecordId field.

1335


https://www.hl7.org/fhir/location.html



While FHIR defines location.status as acode, the salesforce implementation is a booleanfield in the referenced account record.

0.1BooleanAccount.IsActivestatus

Not supportedN/AN/AN/AoperationalStatus

N/A0.1StringHealthcareFacility.Name

name

Not supportedN/AN/AN/Aalias

N/A0.1StringLocation.Descriptiondescription

Not supportedN/AN/AN/Amode

While FHIR defines location.type as azero-to-many resource, Salesforce implements


HealthcareFacility.FacilityTypeId

type

HealthcareFacility.FacilityTypeId as a zero-to-one field.

The telecom information of the facility is storedas ContactPointPhone records that

0.MObjectContactPointPhonetelecom

reference the account referenced by the facilityrecord.

The address information of the facility is stored asContactPointAddress records that

0.MObjectContactPointAddressaddress

reference the account referenced by the facilityrecord.

While FHIR defines location.physicalType as a code set bundle, Salesforce

0.1PicklistHealthcareFacility.LocationType

physicalType

implements HealthcareFacility.LocationType as a picklist.

The location.position FHIR resource ismapped to the Location.Location

0.1GeolocationLocation.Locationposition

salesforce field. This location (Salesforce object)record is referenced by the healthcare facilityrecord using its HealthcareFacility.LocationId lookup field.

position.altitude is not supported inLocation.Location.

The junction object that connects the facilityaccount with the parent organization’s businessaccount.

0.1JunctionObject

AccountAccountRelation__c

managingOrganization

1336




N/A0.1Lookup:HealthcareFacility

HealthcareFacility.ParentFacilityId

partOf

While FHIR defines location.hoursOfOperation.daysOfWeek as a code setbundle, Salesforce implementation is a picklist.

0.1PicklistTimeSlot.DayOfWeekhoursOfOperation.daysOfWeek

While the TimeSlot.DayOfWeek field is azero-to-one field, multiple time slot records canreference the same operating hours record,thereby supporting a zero-to-many reference forlocation.hoursOfOperation.daysOfWeek in the Salesforceimplementation.

The time slot record references the operatinghours record using its TimeSlot.OperatingHoursId master-detailreference field. This operating hours record isreferenced by the facility’s account record usingits Account.OperatingHoursId lookupfield. And finally, this account record is referencedby the facility record using its HealthcareFacility.AccountId master-detailreference field.

Not supportedN/AN/AN/AhoursOfOperation.allDay

The time slot record references the operatinghours record using its TimeSlot

0.1TimeTimeSlot.StartTimehoursOfOperation.openingTime

.OperatingHoursId master-detailreference field. This operating hours record isreferenced by the facility’s account record usingits Account.OperatingHoursId lookupfield. And finally, this account record is referencedby the facility record using its HealthcareFacility.AccountId master-detailreference field.

The time slot record references the operatinghours record using its TimeSlot

0.1TimeTimeSlot.EndTimehoursOfOperation.closingTime

.OperatingHoursId master-detailreference field. This operating hours record isreferenced by the facility’s account record using

1337




its Account.OperatingHoursId lookupfield. And finally, this account record is referencedby the facility record using its HealthcareFacility.AccountId master-detailreference field.

N/A0.1StringHealthcareFacility.AvailabilityExceptions

availabilityExceptions

Not supportedN/AN/AN/AendPoint


SEE ALSO:

HealthcareFacility

MedicationThe medication FHIR resource maps to the Medication object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for medication map to the fields in Salesforce.

1338


https://www.hl7.org/fhir/medication.html

Table 19: medication - Salesforce


TypeSalesforce FieldMedicationResource

The identifier information for a medication isrepresented as Identifier records that


reference the medication record using theirIdentifier.ParentRecordId field.


Medication.MedicationCodeId

code

While FHIR defines medication.status asa code set bundle, the Salesforce implementationof Medication.Status is picklist.

1.1PicklistMedication.Statusstatus



manufacturer



form

Because Salesforce doesn’t support a nativequantity data type, the medication.amount field

0.1DoubleMedication.QuantityNumerator

amount

is flattened into a set of numerator, denominator,and unit fields.0.1DoubleMedication.Quantity

Denominator


Medication.QuantityUnitId

Zero-to-many value formedication.ingredient is implmeneted

0.1Lookup:CodeSetBundle,Medication

MedicinalIngredient.IngredientId

ingredient.item

using the child objectMedicinalIngredient. Each ingredientrecord references the parent Medication recordusing the ParentRecordId field.

0.1BooleanMedicinalIngredient.IsActive

ingredient.isActive

0.1DoubleMedicinalIngredient.StrengthNumerator

ingredient.strength


MedicinalIngredient.StrengthNumeratorUnitId

0.1DoubleMedicinalIngredient.StrengthDenominator


MedicinalIngredient.StrengthDenominatorUnitId

1339



TypeSalesforce FieldMedicationResource

N/A0.1IntMedication.BatchNumber

batch.lotNumber

N/A0.1DateTimeMedication.ExpirationDateTime

batch.expirationDate

SEE ALSO:

Medication

MedicationRequestThe MedicationRequest FHIR resource maps to the MedicationRequest object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for MedicationRequest map to the fields in Salesforce.

Table 20: MedicationRequest - Salesforce


TypeSalesforce FieldMedicationRequestResource

The identifier information for a medication requestis represented as Identifier records that


reference the MedicationRequest recordusing their Identifier.ParentRecordId field.

While FHIR defines MedicationRequest.status as a code set bundle, the Salesforce

1.1PicklistMedicationRequest.Status

status

implementation of MedicationRequest.Status is picklist.


MedicationRequest.StatusReasonCodeId

statusReason

While FHIR defines MedicationRequest.intent as a code set bundle, the Salesforce

1.1PicklistMedicationRequest.Type

intent

implementation of MedicationRequest.Type is picklist.

While FHIR defines MedicationRequest.category as a zero-to-many resource, theSalesforce implementation is zero-to-one.


MedicationRequest.MedicationAdministrationContextId

category

1340


https://www.hl7.org/fhir/medicationrequest.html



While FHIR defines MedicationRequest.priority as a code set bundle, the

0.1PicklistMedicationRequest.Priority

priority

Salesforce implementation of MedicationRequest.Priority is picklist.

N/A0.1BooleanMedicationRequest.IsIgnored

doNotPerform

N/A0.1BooleanMedicationRequest.IsSecondaryInformation

reported.reportedBoolean


MedicationRequest.SecondarySourceId

reported.reportedReference Account,

HealthcareProvider

While the individual fields MedicationRequest.MedicationCodeId and


MedicationRequest.MedicationCodeId

medication.medicationCodeableConcept

MedicationRequest.MedicationIdare zero-to-one references, the set {MedicationRequest.MedicationCode

0.1Lookup:Medication

MedicationRequest.MedicationId

medication.medicationReference

Id, MedicationRequest.MedicationId} is a one-to-one resource.

Only references to patients are supported.1.1Master-DetailReference:Account

MedicationRequest.PatientId

subject


MedicationRequest.ClinicalEncounterId

encounter

Not SupportedN/AN/AN/AsupportingInformation

N/A0.1DateTimeMedicationRequest.PrescribedDate

authoredOn


MedicationRequest.RequesterId

requester

Account,HealthcareProvider,CareRegisteredDevice

1341




Doesn’t support references to care teams.0.1PolymorphicLookup:

MedicationRequest.PerformerId

performer

Account,CareRegisteredDevice, andHealthcareProvider


MedicationRequest.PerformerTypeId

performerType

Not SupportedN/AN/AN/Arecorder

While FHIR defines MedicationRequest.reasonCode as a zero-to-many resource,the Salesforce implementation is zero-to-one.


MedicationRequest.ReasonCodeId

reasonCode

While FHIR defines MedicationRequest.reasonReference as a zero-to-many

0.1PolymorphicLookup:Health

MedicationRequest.ReasonReferenceId

reasonReference

resource, the Salesforce implementation iszero-to-one.Condition,

CareObservation

Not SupportedN/AN/AN/AinstantiatesCanonical


The medicationRequest.basedOn FHIR resource is flattened to a set of medication

0.1Lookup:MedicationRequest

MedicationRequest.RelatedRequestId

basedOn

request and service request fields in the Salesforceimplementation.

0.1Lookup:Clinical

MedicationRequestDetail.ClinicalServiceRequestId Service

Request

N/A0.1Lookup:Identifier

MedicationRequest.MedicationRequestGroupId

groupIdentifier

While FHIR defines MedicationRequest.courseOfTherapyType as a code set

0.1PicklistMedicationRequest.TherapyDuration

courseOfTherapyType bundle, the Salesforce implementation of

1342




MedicationRequest.TherapyDuration is picklist.

Not supportedN/AN/AN/Ainsurance


The dosage information for a medication requestis represented as PatientMedication

0.MObjectPatientMedicationDosage

dosageInstruction

Dosage records that reference theMedicationRequest record using theirPatientMedicationDosage.ParentRecordId field.

Because Salesforce doesn’t support a nativequantity data type, the implementation of

0.1DoubleMedicationRequest.InitialFillQuantity

dispenseRequest.initial medicationRequest.dispense

Request.initialFill.quantity isflattened into a set of quantity and unit fields.


MedicationRequest.FillQuantityUnitId

Fill.quantity

Because Salesforce doesn’t support a nativeduration data type, the implementation of

0.1DoubleMedicationRequest.InitialFillDuration

dispenseRequest.initial medicationRequest.dispense

Request.initialFill.duration isflattened into a set of duration and unit fields.


MedicationRequest.FillDurationUnitId

Fill.duration

Because Salesforce doesn’t support a nativeduration data type, the implementation of

0.1DoubleMedicationRequest.DispenseInterval

dispenseRequest.dispenseInterval

medicationRequest.dispenseRequest.dispenseInterval is flattenedinto a set of interval and unit fields.


MedicationRequest.DispenseIntervalUnitId

Because Salesforce doesn’t support a native perioddata type, the implementation of medication

0.1DateTimeMedicationRequest.PrescriptionPeriodStart

dispenseRequest.validityPeriod

Request.dispenseRequest.validityPeriod is flattened into a set ofstart and end dates.0.1DateTimeMedicationRequest.

PrescriptionPeriodEnd

N/A0.1DoubleMedicationRequest.RefillsAllowed

dispenseRequest.numberOfRepeatsAllowed

1343




Because Salesforce doesn’t support a nativequantity data type, the medicationRequest

0.1DoubleMedicationRequest.RefillQuantity

dispenseRequest.quantity .dispenseRequest.quantity is

flattened into a set of quantity and unit fields.0.1Lookup:UnitOfMeasure

MedicationRequest.FillQuantityUnitId

Because Salesforce doesn’t support a nativeduration data type, the medication

0.1DoubleMedicationRequest.RefillDuration

dispenseRequest.expected Request.dispenseRequest

.expectedSupplyDuration is flattenedinto a set of duration and unit fields.


MedicationRequest.FillDurationUnitId

SupplyDuration


MedicationRequest.DispenserId

dispenseRequest.performer

N/A0.1BooleanMedicationRequest.CanSubstitute

substitution.allowed.allowedBoolean

0.10.1Lookup:CodeSetBundle

MedicationRequest.AllowedSubstitutionTypeCodeId

substitution.allowed.allowedCodeableConcept


MedicationRequest.SubstitutionReasonCodeId

substitution.reason

N/A0.1Lookup:MedicationRequest

MedicationRequest.PreviousPrescriptionId

priorPrescription

Not supportedN/AN/AN/AdetectedIssue

Not supportedN/AN/AN/AeventHistory

SEE ALSO:

MedicationRequest

1344


MedicationStatementThe medicationStatement FHIR resource maps to the MedicationStatement object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for medicationStatement map to the fields in Salesforce.

Table 21: MedicationStatement - Salesforce


TypeSalesforce FieldMedicationStatementResource

The identifier information for a medicationstatement is represented as Identifier


records that reference the MedicationStatement record using their Identifier.ParentRecordId field.

While FHIR defines medicationStatement.basedOn as a zero-to-many resource, the

0.1Lookup:MedicationRequest

MedicationStatement.MedicationRequestId

basedOn

Salesforce implementation of MedicationStatement.MedicationRequestId iszero-to-one.

The Salesforce implementation doesn’t supportreferences to care plan or service request records.

The Salesforce implementation of medicationRequest.partOf is flattened into threeseparate references.

0.1Lookup:MedicationStatement

MedicationStatement.ParentMedicationStatementId

partOf

0.1Lookup:Patient

MedicationStatement.ProcedureId

References to medication administration andmedication dispense records are not supported.

MedicalProcedure

While FHIR defines medicationStatement.partOf as a zero-to-many resource, the


MedicationStatement.CareObservationId

Salesforce implementation is zero-to-one for eachof the flattened fields.

While FHIR defines MedicationStatement.status as a code set bundle, the Salesforce

1.1PicklistMedicationStatement.Status

status

implementation of MedicationStatement.Status is picklist.


MedicationStatement.StatusReasonCodeId

statusReason

1345


https://www.hl7.org/fhir/medicationstatement.html



While FHIR defines MedicationStatement.category as a code set bundle, theSalesforce implementation is a picklist.

0.1PicklistMedicationStatement.DeliverySetting

category

While the individual fields MedicationStatement.MedicationCodeId and


MedicationStatement.MedicationCodeId

medication.medicationCodeableConcept

MedicationStatement.MedicationId are zero-to-one references,the set {MedicationStatement

0.1Lookup:Medication

MedicationStatement.MedicationId

medication.medicationReference

.MedicationCodeId, MedicationStatement.MedicationId} is aone-to-one resource.


MedicationStatement.PatientId

subject

Only references to encounters are supported.0.1Lookup:ClinicalEncounter

MedicationStatement.ClinicalEncounterId

context

The MedicationStatement.StartDateTime field is used as both the Salesforce

0.1DateTimeMedicationStatement.StartDateTime

effective.effectiveDateTime counterpart for medicationStatement

.effective.effectiveDateTime andthe start date field for medicationStatement.effective.effectivePeriod.

Because Salesforce doesn’t support a native perioddata type, the implementation of medication

0.1DateTimeMedicationStatement.StartDateTime

effective.effectivePeriod Statement.effective.effective

Period is flattened into a set of start and enddates.

0.1DateTimeMedicationStatement.EndDateTime

N/A0.1DateTimeMedicationStatement.AssertionDateTime

dateAsserted


MedicationStatement.StatementSourceId

informationSource


Not supportedN/AN/AN/AderivedFrom

1346




While FHIR defines MedicationStatement.reasonCode as a zero-to-many resource,the Salesforce implementation is zero-to-one.


MedicationStatement.MedicationReasonCodeId

reasonCode

While FHIR defines MedicationStatement.reasonReference as a zero-to-many


MedicationStatement.MedicationReasonId

reasonReference

resource, the Salesforce implementation iszero-to-one.Condition,

CareObservation Only references to condition and observation

records are supported.


The dosage information for a medicationstatement is represented as Patient

0.MObjectPatientMedicationDosage

dosage

MedicationDosage records that referencethe MedicationStatement record usingtheir PatientMedicationDosage.ParentRecordId field.

SEE ALSO:

MedicationStatement

ObservationThe observation FHIR resource maps to the CareObservation and CareObservationComponent objects in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for observation map to the fields in Salesforce.

Table 22: observation - Salesforce


TypeSalesforce FieldObservationResource

Not supportedN/AN/AN/Aidentifier

While FHIR defines observation.basedOnas a zero-to-many reference, the Salesforceimplementation is a zero-to-one text field.

0.1PolymorphicLookup:MedicationRequest,

CareObservation.BasedOnId

basedOn

Only references to medication request and clinicalservice request records are supported.


1347


https://www.hl7.org/fhir/observation.html



While FHIR defines observation.partOfas a zero-to-many reference, the Salesforceimplementation is a zero-to-one text field.

0.1PolymorphicLookup:MedicationStatement,

CareObservation.PartOfId

partOf

Only references to medication statement, patientimmunization, and patient medical procedurerecords are supported.

PatientImmunization,PatientMedicalProcedure

While FHIR defines observation.statusas a reference to code set bundle, the Salesforceimplementation is a picklist.

1.1PicklistCareObservation.ObservationStatus

status

While FHIR defines observation.category as a zero-to-many reference to

0.1PicklistCareObservation.Category

category

code set bundle, the Salesforce implementationis a zero-to-one picklist.

While FHIR defines observation.code asa one-to-one reference to code set bundle,

1.1Lookup:CodeSet

CareObservation.CodeId

code

Salesforce implements this as three separate0.1Lookup:

CodeSetCareObservation.AdditionalCode1Id

CodeSet reference fields. The first one is aone-to-one field, while the other two arezero-to-one fields.0.1Lookup:

CodeSetCareObservation.AdditionalCode2Id

The Salesforce implementation ofobservation.subject supportsreferences to only patients.

1.1Master-Detail:Account

CareObservation.ObservedSubjectId

subject

Not supportedN/AN/AN/Afocus


CareObservation.EncounterId

encounter

N/A0.1DateTimeCareObservation.EffectiveDateTime

effective.effectiveDateTime

Because Salesforce doesn’t support a native perioddata type, the observation.effective

0.1DateTimeCareObservation.EffectiveDateTime

effective.effectivePeriod .effectivePeriod field is flattened into a

set of effective date and end date fields.0.1DateTimeCareObservation.EndDateTime

Not supportedN/AN/AN/Aeffective.effectiveTiming

1348




Not supportedN/AN/AN/Aeffective.effectiveInstant

Because Salesforce doesn’t support a nativeinstant data type, the observation

0.1DateTimeCareObservation.IssuedDateTime

issued

.issued FHIR resource is implemented as adate time field in Salesforce.

While FHIR defines observation.performer as a zero-to-many resource, the

0.1PolymorphicLookup:Account,

CareObservation.ObserverId

performer

Salesforce implementation is a zero-to-oneHealthcareProvider

reference to Account and HealthcareProvider.

References to care teams are not supported.

While FHIR defines observation.resultsInterpreter as a zero-to-many resource,


CareObservation.InterpretedById

resultsInterpreter

the Salesforce implementation is a zero-to-onereference to CarePerformer.

A Salesforce-original field that determineswhether the value stored in Care

0.1Static PicklistCareObservation.ObservedValueType

value

Observation.ObservedValueNumerator and CareObservation.ObservedValueDenominator is a range,ratio, or quantity. This field is used only when thedata entered for observation.value isone these data types.

Because Salesforce doesn’t support native range,ratio, and quantity data types, the

0.1DoubleCareObservation.ObservedValueNumerator observation.value FHIR resource is

0.1DoubleCareObservation.ObservedValueDenominator

flattened to a set of numerator, denominator, andunit fields for this type of data.

The Salesforce implementation ofobservation.value doesn’t support


CareObservation.ObservedValueUnitId

observation.value.valueSampleData and observation.value.valueTime.

CareObservation.ObservedValueUnitId is a duplicate field that stores the sameinformation as CareObservation.UnitOfMeasureId. Use only one of these two fieldsto specify the unit of a quantity value.

1349





CareObservation.ObservedValueDenominator

N/A0.1DoubleCareObservation.NumbericValue

N/A0.1StringCareObservation.ObservedValueText

CareObservation.IsObserved is aduplicate field that can store the sameinformation. Use only one of these two fields.

0.1BooleanCareObservation.IsOutcomePositive

CareObservation.ObservationStartTime is used for both observation

0.1DateTimeCareObservation.ObservationStartTime

0.1DateTimeCareObservation.ObservationEndTime

.component.value.valueDateTimeand observation.component.value.valuePeriod.

Because Salesforce doesn’t support a nativeperiod data type, the observation.value.valuePeriod FHIR resource is flattened toa set of start and end dates.

Not supportedN/AN/AN/AdataAbsentReason

While FHIR defines observation.interpretation as a zero-to-many code

0.1PicklistCareObservation.ValueInterpretation

interpretation

set bundle, the Salesforce implementation is azero-to-one picklist.



CareObservation.BodySiteId

bodySite


CareObservation.MethodId

method


References to device metrics records aren’tsupported.

0.1Lookup:Asset

CareObservation.DeviceId

device

Because Salesforce doesn’t support a nativequantity data type, the observation

0.1DoubleCareObservation.LowerBaselineValue

referenceRange.low

1350





CareObservation.BaselineUnitId

.referenceRange.low FHIR resource isflattened to a set of value and unit fields for thistype of data.


0.1DoubleCareObservation.UpperBaselineValue

referenceRange.high .referenceRange.high FHIR resource is

flattened to a set of value and unit fields for thistype of data.


CareObservation.BaselineUnitId

Not supportedN/AN/AN/AreferenceRange.type

Not supportedN/AN/AN/AreferenceRange.appliesTo

Not supportedN/AN/AN/AreferenceRange.age

N/A0.1StringCareObservation.BaselineValueText

referenceRange.text

While FHIR defines observation.hasMember as a zero-to-many resource, theSalesforce implementation is zero-to-one.


CareObservation.RelatedObservationId

hasMember

Only references to observation records aresupported.

While FHIR defines observation.derivedFrom as a zero-to-many resource,the Salesforce implementation is zero-to-one.

0.1Lookup: CareObservation,DiagnosticSummary

CareObservation.DerivationSourceId

derivedFrom

The component information for a care observationis represented as CareObservation

0.MObjectCareObservationComponent

component

Component records that reference the CareObservation record using theirIdentifier.CareObservationId field.


CareObservationComponent.ComponentTypeCodeId

component.code

A Salesforce-original field that determineswhether the value stored in Care

0.1Static PicklistCareObservationComponent.ValueType

component.value

1351




ObservationComponent.ObservedValueNumerator and CareObservationComponent.ObservedValueDenominator is a range, ratio, orquantity. This field is used only when the dataentered for observation.component.value is one these data types.

Because Salesforce doesn’t support native range,ratio, and quantity data types, the

0.1DoubleCareObservationComponent.ObservedValueNumerator observation.component.value FHIR

0.1DoubleCareObservationComponent.ObservedValueDenominator

resource is flattened to a set of numerator,denominator, and unit fields for this type of data.

The Salesforce implementation ofobservation.component.value



doesn’t support observation.component.value.valueSampleData andobservation.component.value.valueTime.


CareObservationComponent.ObservedValueCodeId

N/A0.1DoubleCareObservationComponent.NumericValue

N/A0.1StringCareObservationComponent.ObservedValueText

N/A0.1BooleanCareObservationComponent.IsObserved

CareObservationComponent.ObservationStartTime is used for both

0.1DateTimeCareObservationComponent.ObservationStartTime observation.component.value

0.1DateTimeCareObservationComponent.ObservationEndTime

.valueDateTime and observation

.component.value.valuePeriod.

Because Salesforce doesn’t support a nativeperiod data type, the observation.component.value.valuePeriod FHIRresource is flattened to a set of start and end dates.

1352




While FHIR defines observation.component.dataAbsentReason as a

0.1StringCareObservationComponent.MissingDataReason

component.dataAbsentReason

code set bundle reference, the Salesforceimplementation is a text field.

While FHIR defines observation.component.interpretation as a code


CareObservationComponent.ValueInterpretation

component.interpretation

set bundle reference, the Salesforceimplementation is a picklist.


0.1DoubleCareObservationComponent.LowerBaselineValue

component.referenceRange.low .component.referenceRange.low

FHIR resource is flattened to a set of value andunit fields for this type of data.0.1Lookup:

UnitOfMeasure

CareObservationComponent.BaselineUnitId


0.1DoubleCareObservationComponent.UpperBaselineValue

component.referenceRange.high

.component.referenceRange.highFHIR resource is flattened to a set of value andunit fields for this type of data.0.1Lookup:

UnitOfMeasure

CareObservationComponent.BaselineUnitId

Not supportedN/AN/AN/Acomponent.referenceRange.type

Not supportedN/AN/AN/Acomponent.referenceRange.appliesTo

Not supportedN/AN/AN/Acomponent.referenceRange.age

N/A0.1StringCareObservationComponent.BaselineValueText

component.referenceRange.text

1353


Note: The fields CareObservation.IsOutcomePositive and CareObservation.UnitOfMeasureId don’thave FHIR-defined validation rules built into them because these fields are used in other features and data models. You can defineyour own custom validation rules on them based on your business requirements.

SEE ALSO:

CareObservation


OrganizationThe Organization FHIR resource maps primarily to the Account object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Organization map to the fields in Salesforce.

Table 23: Organization - Salesforce


TypeSalesforce FieldOrganizationResource

The identifier information for an organization isrepresented as Identifier records that


reference the organization record using theirIdentifier.ParentRecordId field.

N/A0.1BooleanAccount.IsActiveactive

While FHIR defines account.type as azero-to-many code set bundle reference, its

0.1PicklistAccount.Typetype

Salesforce implementation is a zero-to-one picklist.

N/A0.1StringAccount.Namename

Not supportedN/AN/AN/Aalias

The telecom information for an organization isrepresented as ContactPointPhone records


that reference the organization record using theirContactPointPhone.ParentId field.

The address information for an organization isrepresented as ContactPointAddress


records that reference the organization recordusing their ContactPointAddress.ParentId field.

Contacts are connected to organizations usingthe AccountContactRelation junction

0.MLookup:Contact

AccountContactRelation.ContactId

contact

object. The AccountContactRelation.AccountId field references the organization’s

1354


https://www.hl7.org/fhir/organization.html


TypeSalesforce FieldOrganizationResource

account record, and the AccountContactRelation.ContactId field references thecontact record of the contact’s person account.

While FHIR defines organization.contact.purpose as a code set bundle,its Salesforce implementation is a picklist.

0.MMulti-Selectpicklist

AccountContactRelation.Roles

contact.relationship

The name information for a contact is representedas PersonName records that reference the

0.MObjectPersonNamecontact.name

contact’s person account using their PersonName.ParentRecordId field.

While FHIR defines patient.contact.name as a zero-to-one resource, the Salesforceimplementation can support zero-to-manyreferences.

The telecom information for a contact isrepresented as ContactPointPhone records

0.MObjectContactPointPhonecontact.telecom

that reference the contact’s person account recordusing their ContactPointPhone.ParentId field.

The address information for a contact isrepresented as ContactPointAddress

0.MObjectContactPointAddresscontact.address

records that reference the contact’s personaccount record using their ContactPointAddress.ParentId field.

While FHIR defines patient.contact.address as a zero-to-one resource, theSalesforce implementation can supportzero-to-many references.

Not supportedN/AN/AN/Acontact.endPoint

PatientThe Patient FHIR resource maps to the Account and Contact objects in Salesforce. Patients in Health Cloud are modeledusing Person Accounts.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Patient map to the fields in Salesforce.

1355


https://www.hl7.org/fhir/patient.html#patient



TypeSalesforce FieldPatientResource

The identifier information for a patient isrepresented as Identifier records that


reference the patient record using theirIdentifier.ParentRecordId field.


The name information for a patient is representedas PersonName records that reference the

0.MObjectPersonNamename

patient record using their PersonName.ParentRecordId field.

The telecom information for a patient isrepresented as ContactPointPhone records


that reference the patient record using theirContactPointPhone.ParentId field.

While FHIR defines patient.gender as acode set, its Salesforce implementation is a picklist.

0.1PicklistContact.Gendergender

N/A0.1DateContact.BirthdatebirthDate

Not supportedN/AN/AN/Adeceased.deceasedBoolean

While FHIR defines patient.deceased aseither a boolean or a date, Salesforce supportsonly a date.

0.1DateTimeContact.DeceasedDatedeceased.deceasedDateTime

The address information for a patient isrepresented as ContactPointAddress


records that reference the patient record usingtheir ContactPointAddress.ParentIdfield.

While FHIR defines patient.maritalStatus as a code set bundle, its Salesforceimplementation is a picklist.

0.1PicklistContact.MaritalStatusmaritalStatus

Not supportedN/AN/AN/AmultipleBirth.multipleBirthBoolean

While FHIR defines patient.multipleBirth as either a boolean or an integer,Salesforce supports only an integer.

0.1DoubleContact.SequenceInMultipleBirth

multipleBirth.multiple

1356




BirthInteger

Not supportedN/AN/AN/Aphoto

Contacts are connected to patients using theContactContactRelation__c junction

0.MLookup:Contact

ContactContactRelation__c.RelatedContact__c

contact

object. The ContactContactRelation__c.Contact__c fieldreferences the contact record of the patient’sperson account, and the ContactContactRelation__c.RelatedContact__cfield references the contact record of the contact’sperson account.

While FHIR defines patient.contact.relationship as a code set bundle, its

0.MLookup:ReciprocalRole__c


contact.relationship

Salesforce implementation is a reference toReicprocalRole__c.

The name information for a contact is representedas PersonName records that reference the

0.MObjectPersonNamecontact.name

contact record of the contact’s person accountusing their PersonName.ParentRecordId field.

While FHIR defines patient.contact.name as a zero-to-one resource, the Salesforceimplementation can support zero-to-manyreferences.

The telecom information for a contact isrepresented as ContactPointPhone records

0.MObjectContactPointPhonecontact.telecom

that reference the contact’s person account recordusing their ContactPointPhone.ParentId field.

The address information for a contact isrepresented as ContactPointAddress

0.MObjectContactPointAddresscontact.address

records that reference the contact’s personaccount record using their ContactPointAddress.ParentId field.

While FHIR defines patient.contact.address as a zero-to-one resource, theSalesforce implementation can supportzero-to-many references.

1357




While FHIR defines patient.contact.gender as a code set, its Salesforceimplementation is a picklist.

0.1PicklistContact.Gendercontact.gender

Not supportedN/AN/AN/Acontact.organization

Because Salesforce doesn’t support a native perioddata type, the patient.contact.period

0.1DateContactContactRelation__c.StartDate__c

contact.period

FHIR resource is flattened to a set of from and todates.

0.1DateContactContactRelation__c.EndDate__c

The language information for a patient isrepresented as PersonLanguage records

0.MObjectPersonLanguagecommunication

that reference the patient record using theirPersonLanguage.IndividualId field.

While FHIR defines patient.communication.language as a code

0.1PicklistPersonLanguage.Language

communication.language

set bundle, its Salesforce implementation is apicklist.

While FHIR defines patient.communication.preferred as a

0.1DoublePersonLanguage.Rankcommunication.preferred

boolean, its Salesforce implementation is aninteger field that ranks the degree of preference.

Practitioners are connected to patients using theContactContactRelation__c junction

0.MLookup:Contact

ContactContactRelation__c.RelatedContact__c

generalPractitioner

object. The ContactContactRelation__c.Contact__c fieldreferences the contact record of the patient’sperson account, and the ContactContactRelation__c.RelatedContact__cfield references the contact record of thepractitioner’s person account.

Health Cloud doesn't support PractitionerRoletype values for patient.generalPractitioner

Managing organizations are connected to patientsusing the AccountContactRelation

0.MLookup:Account


managingOrganization

junction object. The AccountContactRelation.AccountId field references theaccount record of the patient’s organization, andthe AccountContactRelation

1358




.ContactId field references the contactrecord of the patient’s person account.

Not supportedN/AN/AN/Alink


PractitionerThe Practitioner FHIR resource maps to the HealthcareProvider object and person accounts in Salesforce.

The Practitioner resource in FHIR is represented as a combination of HealthcareProvider records and person accountsin Salesforce, where the HealthcareProvider record is the base. The person account is associated to theHealthcareProvider record by referencing the person account record using the AccountId field onHealthcareProvider.

Note: If your implementation of Health Cloud models providers as contacts instead of person accounts, you can’t associate thefields mapped to Account to your providers. You can instead associate your HealthcareProvider record to the Contact record usingthe PractitionerId field on HealthcareProvider.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Practitioner map to the fields in Salesforce.

1359


https://www.hl7.org/fhir/practitioner.html

Table 25: Practitioner - Salesforce


TypeSalesforce FieldPractitionerResource

The identifier information for adocumentReference is represented as


Identifier records that reference theHealthcareProvider record using theirIdentifier.ParentRecordId field.

The practitioner.active field ismapped to the account record of the provider’s

0.1BooleanAccount.IsActiveactive

person account. This account record is referencedusing the HealthcareProvider.AccountId field.

If your Health Cloud implementation modelsproviders as Contacts instead of Person Accounts,then you can’t map practitioner.activeto your providers.

The name information for a practitioner isrepresented as PersonName records that


reference the practitioner’s person account recordusing their PersonName.ParentRecordId field.

The telecom information for a practitioner isrepresented as ContactPointPhone records


that reference the account record of thepractitioner’s person account using theContactPointPhone.ParentId field.

If your Health Cloud implementation modelsproviders as Contacts instead of Person Accounts,then you can’t map practitioner.telecom to your providers.

The address information for a practitioner isrepresented as ContactPointAddress


records that reference the account record of thepractitioner’s person account using theContactPointAddress.ParentId field.

If your Health Cloud implementation modelsproviders as Contacts instead of Person Accounts,then you can’t map practitioner.address to your providers.

1360




While FHIR defines practitioner.genderas a code set, its Salesforce implementation is apicklist.


The practitioner’s gender is mapped to thecontact record of their person account. Thiscontact record is referenced using theHealthcareProvider.PractitionerId field onHealthcareProvider.



The qualification information for a practitioner isrepresented as BoardCertification

0.MObjectBoardCertificationqualification

records that reference the practitioner’sHealthcareProvider record using theirBoardCertification.HealthcareProviderId field.

The identifier information for a qualification isrepresented as Identifier records that

0.MObjectIdentifierqualification.identifier

reference the BoardCertification record using theirIdentifier.ParentRecordId field.

While FHIR defines practitioner.qualification.code as a code set

0.1PicklistBoardCertification.CertificationType

qualification.code

bundle, its Salesforce implementation is a picklist.

Because Salesforce doesn’t support a native perioddata type, the practitioner

0.1DateBoardCertification.EffectiveFrom

qualification.period

.qualification.period FHIR resourceis flattened to a set of from and to dates.0.1DateBoardCertification

.EffectiveTo

N/A0.1StringBoardCertification.BoardName

qualification.issuer

The language information for a practitioner isrepresented as PersonLanguage records


that reference the practitioner’s person accountusing their PersonLanguage.IndividualId field.

While FHIR defines practitioner.communication as a code set bundle, the

1361




Salesforce implementation is a reference toPersonLanguage.


PractitionerRoleThe practitionerRole FHIR resource maps to the HealthcarePractitionerFacility andCareProviderFacilitySpecialty objects in Salesforce.

The practitionerRole resource in FHIR is represented as a combination of HealthcarePractitionerFacility andCareProviderFacilitySpecialty records, where the HealthcarePractitionerFacility record is the base.The CareProviderFacilitySpecialty record is associated to the HealthcarePractitionerFacility recordby referencing the HealthcarePractitionerFacility record using the PractitionerFacilityId field onCareProviderFacilitySpecialty.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for PractitionerRole map to the fields in Salesforce.

Table 26: PractitionerRole - Salesforce



The identifier information for apractitionerRole is represented as


Identifier records thatreference the HealthcarePractitionerFacility record using theirIdentifier.ParentRecordId field.

1362


https://www.hl7.org/fhir/practitionerrole.html



N/A0.1BooleanHealthcarePractitionerFacility.IsActive

active

Because Salesforce doesn’t supporta native period data type, the

0.1DateHealthcarePractitionerFacility.EffectiveFrom

period

practitionerRole0.1DateHealthcarePractitioner

Facility.EffectiveTo.period FHIR resource isflattened to a set of from and todates.

N/A0.1Lookup:HealthcareProvider

HealthcarePractitionerFacility.HealthcareProviderId

practitioner

N/A0.1Lookup: AccountHealthcarePractitionerFacility.AccountId

organization

While FHIR definespractitionerRole.code

0.MPicklistCareProviderFacilitySpecialty.SepcialtyRole

code

as a code set bundle, its Salesforceimplementation is a picklist.

Zero-to-many values can beassociated by creating multipleCareProviderFacilitySpecialty records thatreference a HealthcarePractitionerFacilityrecord. However, a singleCareProviderFacilitySpecialty record can haveonly one combination of role andspecialty.

While FHIR definespractitionerRole.code

0.MLookup:CareSpecialty


specialty

as a code set bundle, its Salesforceimplementation is aCareSpecialty reference.

Zero-to-many values can beassociated by creating multipleCareProviderFacilitySpecialty records thatreference a HealthcarePractitionerFacilityrecord. However, a singleCareProviderFacility

1363




Specialty record can haveonly one combination of role andspecialty.

The Salesforce implementationsupports only one


HealthcarePractitionerFacility.HealthcareFacilityId

location

practitionerRole.location reference for eachpractitioner role.

Not supportedN/AN/AN/AhealthcareService

Not supportedN/AN/AN/Atelecom

Even though only oneOperatingHours record can

0.MOperatingHours

HealthcarePractitionerFacility.OperatingHoursId

availableTime

be referenced from aHealthcarePractitionerFacility record, multiple timeslots can be added to thatOperatingHours record. Assuch, zero-to-many available timevalues can be added to a singleHealthcarePractitionerFacility record through asingle OperatingHoursreference.

Not supportedN/AN/AN/AnotAvailable

N/A0.1StringHealthcarePractitionerFacility.AvialabilityExceptions

availabilityExceptions

Not supportedN/AN/AN/AendPoint


1364


ProcedureThe procedure FHIR resource maps to the PatientMedicalProcedure and PatientMedicalProcedureDetailobjects in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Procedure map to the fields in Salesforce.

Table 27: Procedure - Salesforce


TypeSalesforce FieldProcedureResource

The identifier information for a Procedure isrepresented as Identifier records that


reference the PatientMedicalProcedure recordusing their Identifier.ParentRecordId field.



1365


https://www.hl7.org/fhir/procedure.html



The information about the service request that aprocedure is based on is represented as

0.MObjectPatientMedicalProcedureDetail

basedOn

PatientMedicalProcedureDetailrecords that reference the PatientMedicalProcedure record using their PatientMedicalProcedureDetail.PatientMedicalProcedureId field.

The Salesforce implementation of procedure.basedOn doesn’t support references to careplans.

For procedure.basedOn information,PatientMedicalProcedureDetail.

0.1Lookup:ClinicalServiceRequest

PatientMedicalProcedureDetail.DetailRecordId DetailRecordId must reference a

ClinicalServiceRequest record.

For procedure.basedOn information,PatientMedicalProcedureDetail.

0.1Picklist

Value: BasedOn

PatientMedicalProcedureDetail.DetailType DetailType must use the value Based On

.

The information about the procedure orobservation that a procedure is a part of is


partOf

represented as PatientMedicalProcedureDetail records that referencethe PatientMedicalProcedure recordusing their PatientMedicalProcedureDetail.PatientMedicalProcedureId field.

The Salesforce implementation of procedure.partOf doesn’t support references tomedication administration.

For procedure.partOf information,PatientMedicalProcedureDetail.

0.1PolymorphicLookup:Patient

PatientMedicalProcedureDetail.DetailRecordId DetailRecordId must reference a either a

PatientMedicalProcedure record or aCareObservation.

MedicalProcedure,CareObservation

For procedure.partOf information,PatientMedicalProcedureDetail.DetailType must use the value Part Of.

0.1Picklist

Value: Part Of


1366




While FHIR defines procedure.status asa code set bundle, the Salesforce implementation

0.1PicklistPatientMedicalProcedure.Status

status

of PatientMedicalProcedure.Statusis picklist.


PatientMedicalProcedure.StatusReasonCodeId

statusReason


PatientMedicalProcedure.TypeId

category


PatientMedicalProcedure.CodeId

code

The Salesforce implementation of procedure.subject doesn’t support references togroups.

1.1MasterDetail:Account

PatientMedicalProcedure.PatientId

subject


PatientMedicalProcedure.ClinicalEncounterId

encounter

PatientMedicalProcedure.StartDate is used for both procedure

0.1DateTimePatientMedicalProcedure.StartDate

performed.performedDateTime .performed.performedDateTime and

procedure.performed.performedPeriod. For the latter, the field is used torepresent the start date of the period.

Because Salesforce doesn’t support a native perioddata type, the procedure.performed

0.1DateTimePatientMedicalProcedure.StartDate

performed.performedPeriod .performedPeriod field is flattened into a

set of start date and end date fields.0.1DateTimePatientMedicalProcedure.EndDate

N/A0.1StringPatientMedicalProcedure.DurationTimeString

performed.performedString

Because Salesforce doesn’t support a native agedata type, the procedure.performed

0.1DoublePatientMedicalProcedure.PerformedAtAge

performed.performedAge

.performedAge FHIR resource is flattenedinto a set of age and unit fields.


PatientMedicalProcedure.PerformedAtAgeUnitId

1367




Because Salesforce doesn’t support a native rangedata type, the procedure.performed

0.1DoublePatientMedicalProcedure.PerformedAtAgeLowerLimit

performed.performedRange .performedRange FHIR resource is flattened

into a set of lower limit, upper limit, and unit fields.0.1DoublePatientMedical

Procedure.PerformedAtAgeUpperLimit


PatientMedicalProcedure.PerformedAgeRangeUnit

N/A0.1Lookup:Account,HealthcareProvider

PatientMedicalProcedure.RecordCreatorId

recorder

N/A0.1Lookup:Account,

PatientMedicalProcedure.AssertionSourceId

asserter

HealthcareProvider

The performer information for a Procedure isrepresented as CarePerformer records that

0.MObjectCarePerformerperformer

reference the PatientMedicalProcedure recordusing their CarePerformer.ParentRecordId field.


CarePerformer.RoleIdperformer.function

CodeSet,CodeSetBundle

The Salesforce implementation doesn’t supportreferences to devices.


CarePerformer.PersonId

performer.actor

HealthcareProvider

0.10.1Lookup:Account

CarePerformer.AffiliatedOrganizationId

performer.actoronBehalfOf

N/A0.1Lookup:Healthcare.Facility

PatientMedicalProcedure.FacilityId

location

While FHIR defines procedure.reasonCode as a zero-to-many resource, the Salesforceimplementation is zero-to-one.


PatientMedicalProcedure.ReasonCodeId

reasonCode

1368




While FHIR defines procedure.reasonCode as a zero-to-many resource, the Salesforceimplementation is zero-to-one.

0.1PolymorphicLookup:HealthCondition,

PatientMedicalProcedure.ReasonReferenceId

reasonReference

The Salesforce implementation doesn’t supportdocument reference records.

CareObservation,PatientMedicalProcedure,andDiagnosticSummary

The body site information of a procedure isrepresented as PatientMedical


bodySite

ProcedureDetail records that referencethe PatientMedicalProcedure recordusing their PatientMedicalProcedureDetail.PatientMedicalProcedureIdfield.

For procedure.bodySite information,PatientMedicalProcedureDetail.

0.1PolymorphicLookup:CodeSet,

PatientMedicalProcedureDetail.DetailCodeId DetailCodeId must reference a CodeSet

or CodeSetBundle record.CodeSetBundle

For procedure.bodySite information,PatientMedicalProcedureDetail.

0.1Picklist

Value: BodySite

PatientMedicalProcedureDetail.DetailType DetailType must use the value Body

Site.

While FHIR defines procedure.outcome asa code, the Salesforce implementation of

0.1PicklistPatientMedicalProcedure.Outcome

outcome

PatientMedicalProcedure.Outcomeis a picklist.

While FHIR defines procedure.report asa zero-to-many resource, the Salesforceimplementation is zero-to-one.

0.1Lookup:DiagnosticSummary

PatientMedicalProcedure.ReportId

report

The Salesforce implementation of procedure.report doesn’t support references tocomposition or document reference records.

The complication information of a procedure isrepresented as PatientMedical


complication

1369





For procedure.complicationinformation, PatientMedicalProcedure


PatientMedicalProcedureDetail.DetailCodeId Detail.DetailCodeId must reference a

CodeSet or CodeSetBundle record.CodeSetBundle

For procedure.complicationinformation, PatientMedicalProcedure

0.1Picklist

Value:Complication

PatientMedicalProcedureDetail.DetailType Detail.DetailType must use the value

Complication.

The complication detail information of aprocedure is represented as Patient


complicationDetail

MedicalProcedureDetail records thatreference the PatientMedicalProcedurerecord using their PatientMedicalProcedureDetail.PatientMedicalProcedureId field.

For procedure.complicationDetailinformation, PatientMedicalProcedure


PatientMedicalProcedureDetail.DetailRecordId Detail.DetailRecordId must reference

a HealthCondition record.


0.1Picklist

Value:ComplicationDetail


Complication Detail.

The follow up information of a procedure isrepresented as PatientMedical


followUp


For procedure.followUp information,PatientMedicalProcedureDetail.



1370




DetailCodeId must reference a CodeSetor CodeSetBundle record.

CodeSetBundle


0.1Picklist

Value: FollowUp


Follow Up.

Use the AuthorNote object to add notes to aprocedure, and use the ParentRecordId field to

0.MObjectAuthorNoteNote

reference the parent procedure the note belongsto.

Use the PatientMedicalProcedureDetail child object to add multiple focalDevicevalues that reference the parent procedure record.

0.MLookup: CareRegisteredDevice

PatientMedicalProcedureDetail.DetailrecordId

focalDevice

Use the PatientMedicalProcedureDetail child object to specify devices used in

0.MLookup: CareRegisteredDevice

PatientMedicalProcedureDetail.DetailRecordId

usedReference

a procedure, and reference the parent procedurerecord.

Use the PatientMedicalProcedureDetail child object to specify codes for items

0.MN/APatientMedicalProcedureDetail.DetailCodeId

usedCode

used in a procedure, and reference the parentprocedure record.


1371


SEE ALSO:

CarePerformer

PatientMedicalProcedure


RelatedPersonThe relatedPerson FHIR resource maps to the Account and Contact objects in Salesforce, and is connected to the personthat person’s related to using the ContactContactRelation__c object.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for RelatedPerson map to the fields in Salesforce.

Table 28: RelatedPerson - Salesforce


TypeSalesforce FieldRelatedPersonResource

The identifier information for a related person isrepresented as Identifier records that


reference the related person’s person accountusing their Identifier.ParentRecordId field.


Though Salesforce can tehnically accommodatepatient as a zero-to-many association, it is

1.1Lookup:Contact

ContactContactRelation__c.Contact__c

patient

recommended to align with the FHIR definedone-to-one association.

While FHIR defines relatedPerson.relationship as a code set bundle, its

0.MLookup:ReciprocalRole__c


relationship

1372


https://www.hl7.org/fhir/relatedperson.html



Salesforce implementation is a reference toReicprocalRole__c.

The name information for a related person isrepresented as PersonName records that


reference the related person’s person accountusing their PersonName.ParentRecordId field.

The telecom information for a related person isrepresented as ContactPointPhone records


that reference the related person’s person accountusing their ContactPointPhone.ParentId field.

While FHIR defines relatedPerson.gender as a code set, its Salesforceimplementation is a picklist.



The address information for a related person isrepresented as ContactPointAddress


records that reference the related person’s personaccount using their ContactPointAddress.ParentId field.


Because Salesforce doesn’t support a native perioddata type, the relatedPerson.period

0.1DateContactContactRelation__c.StartDate__c

period

FHIR resource is flattened to a set of strart and enddates.

0.1DateContactContactRelation__c.EndDate__c

The language information for a related person isrepresented as PersonLanguage records


that reference the related person’s person accountusing their PersonLanguage.IndividualId field.

While FHIR defines relatedPerson.communication.language as a code

0.1PicklistPersonLanguage.Language

communication.language

set bundle, its Salesforce implementation is apicklist.

While FHIR defines relatedPerson.communication.preferred as a

0.1DoublePersonLanguage.Rankcommunication.preferred

1373




boolean, its Salesforce implementation is aninteger field that ranks the degree of preference.

ServiceRequestThe serviceRequest FHIR resource maps to the ClinicalServiceRequest and ClinicalServiceRequestDetail objects in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for serviceRequest map to the fields in Salesforce.

Table 29: serviceRequest - Salesforce


TypeSalesforce FieldServiceRequestResource

The identifier information for a service request isrepresented as Identifier records that


reference the ClinicalServiceRequestrecord using their Identifier.ParentRecordId field.



The information about the service request ormedication request that a service request is based

0.MObjectClinicalServiceRequestDetail

basedOn

on is represented as ClinicalServiceRequestDetail records that reference theClinicalServiceRequest record usingtheir ClinicalServiceRequestDetail.ClinicalServiceRequestId field.

The Salesforce implementation of serviceRequest.basedOn doesn’t supportreferences to care plans.

For serviceRequest.basedOninformation, ClinicalServiceRequest

0.1PolymorphicLookup:Clinical

ClinicalServiceRequestDetail.DetailRecordId Detail.DetailRecordId must reference

a ClinicalServiceRequest orMedicationRequest record.

ServiceRequest,MedicationRequest

1374


https://www.hl7.org/fhir/servicerequest.html



For serviceRequest.basedOninformation, ClinicalServiceRequest

0.1Picklist

Value: BasedOn

ClinicalServiceRequestDetail.DetailType Detail.DetailType must use the value

Based On.

While FHIR defines serviceRequest.replaces as a zero-to-many resource, theSalesforce implementation is zero-to-one.

0.1Lookup:ClinicalServiceRequest

ClinicalServiceRequest.OriginalRequestId

replaces

N/A0.1Lookup:Identifier

ClinicalServiceRequest.ServiceRequestGroupIdentifierId

requisition

While FHIR defines serviceRequest.status as a code set bundle, the Salesforce

1.1PicklistClinicalServiceRequest.Status

status

implementation of ClinicalServiceRequest.Status is picklist.

While FHIR defines serviceRequest.intent as a code set bundle, the Salesforce

1.1PicklistClinicalServiceRequest.Type

intent

implementation of ClinicalServiceRequest.Type is picklist.


ClinicalServiceRequest.CategoryId

category

While FHIR defines serviceRequest.priority as a code set bundle, the

0.1PicklistClinicalServiceRequest.Priority

priority

Salesforce implementation of ClinicalServiceRequest.Priority is picklist.

N/A0.1BooleanClinicalServiceRequest.IsIgnored

doNotPerform


ClinicalServiceRequest.RequestCodeId

code

Not SupportedN/AN/AN/AorderDetail

Because Salesforce doesn’t support a nativequantity data type, the implementation of

0.1DoubleClinicalServiceRequest.QuantityNumerator

quantity.quantityQuantity serviceRequest.quantity

.quantityQuantity is flattened into a setof quantity and unit fields.

1375





ClinicalServiceRequest.QuantityNumeratorUnitId

Because Salesforce doesn’t support a native ratiodata type, the implementation of service


quantity.quantityRatio Request.quantity.quantityRatio

is flattened into a set of numerator, denominatorand unit fields.0.1DoubleClinicalService

Request.QuantityDenominator



For serviceRequest.quantity.quantityRatio information, Clinical

0.1Picklist

Value: Ratio

ClinicalServiceRequest.QuantityType

ServiceRequest.QuantityType mustuse the value Ratio.

Because Salesforce doesn’t support a native rangedata type, the implementation of service


quantity.quantityRange Request.quantity.quantityRange

is flattened into a set of numerator, denominatorand unit fields.0.1DoubleClinicalService

Request.QuantityDenominator



For serviceRequest.quantity.quantityRange information, Clinical

0.1Picklist

Value: Range

ClinicalServiceRequest.QuantityType

ServiceRequest.QuantityType mustuse the value Range.


ClinicalServiceRequest.PatientId

subject


ClinicalServiceRequest.ClinicalEncounterId

encounter

ClinicalServiceRequest.StartDateis used for both serviceRequest

0.1DateTimeClinicalServiceRequest.StartDate

occurrence.occurrenceDateTime .occurrence.occurrenceDateTime

and serviceRequest.occurrence

1376




.occurrencePeriod. For the latter, the fieldis used to represent the start date of the period.

Because Salesforce doesn’t support a native perioddata type, the serviceRequest

0.1DateTimeClinicalServiceRequest.StartDate

occurrence.occurrencePeriod .occurrence.occurrencePeriod is

flattened into a set of start date and end datefields.

0.1DateTimeClinicalServiceRequest.EndDate

Not supportedN/AN/AN/Aoccurrence.occurrenceTiming

N/A0.1BooleanClinicalServiceRequest.HasPrerequisites

asNeeded.asNeededBoolean

0.10.1Lookup:CodeSetBundle

ClinicalServiceRequest.PrerequisiteCodeId

asNeeded.asNeededCodeableConcept

N/A0.1DateTimeClinicalServiceRequest.DateSigned

authoredOn


ClinicalServiceRequest.RequesterId

requester

Account,Asset,CareRegisteredDevice, andHealthcareProvider


ClinicalServiceRequest.PerformerTypeId

performerType

References to care teams and healthcare servicesare not supported.


ClinicalServiceRequest.PerformerId

performer

While FHIR defines serviceRequest.performer as a zero-to-many resource, theSalesforce implementation is zero-to-one.

Asset,CareRegisteredDevice, andHealthcareProvider

1377




While FHIR defines serviceRequest.locationCode as a zero-to-many resource,the Salesforce implementation is zero-to-one.


ClinicalServiceRequest.FacilityCodeId

locationCode

While FHIR defines serviceRequest.locationReference as a zero-to-many


ClinicalServiceRequest.FacilityId

locationReference

resource, the Salesforce implementation iszero-to-one.

While FHIR defines serviceRequest.reasonCode as a zero-to-many resource,the Salesforce implementation is zero-to-one.


ClinicalServiceRequest.ReasonCodeId

reasonCode

N/A0.1Lookup:DiagnosticSummary

ClinicalServiceRequest.DiagnosticReportId

reasonReference

To support zero-to-many values, use the childobject instead.


ClinicalServiceRequest.ConditionId

To support zero-to-many values, use the childobject instead.


ClinicalServiceRequest.ObservationId

The records referencing the reasons for a servicerequest are represented as Clinical


ServiceRequestDetail records thatreference the ClinicalServiceRequestrecord using their ClinicalServiceRequestDetail.ClinicalServiceRequestId field.

For serviceRequest.reasonReference information, Clinical


ClinicalServiceRequestDetail.DetailRecordId ServiceRequestDetail.Detail

RecordId must reference a HealthCondition,Care Condition or CareObservation record

.Observation,DiagnosticSummary

For serviceRequest.reasonReference information, Clinical

0.1Picklist

Value: ReasonReference

ClinicalServiceRequestDetail.DetailType ServiceRequestDetail.DetailType

must use the value Reason Reference.

Not supportedN/AN/AN/Ainsurance

1378




Not supportedN/AN/AN/AsupportingInfo


The body site information of a serviceRequest isrepresented as ClinicalServiceRequest


bodySite

Detail records that reference the ClinicalServiceRequest record using theirClinicalServiceRequestDetail.ClinicalServiceRequestId field.

For serviceRequest.bodySiteinformation, ClinicalServiceRequest


ClinicalServiceRequestDetail.DetailCodeId Detail.DetailCodeId must reference a

CodeSet or CodeSetBundle record.CodeSetBundle

For serviceRequest.bodySiteinformation, ClinicalServiceRequest

0.1Picklist

Value: BodySite

ClinicalServiceRequestDetail.DetailType Detail.DetailType must use the value

Body Site.

Not supportedN/AN/AN/ANote

N/A0.1TextClinicalServiceRequest.PatientInstruction

patientInstruction

Not supportedN/AN/AN/ArelevantHistory


1379


SEE ALSO:



TimingThe Timing FHIR resource maps to the ActivityTiming object in Salesforce.

FHIR V4.0 - Clinical Data Model MappingHere’s how the fields defined by FHIR for Timing map to the fields in Salesforce.

Table 30: Timing - Salesforce


TypeSalesforce FieldTimingResource

timing.event is stored in Event.ActivityDate. This event record then

0.MObjectEvent.ActivityDateevent

references the ActivityTiming record using itsWhatId field.

Because Salesforce doesn’t support a nativeduration data type, repeat.bounds

0.1IntActivityTiming.PeriodLength

repeat.bounds.boundsDuration

.boundsDuration is flattened to a set oflength and unit fields.0.1Lookup: UnitOf

MeasureActivityTiming.PeriodLengthUnitId

Because Salesforce doesn’t support a nativeduration data type, repeat.bounds

0.1DoubleActivityTiming.PeriodLengthLowerLimit

repeat.bounds.boundsRange

.boundsRange is flattened to a set of lowerlimit, upper limit, and unit fields.0.1DoubleActivityTiming.Period

LengthUpperLimit

1380


https://www.hl7.org/fhir/datatypes.html#Timing



0.1Lookup: UnitOfMeasure

ActivityTiming.PeriodLengthUnitId

Because Salesforce doesn’t support a native perioddata type, repeat.bounds.bounds

0.1DateTimeActivityTiming.PeriodStartDateTime

repeat.bounds.boundsPeriod

Period is flattened to a set of start and enddate fields.0.1DateTimeActivityTiming.Period

EndDateTime

N/A0.1IntActivityTiming.CountInPeriod

repeat.count

N/A0.1IntActivityTiming.MaxCountInPeriod

repeat.countMax

N/A0.1DoubleActivityTiming.ActivityDuration

repeat.duration

N/A0.1DoubleActivityTiming.MaxActivityDuration

repeat.durationMax

N/A0.1Lookup: UnitOfMeasure

ActivityTiming.ActivityDurationUnitId

repeat.durationUnit

N/A0.1DoubleActivityTiming.ActivityCountPerRepetition

repeat.frequency

N/A0.1IntActivityTiming.MaxActivityCountPerRepetition

repeat.frequencyMax

N/A0.1DoubleActivityTiming.RepetitionCycleLength

repeat.period

N/A0.1DoubleActivityTiming.MaxRepetitionCycleLength

repeat.periodMax

N/A0.1Lookup: UnitOfMeasure

ActivityTiming.RepetitionCycleUnitId

repeat.periodUnit

While FHIR defines repeat.dayOfWeek asa code value, the Salesforce implementation uses

0.MLookup:OperatingHours

ActivityTiming.WeeklyActivityTimeId

repeat.dayOfWeek a reference to OperatingHours. A record in

OperatingHours can have multiple values for daysin a week and time.

1381




N/A0.MLookup:OperatingHours

ActivityTiming.WeeklyActivityTimeId

repeat.timeOfDay

While FHIR defines repeat.when as azero-to-many code, the Salesforceimplementation is a zero-to-one picklist.

0.1PicklistActivityTiming.ActivityTime

repeat.when

N/A0.1IntActivityTiming.ActivityTimeOffset

repeat.offset


ActivityTiming.TimingCodeId

code

Store HL7 v2.3 Messages in Salesforce Standard ObjectsLike the Fast Health Interoperability Resources (FHIR) standard defined by Health Level Seven (HL7), HL7 v2.3 is also a database frameworkdefined by HL7 to facilitate interoperability between electronic healthcare systems. Because Health Cloud’s Clinical Data Model was builtto align with FHIR v4.0, it is also compatible with its predecessor HL7 v2.3. However, because of the way the Salesforce platform works,the Salesforce implementation varies from the HL7 recommendations in certain cases such as the data types that are used.

Here are some HL7 messages and their segments that are supported in Salesforce standard objects.

HL7 v2.3 Messages Supported in Salesforce Standard Objects

Salesforce Standard objects support ADT, ORM, ORU, MDM, VXU, and RDE messages from HL7 v2.3 based systems.

HL7 v2.3 Segments Supported in Salesforce Standard Objects

Salesforce Standard objects support the following segments in HL7 v2.3.

HL7 v2.3 Data Types Supported in Salesforce Standard Objects

Salesforce Standard objects support the following data types defined in HL7 v2.3.

HL7 v2.3 Messages Supported in Salesforce Standard ObjectsSalesforce Standard objects support ADT, ORM, ORU, MDM, VXU, and RDE messages from HL7 v2.3 based systems.

These messages can be stored in Salesforce by mapping their constituent segments to fields in Salesforce standard objects.

• Admission, Discharge, and Transfer (ADT)

– Patient Identification (PID) on page 1390

– Patient Visit (PV1) on page 1392

– Patient Visit - Additional Information (PV2) on page 1394

– Observation Segment (OBX) on page 1386

– Patient Allergy Information (AL1) on page 1384

• Order Message (ORM_O01)


1382

Store HL7 v2.3 Messages in Salesforce Standard ObjectsHealth Cloud Developer Guide




– Common Order Segment (ORC) on page 1389

• Unsolicited Transmission of an Observation Message (ORU_R01)





– Observation Request Segment (OBR) on page 1385


• Unsolicited Vaccination Record Update (VXU_V04)





– Pharmacy Administration Segment (RXA) on page 1395

– Pharmacy Route Segment (RXR) on page 1397


• Pharmacy/Treatment Encoded Order Message (RDE_O01)






– Pharmacy Encoded Order Segment (RXE) on page 1396

– Pharmacy Route Segment (RXR) on page 1397

– Pharmacy Component Order Segment (RXC) on page 1396


HL7 v2.3 Segments Supported in Salesforce Standard ObjectsSalesforce Standard objects support the following segments in HL7 v2.3.

AL1 - Patient Allergy Information

The Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce.

OBR - Observation Request Segment

The Observation Request Segment (OBR) HL7 segment maps primarily to the ClinicalServiceRequest,DiagnosticSummary, and PatientMEdicalProcedure objects in Salesforce.

1383


OBX - Observation Segment

The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.

ORC - Common Order Segment

The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest andMedicationRequest objects in Salesforce.

PID - Patient Identification

The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.

PV1 - Patient Visit

The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.

PV2 - Patient Visit - Additional Information

The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.

RXA - Pharmacy Administration Segment

The Pharmacy Administration Segment (RXA) HL7 segment maps primarily to the PatientImmunization and Medicationobjects in Salesforce.

RXC - Pharmacy Component Order Segment

The Pharmacy Component Order Segment (RXC) HL7 segment maps to the Medication and MedicationRequestobjectsin Salesforce.

RXE - Pharmacy Encoded Order Segment

The Pharmacy Encoded Order Segment (RXE) HL7 segment maps primarily to the Medication object in Salesforce.

RXR - Pharmacy Route Segment

The Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization andPatientMedicationDosage objects in Salesforce.

AL1 - Patient Allergy InformationThe Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce.

HL7 V2.3 - Clinical Data Model Mapping

Here’s how the segments defined by HL7 V2.3 for AL1 map to fields in Salesforce standard objects.

Note: Only the segments supported by Salesforce are mentioned below.

Table 31: AL1 - Salesforce

NotesTypeSalesforce FieldAL1

N/APicklistAllergyIntolerance.CategoryAL1.2 - Allergy Type

N/ALookup: CodeSetBundleAllergyIntolerance.CodeIdAL1.3 - Allergy Code/Mnemonic/Description

N/APicklistPatientHealthReaction.Severity

AL1.4 - Allergy Severity

N/ALookup: CodeSetBundlePatientHealthReaction.ManifestedSymptomId

AL1.5 - Allergy Reaction

1384


NotesTypeSalesforce FieldAL1

N/ADateTimeonset.onsetDateTimeAL1.6 - Identification Date

OBR - Observation Request SegmentThe Observation Request Segment (OBR) HL7 segment maps primarily to the ClinicalServiceRequest,DiagnosticSummary, and PatientMEdicalProcedure objects in Salesforce.


Here’s how the segments defined by HL7 V2.3 for OBR map to fields in Salesforce standard objects.


Table 32: OBR - Salesforce

NotesTypeSalesforce FieldOBR

Place Order Number is createdas an identifier record. This

ObjectIdentifierOBR.2 - Place Order Number

record will then reference theentity it belongs to using theParentRecordId field.

Fill Order Number is created asan identifier record. This record

ObjectIdentifierOBR.3 - Fill Order Number

will then reference the entity itbelongs to using theParentRecordId field.

N/ALookup: CodeSetBundleOBR.4 - Universal Service Id • ClinicalServiceRequest.RequestCodeId

• PatientMedicalProcedure.CodeId

• DiagnosticSummary.CodeId

N/APicklistsOBR.5 - Order Status • ClinicalServiceRequest.Status

• MedicationRequest.Status

N/ADoublePatientMedicalProcedure.StartDate

OBR.7 - Observation Date/Time

N/ALookup: HealthcareProvider,Account, Asset


OBR.16 - Ordering Provider

1385


NotesTypeSalesforce FieldOBR

N/aDateTimeDiagnosticSummary.IssuedDateTime

OBR.22 - Results Rpt/StatusChng - Date/Time

N/AOBR.24 - Diagnostic ServiceSection ID

•• Lookup: CodeSetBundleClinicalServiceRequest.CategoryId • Picklist

• DiagnosticSummary.CategoryId

N/APicklistOBR.25 - Result Status • PatientMedicalProcedure.Status

• DiagnosticSummary.Status

N/ADoubleClinicalServiceRequest.QuantityNumerator

OBR.27 - Quantity/Timing

N/ADoubleClinicalServiceRequest.QuantityDenominator

N/ALookup: UnitOfMeasureClinicalServiceRequest.QuantityNumeratorUnitId

N/ALookup: CodeSetBundlePatientMedicalProcedure.ReasonCodeId

OBR.31 - Reason For Study

N/ALookup: CarePerformerDiagnosticSummary.InterpretedById

OBR-32 - Principal ResultInterpreter

OBX - Observation SegmentThe Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for OBX map to fields in Salesforce standard objects.

Note: Only the Segments supported by Salesforce are mentioned below.

Table 33: OBX - Salesforce

NotesTypeSalesforce FieldOBX

N/APicklistCareObservation.ObservedValueTypeOBX.2 - Value Type

1386



N/ALookup: CodeSetBundleCareObservation.CodeId

OBX.3 - Observation Identifier

N/ALookup: CodeSetBundleCareObservationComponent.ComponentTypeCodeId

N/AMultiple Data types; Refer Objectreference documentation

OBX.5 - Observation Value • CareObservation.ObservedValueNumerator

• CareObservation.ObservedValueDenominator

• CareObservation.ObservedValueCodeId

• CareObservation.ObservedValueText

• CareObservation.IsObserved

• CareObservation.ObservationStartTime

• CareObservation.ObservationEndTime

• CareObservationComponent.ObservedValueNumerator

• CareObservationComponent.ObservedValueDenominator

• CareObservationComponent.ObservedValueCodeId

• CareObservationComponent.ObservedValueText

• CareObservationComponent.IsObserved

• CareObservationComponent.

1387




• CareObservationComponent.ObservationEndTime

• Attachment.ContentType

• Attachment.Body

• PatientMedicalProcedure.ReportId

N/ALookup: UnitOfMeasureOBX.6 - Units • CareObservation.ObservedValueUnitId

• CareObservationComponent.ObservedValueUnitId

N/ADoubleOBX.7 - Reference Range • CareObservation.LowerBaselineValue

• CareObservation.UpperBaselineValue

• CareObservationComponent.LowerBaselineValue

• CareObservationComponent.UpperBaselineValue

N/ALookup: CodeSetBundleOBX.8 - Abnormal Flags • CareObservation.ValueInterpretation

• CareObservationComponent.ValueInterpretation

N/APicklistCareObservation.ObservationStatusOBX.11 - Observation ResultStatus

N/ADateTimeCareObservation.IssuedDateTimeOBX.14 - Date/Time of theObservation

1388



N/ALookup: HealthcareProvider,Account

CareObservation.ObserverIdOBX.16 - Responsible Observer

The performer information for aProcedure is represented as Care

ObjectCarePerformer

Performer records that referencethe PatientMedicalProcedurerecord using their CarePerformer.ParentRecordId field.

N/ALookup: CodeSetBundleCareObservation.MethodIdOBX.17 - Observation Method

ORC - Common Order SegmentThe Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequestobjects in Salesforce.


Here’s how the segments defined by HL7 V2.3 for ORC map to fields in Salesforce standard objects.


Table 34: ORC - Salesforce

NotesTypeSalesforce FieldORC

N/APicklistsORC.1 - Order Control • ClinicalServiceRequest.Status


Place Order Number is createdas an identifier record. This

ObjectIdentifierORC.2 - Place Order Number

record will then reference theentity it belongs to using theParentRecordId field.

Fill Order Number is created asan identifier record. This record

ObjectIdentifierORC.3 - Fill Order Number

will then reference the entity itbelongs to using theParentRecordId field.

N/ALookup: IdentifierClinicalServiceRequest.Service

ORC.4 - Placer Group Number

RequestGroupIdentifierId

1389


NotesTypeSalesforce FieldORC

N/APicklistsORC.5 - Order Status • ClinicalServiceRequest.Status


N/ADoubleClinicalServiceRequest.QuantityNumerator

ORC.7 - Quantity/Timing

N/ADoubleClinicalServiceRequest.QuantityDenominator

N/ALookup: UnitOfMeasureClinicalServiceRequest.QuantityNumeratorUnitId

N/ADateTimeClinicalServiceRequest.DateSigned

ORC.9 - Date and Time ofTransaction

N/ALookup: HealthcareProvider,Account, Asset


ORC.12 - Ordering Provider

N/aLookup: CodeSetBundleORC.12 - Order Control CodeReason

• ClinicalServiceRequest.ReasonCodeId

• MedicationRequest.StatusReasonCodeId

PID - Patient IdentificationThe Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for PID map to fields in Salesforce standard objects.


Table 35: PID - Salesforce

NotesTypeSalesforce FieldPID

The identifier record for thepatient is associated to the

ObjectIdentifierPID.2 - Patient ID (External ID)

patient by referencing thepatient’s account record using

1390



the ParentRecordId field inIdentifier.


ObjectIdentifierPID.3 - Patient ID (Internal ID)

patient by referencing thepatient’s account record usingthe ParentRecordId field inIdentifier.


ObjectIdentifierPID.4 - Alternate Patient ID

patient by referencing thepatient’s account record usingthe ParentRecordId field inIdentifier.

The name information for apatient is represented as Person

ObjectPersonNamePID.5 - Patient Name

Name records that reference thepatient record using their PersonName.ParentRecordId field.

Salesforce supports only thedate of birth. The time of birthisn’t supported.

DateContact.BirthDatePID.7 - Date/Time of Birth

N/APicklistContact.GenderPID.8 - Sex


ObjectPersonNamePID.9 - Patient Alias

Name records that reference thepatient record using their PersonName.ParentRecordId field.

The address information for apatient is represented as Contact

ObjectContactPointAddressPID.11 - Patient Address

PointAddress records thatreference the patient recordusing their ContactPointAddress.ParentId field.

The telecom information for apatient is represented as Contact

ObjectContactPointPhonePID.13 - Home Phone

PointPhone records thatreference the patient recordusing their ContactPointPhone.ParentId field.

The telecom information for apatient is represented as Contact

ObjectContactPointPhonePID.14 - Work Phone

1391



PointPhone records thatreference the patient recordusing their ContactPointPhone.ParentId field.


ObjectPersonLanguagePID.15 - Primary Langauge

Name records that reference thepatient record using their PersonLanguage.IndividualId field.

N/APicklistContact.MaritalStatusPID.16 - Marital Status

N/ADoubleContact.SequenceInMultipleBirth

PID.25 - Multiple Birth Indicator

N/ADateTimeContact.DeceasedDatePID.29 - Patient Death Date andTime

PV1 - Patient VisitThe Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.


Here’s how the segments defined by HL7 V2.3 for PV1 map to fields in Salesforce standard objects.


Table 36: PV1 - Salesforce

NotesTypeSalesforce FieldPV1

N/APicklistClinicalEncounter.Category

PV1.2 - Patient Class

The facility information for apatient visit is represented as

ObjectClinicalEncounterFacility

PV1.3 - Assigned PatientLocation

ClinicalEncounterFacility records thatreference the encounter recordusing their ClinicalEncounterFacility.ClinicalEncounterIdfield.

N/ALookup: CodeSetBundleClinicalEncounter.TypeId

PV1.4 - Admission Type

N/ALookup: IdentifierClinicalEncounter.PreAdmissionIdentifierId

PV1.5 - Preadmit Number

1392



The participant information foran encounter is represented as

ObjectClinicalEncounterProvider

PV1.7 - Attending Doctor

ClinicalEncounterProviderrecords that reference theencounter record using theirClinicalEncounterProvider.ClinicalEncounterId field.



PV1.8 - Referring Doctor




PV1.9 - Consulting Doctor


N/APicklistClinicalEncounter.ServiceType

PV1.10 - Hospital Service

N/ALookup: CodeSetBundleClinicalEncounter.ReadmissionCodeId

PV1.13 - Readmission Indicator

N/APicklistClinicalEncounter.AdmissionSource

PV1.14 - Admit Source

N/APicklistClinicalEncounter.SpecialCourtesy

PV1.16 - VIP Indicator



PV1.17 - Admitting Doctor


N/ALookup: CodeSetBundleClinicalEncounter.TypeId

PV1.18 - Patient Type

The identifier information for anencounter is represented as

ObjectClinicalEncounterIdentifier

PV1.19 - Visit Identifier

ClinicalEncounterIdentifierrecords that reference the

1393



encounter record using theirClinicalEncounterIdentifier.ParentRecordId field.

N/APicklistClinicalEncounter.SpecialCourtesy

PV1.22 - Courtesy Code

N/ALookup: CodeSetBundleClinicalEncounter.DischargeDispositionId

PV1.36 - Discharge Disposition

N/ALookup: HealthcareFacilityClinicalEncounter.DestinationFacilityId

PV1.37 - Discharged to Location

N/ALookup: AccountClinicalEncounter.DestinationOrganizationId

N/APicklistClinicalEncounter.DietPreference

PV1.38 - Diet Type

N/ADateTimeClinicalEncounter.StartDate

PV1.44 - Admit Date/Time

N/ADateTimeClinicalEncounter.EndDate

PV1.45 - Discharge Date/Time

The identifier information for anencounter is represented as

ObjectClinicalEncounterIdentifier

PV1.50 - Alternate Visit ID

ClinicalEncounterIdentifierrecords that reference theencounter record using theirClinicalEncounterIdentifier.ParentRecordId field.

PV2 - Patient Visit - Additional InformationThe Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for PV2 map to fields in Salesforce standard objects.


Table 37: PV2 - Salesforce


N/ALookup: CodeSetBundleClinicalEncounterReason.ReasonCodeId

PV2.3 - Admit Reason

1394



N/ALookup: CodeSetBundleClinicalAlert.CodeIdPV2.7 - Visit User Code

N/ADoubleClinicalEncounter.Duration

PV2.11 - Actual Length ofInpatient Stay

N/ALookup: UnitOfMeasureClinicalEncounter.DurationUnitId

N/ALookup: CodeSetBundleClinicalEncounter.PriorityId

PV2.25 - Patient Status Code

RXA - Pharmacy Administration SegmentThe Pharmacy Administration Segment (RXA) HL7 segment maps primarily to the PatientImmunization and Medicationobjects in Salesforce.


Here’s how the segments defined by HL7 V2.3 for RXA map to fields in Salesforce standard objects.


Table 38: RXA - Salesforce

NotesTypeSalesforce FieldRXA

N/ADateTimePatientImmunization.VaccinationDate

RXA.3 - Date/Time Start ofAdministration

N/ALookup: CodeSetBundleRXA.5 - Administered Code • PatientImmunization.VaccineCodeId

• Medication.MedicationCodeId

N/ADoublePatientImmunization.Dose

RXA.6 - Administered Amount

N/ALookup:UnitOfMeasurePatientImmunization.DoseUnitId

RXA.7 - Administered Unit

N/ALookup: CodeSetBundleMedication.MedicationFormId

RXA.8 - Administered DosageForm

The performer information foran immunization is represented

ObjectCarePerformerRXA.10 - Administering Provider

as CarePerformer records thatreference the PatientImmunization record using their

1395


NotesTypeSalesforce FieldRXA

CarePerformer.ParentRecordId field.

N/ALookup: Healthcare FacilityPatientImmunization.FacilityId

RXA.11 - Administered-atLocation

N/AStringPatientImmunization.LotNumber

RXA.15 - Substance Lot Number

N/ADateTimePatientImmunization.ExpirationDate

RXA.16 - Substance ExpirationDate

N/ARXA.17 - SubstanceManufacturer Name

•• StringPatientImmunization.Manufacturer

• Lookup: Account

• Medication.ManufacturerId

N/APatientImmunization.StatusReasonCodeId

RXA.18 - Substance RefusalReason

• Lookup: CodeSetBundle

N/APicklistPatientImmunization.Status

RXA.20 - Completion Status

RXC - Pharmacy Component Order SegmentThe Pharmacy Component Order Segment (RXC) HL7 segment maps to the Medication and MedicationRequestobjects inSalesforce.


Here’s how the segments defined by HL7 V2.3 for RXC map to fields in Salesforce standard objects.


Table 39: RXC - Salesforce

NotesTypeSalesforce FieldRXC

N/ALookup: CodeSetBundleRXC.2 - Component Code • Medication.MedicationCodeId

• MedicationRequest.MedicationCodeId

RXE - Pharmacy Encoded Order SegmentThe Pharmacy Encoded Order Segment (RXE) HL7 segment maps primarily to the Medication object in Salesforce.

1396



Here’s how the segments defined by HL7 V2.3 for RXE map to fields in Salesforce standard objects.


Table 40: RXE - Salesforce

NotesTypeSalesforce FieldRXE

N/ALookup: CodeSetBundleMedication.MedicationCodeId

RXE.2 - Give Code

N/ALookup: CodeSetBundleMedication.MedicationFormId

RXE.2 - Give Dosage Form

RXR - Pharmacy Route SegmentThe Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization andPatientMedicationDosage objects in Salesforce.


Here’s how the segments defined by HL7 V2.3 for RXR map to fields in Salesforce standard objects.


Table 41: RXR - Salesforce

NotesTypeSalesforce FieldRXR

N/ALookup: CodeSetBundleRXR.1 - Route • PatientImmunization.RouteId

• PatientMedicationDosage.RouteId

N/ALookup: CodeSetBundleRXR.2 - Site • PatientImmunization.SiteId

• PatientMedicationDosage.SiteId

N/ALookup: CodeSetBundlePatientMedicationDosage.MethodId

RXR.4 - Administration Method

HL7 v2.3 Data Types Supported in Salesforce Standard ObjectsSalesforce Standard objects support the following data types defined in HL7 v2.3.

1397


CE - Coded Element

The Coded Element (CE) HL7 segment maps to the CodeSet object in Salesforce.

CX - Extended Composite ID With Check Digit

The Extended Composite ID With Check Digit (CX) HL7 segment maps to the Identifier object in Salesforce.

XPN - Extended Person Name

The Extended Person Name (XPN) HL7 segment maps to the PersonName object in Salesforce.

XTN - Extended Telecommunication Number

The Extended Telecommunication Number (XTN) HL7 segment maps to the ContactPointPhone object in Salesforce.

CE - Coded ElementThe Coded Element (CE) HL7 segment maps to the CodeSet object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for CE map to fields in Salesforce standard objects.


Table 42: CE - Salesforce

NotesTypeSalesforce FieldCE

N/AStringCodeSet.CodeCE.1 - Identifier

N/AStringCodeSet.NameCE.2 - Text

N/AStringCodeSetBundle.Name

N/AStringCodeSet.SourceSystemCE.3 - Name of Coding System

CX - Extended Composite ID With Check DigitThe Extended Composite ID With Check Digit (CX) HL7 segment maps to the Identifier object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for CX map to fields in Salesforce standard objects.


Table 43: CX - Salesforce

NotesTypeSalesforce FieldCX

N/AStringIdentifier.IdValueCX.1 - ID

N/ALookup: AccountIdentifier.IssuingAuthorityCX.4 - Assigning Authority

N/ALookup: CodeSet, CodeSetBundle

Identifier.IdTypeCX.5 - Identifier Type Code

1398


XPN - Extended Person NameThe Extended Person Name (XPN) HL7 segment maps to the PersonName object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for XPN map to fields in Salesforce standard objects.


Table 44: XPN - Salesforce

NotesTypeSalesforce FieldXPN

In cases where a person has amiddle name,

StringPersonName.LastNameXPN.1 - Family Name

PersonName.LastNameis supposed to store acombination of the middlename and the last name.

N/AStringPersonName.FirstNameXPN.2 - Given Name

This attribute isn’t implementedin PersonName. In cases

N/AN/AXPN.3 - Middle Initial or Name

where a person has a middlename,PersonName.LastNameis supposed to store acombination of the middlename and the last name.

N/AStringPersonName.SuffixXPN.4 - Suffix

N/AStringPersonName.PrefixXPN.5 - Prefix

This attribute isn’t implementedin PersonName.

N/AN/AXPN.6 - Degree

While HL7 defines XPN.7 as acode, Salesforce implements

Dynamic PicklistPersonName.NameUsageTypeXPN.7 - Name Type Code

PersonName.NameUsageTypeas a dynamic picklist.

XTN - Extended Telecommunication NumberThe Extended Telecommunication Number (XTN) HL7 segment maps to the ContactPointPhone object in Salesforce.


Here’s how the segments defined by HL7 V2.3 for XTN map to fields in Salesforce standard objects.


1399


Table 45: XTN - Salesforce

NotesTypeSalesforce FieldXTN

N/APhoneContactPointPhone.TelephoneNumber

XTN.1 - Telephone Number

N/APicklistContactPointPhone.UsageType

XTN.2 - Telecommunication UseCode

N/APicklistContactPointEmail.UsageType

N/APicklistContactPointPhone.PhoneType

XTN.3 - TelecommunicationEquipment Type

N/AEmailContactPointEmail.EmailAddress

XTN.4 - Email Address

Some systems may break downthe phone number into multiple

StringContactPointPhone.AreaCode

XTN.6 - Area/City Code

components, such as countrycode, area code, local number,extension, and so on. In suchcases, the full number may haveto be assembled.

N/AStringContactPointPhone.ExtensionNumber

XTN.8 - Extension

Storing HL7 Admission, Discharge, Transfer (ADT) Data in the PackagedEHR Data ModelThe 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 in the packaged EHR data model. 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.

Note: As the Candidate Patient custom object is being retired, use the Lead object instead of the Candidate Patient object. If youneed a Candidate Patient field that Lead doesn't support, create the fields.

FieldSalesforce ObjectHL7 ElementSEQ

Set ID – Patient ID1

MedicalRecordNumberAccountPatient ID (External ID)2

SourceSystem; IDAccountPatient ID (Internal ID)3

NameAccountPatient Name5

1400

Storing HL7 Admission, Discharge, Transfer (ADT) Data in thePackaged EHR Data Model



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, MaritalStatusLabelEhrPatientMarital Status16

DeceasedEhrPatientPatient Death Indicator30

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.


Set ID - NK1NK1.1

ContactNameContactNK NameNK1.2

AccountNameAccount

Given ame1 (up to 5); FamilyName1 (up to 3)EhrPatientEhrRelatedPerson

RelatedRole, ContactRelationshipContactRelationshipNK1.3

1401




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

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

1402




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.


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, TypeLabelEhrEncounterHospital Service10

HospitalizeReadmissionEhrEncounterRe-admission Indicator13

PractitionerEhrEncounterParticipantAdmitting Doctor17


HospitalizeDischargeDispositionCodeEhrEncounterDischarge Disposition36

HospitalizeDestinationEhrEncounterDischarged to Location37

HospitalizeDietCode, HospitalizeDietLabelEhrEncounterDiet Type38

Location1Description, Location1Name, Location1TypeEhrEncounterPending Location42

Location1Description, Location1Name, Location1TypeEhrEncounterPrior Temporary Location43

HospitalizePeriodStartEhrEncounterAdmit Date/Time44

HospitalizePeriodEndEhrEncounterDischarge Date/Time45

1403



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.


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

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.


SensitivityTypeCode, SensitivityTypeLabel,SensitivityTypeSystem

EhrAllergyIntoleranceAllergen Type Code2

Substance255, SubstanceLongEhrAllergyIntoleranceAllergen Code/Mnemonic/Description3

CriticalityCode, CriticalityLabel, CriticalitySystemEhrAllergyIntoleranceAllergy Severity Code4

Reaction255, ReactionEhrAllergyIntoleranceAllergy Reaction Code5

RecordedDateEhrAllergyIntoleranceIdentification Date6

1404



Storing HL7 Clinical Document Architecture (CDA) Data in the PackagedEHR Data ModelClinical 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

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

1405

Storing HL7 Clinical Document Architecture (CDA) Data in thePackaged EHR Data Model



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


DateAssertedEhrCondition1/22/2011Effective Time: Low Value

1/31/2011Effective Time: High Value

NotesEhrConditionSleep Apnea; Patientexperiencing flu symptomsincluding chills and fever

Narrative Description

CategoryCodeEhrCondition6142004Condition: Code

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.


DateWrittenEhrMedicationPrescription20070312Effective Time: LowValue (Date)

1406




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

DispenseMedicationProductFormCodeEhrMedicationPrescriptionC42998Product Form: Code

DispenseMedicationProductFormLabelEhrMedicationPrescriptionTabletProduct Form:Display Name

DispenseMedicationProductFormSystemEhrMedicationPrescriptionNCI Thesaurus(2.16.840.1.113883.3.26.1.1)

Product Form: CodeSystem

CDA Allergies


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,

1407




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

CDA Immunizations


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

1408



CDA Plan of Care


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)

CDA Procedures and Practitioners


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

1409




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

Location1PostalCodeEhrPractitioner45503Practioner Organization: PostalCode

Location1CountryEhrPractitionerUSPractioner Organization: Country

1005-8Facility: Code

LocationEhrProcedureCardiac Catheterization LabFacility: Display Name

CDA Lab Results


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)"

1410




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 the Packaged EHR DataModelThe 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).

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

1411

Storing HL7 Observation Results (ORU) Data in the PackagedEHR Data Model


FieldSalesforce ObjectORC ElementSeq

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

SourceSystemModifiedEhrProcedureResults Rpt/Status Chng -Date/Time

22

SourceSystemModifiedEhrObservation

Status, StatusCodeEhrObservationResult Status25

PractitionerEhrObservationPrincipal Result Interpreter32

CommentsEhrObservationCollector's Comment39

OBR Note


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.

1412

Storing HL7 Observation Results (ORU) Data in the PackagedEHR Data Model



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

OBX Note


CommentsEhrObservationComment3

Storing FHIR Data in the Packaged EHR Data ModelThe FHIR (Fast Healthcare Interoperability Resources) specification is offered as a consistent, easy to implement, and rigorous mechanismfor exchanging data between healthcare applications. It can be used as a stand-alone data exchange standard or in combination withother standards, such as HL7.

FHIR Patient Resource to Salesforce Account ObjectThe Patient resource in FHIR maps to the Account object and the EhrPatient object in Salesforce. This table shows the target fields in theAccount object.

NotesSalesforce FieldFHIR Field

In the FHIR name object, filter foruse=official.

FirstNamename.given

LastNamename.family

1413

Storing FHIR Data in the Packaged EHR Data ModelHealth Cloud Developer Guide


Active__cactive

Gender__pcgender

Marital_Status__pcmaritalStatus.coding..display

PersonBirthdatebirthDate

Filter for use=home and then foruse=mobile.

PersonHomePhonetelecom.value

In the FHIR Identifier object, filter fortype.coding.code=MR.

MedicalRecordNumber__cidentifier.value

SourceSystemId__cidentifier.value

In the FHIR address object, filter fortype=both or type=postal.

PersonMailingStreetaddress.line

PersonMailingCityaddress.city

PersonMailingStateaddress.state

PersonMailingPostalCodeaddress.postalCode

PersonMailingCountryaddress.country

SEE ALSO:

Health Cloud Fields on Account

FHIR Patient Resource to Salesforce EhrPatient ObjectThe Patient resource in FHIR maps to the EhrPatient object and the Account object in Salesforce. This table shows the target fields in theEhrPatient object.


In the FHIR name object, filter foruse=official.

GivenName1__cname.given

FamilyName1__cname.family

GenderLabel__cgender

Deceased__cdeceasedBoolean

BirthDate__cbirthDate

MaritalStatusLabel__cmaritalStatus.coding.display

In the FHIR identifier object, filter fortype.coding.code=MR.

MedicalRecordNumber__cidentifier.value


SourceSystem__cidentifier.system

In the FHIR address object, filter fortype=both or type=postal.

Address1Line1__caddress.line

1414



Address1City__caddress.city

Address1State__caddress.state

Address1PostalCode__caddress.postalCode

Address1Country__caddress.country

In the FHIR telecom object, thedestination field contains an integer

Telecom[ind]System__ctelecom.system

Telecom[ind]Use__ctelecom.usethat is the index to the telecomrecord.Telecom[ind]Value__ctelecom.value

SEE ALSO:

EhrPatient__c

FHIR Condition Resource to Salesforce EhrCondition ObjectThe FHIR Condition resource maps to the Salesforce EhrCondition object.


A lookup in Health Cloud is done to verifythat this exists.

Idid

Split this value on / and take the part to theright.

Account__csubject.reference

CategoryCode__ccategory.coding.code

CategorySystem__ccategory.coding.system

Code__ccategory.coding.code

CodeLabel__ccategory.coding.display

CodeSystem__ccategory.coding.system

Stage__cstage.summary.coding


In the FHIR Coding object, filter forcode=active.

StatusCode__cclinicalStatus.coding.code

StatusLabel__cclinicalStatus.coding.display

StatusSystem__cclinicalStatus.coding.system

SeverityCode__cseverity.code

SeverityLabel__cseverity.display

SeveritySystem__cseverity.system

1415



EvidenceCode__cevidence.code

EvidenceDetail__cevidence.display

EvidenceLabel__cevidence.display

EvidenceSystem__cevidence.system

SEE ALSO:

EhrCondition__c

FHIR Observation Resource to Salesforce EhrObservation ObjectMap the Observation resource in FHIR to the EhrObservation object in Salesforce.


A lookup in Health Cloud is done to verifythis exists.

Idid

Split this value on / and take the part tothe right.


Status__cstatus

BodySiteCode__cbodySite.coding.code

BodySiteLabel__cbodySite.coding.display

BodySiteSystem__cbodySite.coding.system

Comments__cnote

InterpretationCode__cinterpretation.coding.code

InterpretationLabel__cinterpretation.coding.display

InterpretationSystem__cinterpretation.coding.system

MethodCode__cmethod.coding.code

MethodLabel__cmethod.coding.display

MethodSystem__cmethod.coding.system

ValueCode__cvalueCodeableConcept.coding.code

ValueLabel__cvalueString

ValuePeriodEndDate__cvaluePeriod.end

ValuePeriodStartDate__cvaluePeriod.start

ValueQuantity__cvalueQuantity.value

1416



ValueQuantityUnit__cvalueQuantity.unit

SEE ALSO:

EhrObservation__c

FHIR AllergyIntolerance Resource to Salesforce EhrAllergyIntolerance ObjectThe AllergyIntolerance resource in FHIR maps to the EhrAllergyIntolerance object in Salesforce.


A lookup in Health Cloud is done to verify thatthis exists.

Idid

Split this value on / and take the part to theright.

Account__csubject.reference

CriticalityCode__ccriticality

Code is concatenated for display and is limitedto 255 characters.

Reaction255__creaction.manifestation.coding.code/display

Reaction__creaction.manifestation.coding.display


SubstanceCode__ccode.coding.code

Substance255__ccode.coding.display

CriticalityLabel__ccriticality

StatusLabel__cverificationStatus.coding.code

SEE ALSO:

EhrAllergyIntolerance__c

Emergency Response Management

Use the objects, fields, and metadata that extend Salesforce for Emergency Response Management.

Emergency Response Management Standard and Custom Objects

Salesforce Emergency Response Management provides a rich set of standard and custom objects to store and access emergencyresponse information.

Emergency Response Management Custom Fields on Standard Objects

Emergency Response Management adds custom fields to some standard Salesforce objects.

1417

Emergency Response ManagementHealth Cloud Developer Guide

Emergency Response Management Business APIs

Use Business APIs for building integrations or for creating custom UI components. The APIs wrap complex business logic by executingmultiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as loading detailsof contact encounters into the system.

Emergency Response Management Standard and Custom ObjectsSalesforce Emergency Response Management provides a rich set of standard and custom objects to store and access emergency responseinformation.

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.

ClinicalAssessmentResponse__c

Represents the results of an assessment of a patient’s health condition.

ContactEncounter

Represents a period of time during which two or more people were in close proximity to each other.

ContactEncounterParticipant

Represents a person who was present during a contact encounter.

HousingAssessment__c

Represents the settings for assessing the living situation of individuals. This object is available in API version 49.0 and later.

Visit

Represents a visit to inspect or assess an applicant’s ability to perform an emergency service.

ClinicalAssessmentResponse__cRepresents the results of an assessment of a patient’s health condition.


Fields

DetailsField

Typestring

AbdominalPain__c


DescriptionText describing whether the patient has been experiencing abdominal pain.

1418

Emergency Response Management Standard and CustomObjects


DetailsField

Typestring

CardiovascularDisease__c


DescriptionText describing whether the patient has a history of cardiovascular disease.

Typestring

Chills__c


DescriptionText describing whether the patient has been experiencing chills.

Typestring

ChronicLiverDisease__c


DescriptionText describing whether the patient has a history of chronic liver disease.

Typestring

ChronicLungDisease__c


DescriptionText describing whether the patient has a history of chronic lung disease.

Typestring

ChronicRenalDisease__c


DescriptionText describing whether the patient has a history of chronic renal disease.

Typestring

Cough__c


DescriptionText describing whether the patient has been experiencing new or chronic coughing.

1419



DetailsField

Typestring

CurrentSmoker__c


DescriptionText describing whether the patient currently smokes.

Typestring

DiabetesMellitus__c


DescriptionText describing whether the patient has a history of Diabetes Mellitus.

Typestring

Diarrhoea__c


DescriptionText describing whether the patient has been experiencing diarrhea.

Typestring

FeverOverThreshold__c


DescriptionText describing whether the patient has been experiencing a fever that’s above a giventemperature threshold.

Typestring

FormerSmoker__c


DescriptionText describing whether the patient previously smoked, but no longer does.

Typestring

Headache__c


1420



DetailsField

DescriptionText describing whether the patient is experiencing a headache.

Typedouble

HighestRecordedTemperature__c


DescriptionThe highest recorded temperature in Fahrenheit.

Typepicklist

HospitalizationStatus__c


DescriptionThe status describing whether the person was admitted to the hospital.


• Admitted

• Not_Admitted—Not Admitted

• Unknown

Typestring

Immunocompromised__c


DescriptionText describing whether the patient is immunocompromised.

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate


1421



DetailsField


Typestring

MuscleAches__c


DescriptionText describing whether the patient is experiencing muscle aches (myalgia).

Typestring

Name


DescriptionThe name of this clinical assessment response.

Typestring

NauseaOrVomiting__c


DescriptionText describing whether the patient has been experiencing nausea or vomiting.

Typestring

NeurologicalDisablity__c


DescriptionText describing whether the patient has a history of a specific neurological disability.

Typestring

NeurologicalDisablityNotes__c


DescriptionAdditional text describing the patient’s neurological condition.

Typepicklist

Occupation__c

1422



DetailsField


DescriptionOccupation of the individual.


• Childcare workers—Childcare worker

• Clinical laboratory technologists and technicians—Clinicallaboratory technologist or technician

• Combined food preparation and serving workers, includingfast food—Combined food preparation or serving worker, including fast food

• Dentists—Dentist

• Emergency management directors—Emergency management director

• Emergency medical technicians and paramedics—Emergencymedical technician or paramedic

• Health practitioner support technologists andtechnicians—Health practitioner support technologist or technician

• Healthcare support workers, all other, including medicalequipment preparers—Healthcare support worker (including medical equipmentpreparer)

• Other

Typedate

OnsetOfSymptoms__c


DescriptionThe date when the symptoms started.

Typestring

OtherChronicDiseases__c


DescriptionText describing whether the patient has a history of any other chronic diseases.

Typestring

OtherChronicDiseasesNotes__c


DescriptionAdditional text describing the patient’s other chronic diseases.

1423



DetailsField

Typestring

OtherSymptoms__c


DescriptionText describing whether the patient has been experiencing any other symptoms not specifiedon the assessment form.

Typereference

OwnerId



Typeboolean

ParentalConsent__c


DescriptionIndicates whether consent was provided to interview a minor.

Typereference

Patient__c


DescriptionThe person account or individual whose health condition is described in the assessment.

Typestring

PrimaryCarePhysician__c


DescriptionThe name of the person's primary care physician.

Typestring

ProviderFacilityName__c


1424



DetailsField

DescriptionThe name of the provider of healthcare services such as the hospital, clinic, or medicalpractitioner other than a primary care physician.

Typestring

RunnyNose__c


DescriptionText describing whether the patient has been experiencing a runny nose.

Typestring

ShortnessOfBreath__c


DescriptionText describing whether the patient has been experiencing shortness of breath.

Typestring

SoreThroat__c


DescriptionText describing whether the patient has been experiencing a sore throat.

Typestring

SubjectiveFever__c


DescriptionText describing whether the patient has felt feverish, even if body temperature was notmeasured.

Typestring

TestingFacilityName__c


DescriptionThe name of the facility where the testing was done.

1425



ContactEncounterRepresents a period of time during which two or more people were in close proximity to each other.


Fields

DetailsField

Typedouble

Actual_Participant_Count__c


DescriptionThe confirmed number of people who were present during the encounter.

Typetextarea

Description__c


DescriptionText describing the encounter.

TypedateTime

EndTime__c


DescriptionThe date and time when the encounter ended.

Typedouble

EstimatedParticipantCount__c


DescriptionThe estimated number of people who were present during the encounter.

Typereference

Location__c


1426



DetailsField

DescriptionThe location where the encounter took place.

TypedateTime

StartTime__c


DescriptionThe date and time when the encounter began.

Typedate

LastActivityDate


DescriptionValue is one of the following, whichever is the most recent:

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

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

TypedateTime

LastReferencedDate



TypedateTime

LastViewedDate



Typestring

Name


DescriptionThe name of this contact encounter.

1427



DetailsField

Typereference

OwnerId



ContactEncounterParticipantRepresents a person who was present during a contact encounter.


Fields

DetailsField

Typereference

ContactEncounter__c


DescriptionThe contact encounter that this person was involved in.

Typereference

Contact__c


DescriptionA contact who was involved in the contact encounter.

TypedateTime

EndTime__c


DescriptionThe date and time when the contact encounter ended for this person.

1428



DetailsField

Typereference

Lead__c


DescriptionA lead who was involved in the contact encounter.

TypedateTime

StartTime__c


DescriptionThe date and time when the contact encounter began for this person.

Typedate

LastActivityDate


DescriptionValue is one of the following, whichever is the most recent:

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

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

Typestring

Name


DescriptionAn auto-generated unique ID for this record.

HousingAssessment__cRepresents the settings for assessing the living situation of individuals. This object is available in API version 49.0 and later.


1429



Fields

DetailsField

Typereference

Account__c


DescriptionLookup to the account object.

TypedateTime

AssessmentDate__c


DescriptionDate when the housing assessment took place.

Typeboolean

CanPrepareFoodSafely__c


DescriptionIndicates whether the person can prepare food.

Typeboolean

CanQuarantine__c


DescriptionIndicates whether the person can quarantine effectively.

Typepicklist

Dwelling__c


DescriptionIndicated the type of residence for the person.


• Apartment

• Board and Care or Assisted Living Facility

• Hotel or Motel

• House

1430



DetailsField

• Long-Term Care Facility

• Multi-Family Dwelling

• Nursing Home

• Recreational Vehicle or Mobile Home

• Skilled Nursing Facility

Typeboolean

HasPrivateBathroom__c


DescriptionIndicates whether the person has access to a private bathroom.

Typeboolean

IsHomeless__c


DescriptionIndicates whether the person has a place to live in.

Typestring

Name


DescriptionThe name of the housing assessment.

TypedateTime

QuarantineEndDate__c


DescriptionThe end date of the quarantine period.

Typereference

QuarantineLocation__c


DescriptionThe name of the location where the person must quarantine.

1431



DetailsField

TypedateTime

QuarantineStartDate__c


DescriptionThe start date of the quarantine period.

VisitRepresents a visit to inspect or assess an applicant’s ability to perform an emergency service.


Fields

DetailsField

Typereference

AccountId


DescriptionID of the account.

TypedateTime

ActualVisitEndTime


DescriptionThe date and time when the visit ended.

TypedateTime

ActualVisitStartTime


DescriptionThe date and time when the visit started.

1432



DetailsField

Typereference

ContextId


DescriptionID of the context.

Typetextarea

InstructionDescription


DescriptionSpecial instructions for conducting the visit, if any.

TypedateTime

LastReferencedDate


DescriptionThe most recent date on which a user accessed a record related to this record.

TypedateTime

LastViewedDate



Typestring

Name


DescriptionUnique identifier for the visit record.

Typereference

OwnerId


DescriptionThe ID of the user that owns the record.

1433



DetailsField

Typereference

PlaceId


DescriptionID of the place to be visited.

TypedateTime

PlannedVisitEndTime


DescriptionThe date and time when the visit is expected to end.

TypedateTime

PlannedVisitStartTime


DescriptionThe date and time when the visit is expected to start.

Typepicklist

Status


DescriptionThe status of the visit.


• Abandoned

• Completed

• InProgress

• Planned

Typetextarea

StatusRemarks


DescriptionThe reasons for abandoning or completing the visit as provided by the visiting user.

1434



DetailsField

Typepicklist

VisitPriority


DescriptionThe priority of the visit.


• High

• Low

• Medium

Typereference

VisitTypeId


DescriptionThe type of inspection or assessment conducted during the visit.

Typereference

VisitorId


DescriptionThe ID of the user that performed the visit.

Emergency Response Management Custom Fields on Standard ObjectsEmergency Response Management adds custom fields to some standard Salesforce objects.

Account Custom Fields

Custom fields extend the standard Account object for use in Emergency Response Management.

Contact Custom Fields

Custom fields extend the standard Contact object for use in Emergency Response Management.

Lead Custom Fields

Custom fields extend the standard Lead object for use in Emergency Response Management.

Account Custom FieldsCustom fields extend the standard Account object for use in Emergency Response Management.

1435

Emergency Response Management Custom Fields onStandard Objects


Fields

DetailsField

Typepicklist

ConditionStatus__pc


DescriptionRepresents a person’s condition based on their most recent test or assessment. Possiblevalues are:

• Asymptomatic

• Asymptomatic - Declined to Participate

• Cured

• Evaluated - No Risk

• Symptomatic

• Symptomatic - Declined to Participate

Typepicklist

Monitored_at_Home__pc


DescriptionWhether a person’s condition is being monitored at their home, rather than a clinical setting.Possible values are:

• No

• Yes

Typepicklist

StatusGroup__pc


DescriptionCategorizes a person’s stage within the testing and monitoring process. Possible values are:

• Monitored

• Positive

• Ready for intake

• Unknown

• Unmonitored

Typepicklist

Testing_Status__pc

1436



DetailsField


DescriptionRepresents the result of a person’s most recent test. Possible values are:

• Negative Test

• Positive Test

• Test Results Pending—Test Results Awaited

• Test Scheduled

• Testing Recommended

• Unknown

Contact Custom FieldsCustom fields extend the standard Contact object for use in Emergency Response Management.

Fields

DetailsField

Typepicklist

ConditionStatus__pc


DescriptionRepresents a person’s condition based on their most recent test or assessment. Possiblevalues are:

• Asymptomatic

• Asymptomatic - Declined to Participate

• Cured

• Evaluated - No Risk

• Symptomatic

• Symptomatic - Declined to Participate

Typepicklist

Monitored_at_Home__c


DescriptionWhether a person’s condition is being monitored at their home, rather than a clinical setting.Possible values are:

1437



DetailsField

• No

• Yes

Typepicklist

StatusGroup__c



• Monitored

• Positive


• Unknown

• Unmonitored

Typepicklist

Testing_Status__c


DescriptionRepresents the result of a person’s most recent test. Possible values are:

• Negative Test

• Positive Test

• Test Results Pending—Test Results Awaited

• Test Scheduled

• Testing Recommended

• Unknown

Lead Custom FieldsCustom fields extend the standard Lead object for use in Emergency Response Management.

Fields

DetailsField

Typedate

AppointmentDate


1438



DetailsField

DescriptionDate of the appointment.

Typestring

AppointmentId


DescriptionIdentifier of the appointment.

Typepicklist

StatusGroup__c



• Monitored

• Positive


• Unknown

• Unmonitored

Emergency Response Management Business APIsUse Business APIs for building integrations or for creating custom UI components. The APIs wrap complex business logic by executingmultiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as loading details ofcontact encounters into the system.

Contact Encounter

Load details of contact encounters into the system.

Contact EncounterLoad details of contact encounters into the system.

Prerequisites

• This API must be used only for person account-enabled orgs.

• Ensure that you have access to the Contact Encounter fields and the Contact Encounter Participants fields in your org.

Contact Tracing Encounters and Participants

• To create a new encounter, set the referenceID field to null.

1439

Emergency Response Management Business APIsHealth Cloud Developer Guide

• To update an existing encounter with details of new encounter participants, pass the referenceID of the encounter in thepayload.

• A single payload can have a maximum of 5 encounters.

• A single payload can have a maximum of 50 participants per encounter.

• Encounter participants are not mandatory. If a participant is specified, the participant type is mandatory. If the participant type is setto lead, the participant’s first name and last name are mandatory.

Resource

/services/data/vXX.X/contact-tracing

Available version49.0 and later

AuthenticationAuthorization: Bearer token

Note: The Lightning Platform REST API supports OAuth 2.0 (an open protocol to allow secure API authorization). See AuthorizeApps with OAuth in Salesforce Help for more details.

HTTP methodsPOST

Request body

JSON example

{contactTracingEncounters: [

{"referenceId":"0haRM000000000BYAQ","name":"SF All Hands Q2""estimatedParticipantCount": 10,"startDateTime" : "2020-06-20T00:00:00Z","duration": 12,"description" : "held in SF tower","participants" : [

{"participantType": "lead","recordTypeName": "triage","startTime": "2020-06-20T00:00:00Z","duration": 12,"firstName" : "Leo","lastName" : "Machado","age" : 24,"phoneNumber" : "24323322","emailAddress" : "[email protected]","address":{

"city":"Seattle","state":"Washington","country":"US","postalCode":"11404","street":"Richmond St"

}},{

1440


https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US

https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US

"participantType": "patient""referenceId":"001RM000004iUi8YAE","sourceSystemId":"211453","startTime": "2020-06-20T00:00:00Z","duration": 10,"age" : 34

}],"location" : {

"name":"Seattle County","description":"Gala event","latitude" : "47.6" ,"longitude": "122.3","encounterAddress":{

"city":"Seattle","state":"Washington","country":"US","postalCode":"11404","street":"Dutch St"

}}

}]

}

Properties

DescriptionTypeName

The ID of an existing contact encounter record in theSalesforce system.

StringcontactTracingEncounters.referenceId

Required. The name for the encounter.StringcontactTracingEncounters.name

The estimated number of participants in the encounter.IntegercontactTracingEncounters.estimatedParticipantCount

Required. The start date and time of the encounter. Mustbe in YYYY-MM-DDT HH:MM:SS format. For example,2020-05-18T09:15:00.

DateTimecontactTracingEncounters.startDateTime

Required. The duration of the encounter in minutes.IntegercontactTracingEncounters.duration

The description for the encounter.StringcontactTracingEncounters.description

The list of participants for the contact encounter. Eachelement in the list represents

ListcontactTracingEncounters.participants

ContactEncounterParticipant. Valid valuesare:

• lead

1441


DescriptionTypeName

• employee

• patient

Note: Only one value is allowed.

Required. The encounter participant type. Valid values are:StringcontactTracingEncounters.participants.participantType • Lead— A new lead is created with the specified

participant record type. If the record type does not existin the org, an error message is returned. If the recordtype is not provided n the payload, the default recordtype (triage) is used.

• Employee— The system performs a lookup to theperson account and the record type is ignored. Thislookup can be done in the following ways:

– Using the referenceId that corresponds tothe Salesforce record ID.

– Using sourceSystemId. For an employee, thisID is typically the employee ID or employeenumber. If a match is found, the contact encounterparticipant record is created with the contactfield lookup pointing to the matched personaccount. If a match is not found, this record isrejected and an error message is provided in theresponse.

• Patient—The system performs a lookup to the personaccount and the record type is ignored. This lookupcan be done in the following ways:

– Using the referenceId that corresponds tothe Salesforce record ID.

– Using sourceSystemId. For a patient, this IDis the patient ID from an external source system. Ifa match is found, the contact encounter participantrecord is created with the contact_id lookuppointing to the matched person account. If a matchis not found, this record is rejected and an errormessage is provided in the response.

Note: Only one value is allowed.

The ID of an existing patient or employee record in theSalesforce system. If a payload has both the

StringcontactTracingEncounters.participants.referenceId

referenceID and the sourceSystemID, thereferenceID is used for the patient or the employeelookup.

1442


DescriptionTypeName

For a patient, the patient ID from an external source systemat participant level. For an employee, the employee number

StringcontactTracingEncounters.participants.sourceSystemId

representing the employee record in the Salesforce or theexternal system. If a payload has both the referenceIDand the sourceSystemID, the referenceID isused for the patient or employee lookup.

The name for the record type. The value for this field mustbe exactly the same as the label of the record type in the

StringcontactTracingEncounters.participants.recordTypeName

user interface. This field is used only whencontactTracingEncounters.participants.participantType is set to lead.

The time when the encounter started.DateTimecontactTracingEncounters.participants.startTime

Required. The duration of the encounter in minutes.IntegercontactTracingEncounters.participants.duration

Required. The first name of the participant. This field is usedonly when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.firstName

Note: If participants.referenceId isprovided, this field is optional.

Required. The last name of the encounter participant. Thisfield is used only when

StringcontactTracingEncounters.participants.lastName

contactTracingEncounters.participants.participantType is set to lead.

Note: If participants.referenceId isprovided, this field is optional.

The age of the encounter participant.IntegercontactTracingEncounters.participants.age

The phone number of the encounter participant. This fieldis used only when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.phoneNumber

The email address of the encounter participant. This fieldis used only when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.emailAddress

The address of the encounter participant. This field is usedonly when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address

1443


DescriptionTypeName

The city of the encounter participant. This field is used onlywhen contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address.city

The state of the encounter participant. This field is usedonly when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address.state

The country of the encounter participant. This field is usedonly when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address.country

The postal code of the encounter participant. This field isused only when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address.postalCode

The street of the encounter participant. This field is usedonly when contactTracingEncounters.participants.participantType is set to lead.

StringcontactTracingEncounters.participants.address.street

Identifies the location of the encounter.Object (referenceto location)

contactTracingEncounters.location

Required. The name of the location where the encountertook place. If the encounter location name already exists

StringcontactTracingEncounters.location.name

in the system, the existing location record is used and thefollowing location fields are ignored:

• contactTracingEncounters.location.description

• contactTracingEncounters.location.latitude

• contactTracingEncounters.location.longitude

• contactTracingEncounters.location.encounteraddress.city

• contactTracingEncounters.location.encounteraddress.state

• contactTracingEncounters.location.encounteraddress.country

• contactTracingEncounters.location.encounteraddress.postalCode

• contactTracingEncounters.location.encounteraddress.street

The description of the location where the encounter tookplace.

StringcontactTracingEncounters.location.description

1444


DescriptionTypeName

The latitude coordinate of the location where the encountertook place.

StringcontactTracingEncounters.location.latitude

The longitude coordinate of the location where theencounter took place.

StringcontactTracingEncounters.location.longitude

The city where the encounter took place.StringcontactTracingEncounters.location.encounteraddress.city

The state where the encounter took place.StringcontactTracingEncounters.location.encounteraddress.state

The country where the encounter took place.StringcontactTracingEncounters.location.encounteraddress.country

The postal code of the location where the encounter tookplace.

StringcontactTracingEncounters.location.encounteraddress.postalCode

The street where the encounter took place.StringcontactTracingEncounters.location.encounteraddress.street

Response body

JSON example

{"encounters" : [ {"created" : false,"id" : "0haxx00000000rFAAQ","location" : null,"participants" : [ {"created" : true,"employee" : null,"errors" : null,"id" : "0hbxx00000000G9AAI","lead" : {"created" : true,"id" : "00Qxx000002TST8EAO"

},"patient" : null

}, {"created" : true,"employee" : null,"errors" : null,"id" : "0hbxx00000000GAAAY","lead" : {"created" : true,"id" : "00Qxx000002TST9EAO"

},"patient" : null

}, {"created" : true,

1445


"employee" : null,"errors" : null,"id" : "0hbxx00000000GBAAY","lead" : null,"patient" : {"created" : false,"id" : "001xx000003GZ6tAAG"

}} ]

} ],"errors" : null,"status" : null,"success" : true

}

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.

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';

Set standard fields:

patient.FirstName = 'Charles';patient.LastName = 'Green';//... similarly set additional standard fields for Individual record type

1446

Health Cloud Business APIsHealth Cloud Developer Guide

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);

}}

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 these 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 these resources of Health Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications.

1447

REST ReferenceHealth Cloud Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/intro_architecture.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/intro_rate_limits.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/intro_building_url.htm

https://developer.salesforce.com/docs/atlas.en-us.238.0.chatterapi.meta/chatterapi/connect_error_responses.htm

Salesforce Health Cloud Developer Guide

Documents

Transcript of Salesforce Health Cloud Developer Guide