# legacydeveloper Life Sciences Dev Guide - Full Documentation # Account Management Use these resources to manage customer accounts. - **[Merge Customer Account (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_merge_customer_accounts.htm)** Merges a list of customer accounts. If any one account merge in the request fails, the entire operation is cancelled. - **[Merge Customer Account with Status (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_merge_customer_accounts_with_status.htm)** Merges a list of customer accounts and provides a status for each request. This API processes all valid requests and does not fail the entire operation if one request is invalid. # Account Management Account Management in the Life Sciences industry is crucial for organizations to effectively manage their relationships with healthcare providers (HCPs) and healthcare organizations (HCOs). The profile information serves as a foundation for various operational activities within the organization, providing a comprehensive view of HCPs and HCOs including their contact and social network details, specialties, affiliations, business licenses, ratings to segment and categorize HCPs and HCOs, as well as territory and product, and team-specific details. Life Sciences Cloud extends the Salesforce Core Account data model allowing organizations to create a holistic view of their customers providing up-to-date information in support of their business priorities. ![Account Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_acctmgmt.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/account-management.html "HTML (New Window)"). ## Account Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Business License](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_businesslicense.htm) - [Business License Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_businesslicenseproduct.htm) - [Care Specialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_carespecialty.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Best Contact Time](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointbestcontacttime.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Contact Point Social](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointsocial.htm) - [Formulary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_formulary.htm) - [Formulary Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_formularyitem.htm) - [Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) - [Group Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_groupmember.htm) - [Healthcare Provider](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovider.htm) - [Healthcare Provider NPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovidernpi.htm) - [Healthcare Provider Specialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareproviderspecialty.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Object Territory Association](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_objectterritory2association.htm) - [Party Publication](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_partypublication.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Account Product Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctproductinfo.htm) - [Provider Account Territory Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctterritoryinfo.htm) - [Provider Account Territory Summary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdaccountterritorysummary.htm) - [Provider Account User Group Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdaccountusergroupinfo.htm) - [Provider Affiliation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideraffiliation.htm) - [Provider Affiliation Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideraffiliationproduct.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Additional Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_useradditionalinfo.htm) - [User Territory Association](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_userterritory2association.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). - **[Data Change Requests](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_data_change_requests.htm)** With Data Change Requests, organizations can implement configurable data validation processes that are tailored to their specific business needs. Validate data changes by objects and fields and configure data changes by profile and record type. Data Change Requests support controlled data synchronization of externally managed data domains. - **[Merge Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_merge_management.htm)** Maintain the integrity of your healthcare provider and healthcare organization profile information with a configurable process that removes duplicated account data. Users can either manually merge or receive merge requests from external sources to consolidate into a single winning account and remove the losing account. This capability provides organizations with a single, accurate view of the HCPs and HCOs that they work with. #### See Also - [_Object Reference for the Salesforce Platform_: Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_account.htm) - [_Object Reference for the Salesforce Platform_: ContactPointEmail](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [_Object Reference for the Salesforce Platform_: ContactPointPhone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [_Object Reference for the Salesforce Platform_: HealthcareProviderSpecialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareproviderspecialty.htm) - [_Object Reference for the Salesforce Platform_: CareSpecialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_carespecialty.htm) - [_Object Reference for the Salesforce Platform_: GroupMember](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_groupmember.htm) - [_Object Reference for the Salesforce Platform_: Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) # Account Manual Alignment Manually align an account to a territory in the Life Sciences package to create a Provider Account Territory Info record. ## Resource /connect/life-sciences/commercial/customer-manual-alignment ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST { "territoryId": "territoryId", "accountId": "accountId" } | Name | Type | Description | Required | | --- | --- | --- | --- | | account​Id | String | Account to be aligned to the territory. | Required | | territory​Id | String | ID of the territory to which account is aligned. | Required | ## Response Body for POST [Account Manual ​Alignment Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_customer_manual_alignment_output_representation.htm "Represents the output for the request to align customer account manually.") # Account Manual Alignment Output Represents the output for the request to align customer account manually. ## Properties | Property Name | Type | Description | fILTER Group and Version | Available version | | --- | --- | --- | --- | --- | | succ​ess | Boolean | Indicates if the API request was successful (true) or not (false). | Small, 65.0 | 65.0 | | mess​age | String | Message related to the API request, which can help in case of failure. | Small, 65.0 | 65.0 | | code | String | HTTP status code for the API response. | Small, 65.0 | 65.0 | | res​ponse | Map | Map that holds the account and territory data. | Small, 65.0 | 65.0 | ## Example { "success": true, "message": "", "code": "200", "response": { "ProviderAcctTerritoryInfo": \[ { "attributes": { "type": "ProviderAcctTerritoryInfo", "url": "/services/data/v65.0/sobjects/ProviderAcctTerritoryInfo/1GxxM000001G5hxxAC" }, "Id": "1GxxM000001G5hxxAC", "Name": "PATI-000000008", "AccountId": "00xxM00000FyWOxxAV", "Territory2Id": "OxxSM0000028E4xxAE" } \] } } # Account User Territory Info The details of the users and the territories associacted with the account. ## JSON example { "code": "200", "message": null, "response": { "warnings": null, "UserTerritoryInfo": \[ { "userInformation": { "Name": "John Doe", "IsActive": true, "Username": "jdoe@example.org", "Id": "005xx00000ElNh3xxF" }, "territoryInformation": { "Name": "RD - Midwest 20A", "Id": "0MISxx00000NLzpxxG" } }, { "userInformation": { "Name": "Peter Pan", "IsActive": true, "Username": "ppan@example.com", "Id": "005xx00000Enxi1xxB" }, "territoryInformation": { "Name": "RD - Midwest 20A", "Id": "0MISxx00000NLzpxxG" } } \], "errors": null }, "success": true } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | The API response code. | Small, 64.0 | 64.0 | | message | String | If the parameters were invalid, this property contains the error message. | Small, 64.0 | 64.0 | | response | Map | Data related to the users and territories | Small, 64.0 | 64.0 | | success | Boolean | This flag indicates if the request was successful or not.. | Small, 64.0 | 64.0 | # Account User Territory Info Input Input representation of the Account User Territory Information. ## JSON Example { "accountId":"00xxG00000n6bbxxAA", "fieldNames":\["City","IsActive","LanguageLocaleKey"\] } ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | The ID of the user. Using this ID, this API fetches users associated with territories linked to this account. | Required | 64.0 | | fieldNames | String | The additional user fields that you want to retrieve. The user ID and name is fetched by default. | Optional | 64.0 | # Account User Territory Information (POST) Get user details, including territories and additional user information. ## Resource /connect/life-sciences/commercial/account-user-territory-info ## Available Version 64.0 ## HTTP Methods POST ## JSON Example { "accountId":"00xxG00000n6bbxxAA", "fieldNames":\["City","IsActive","LanguageLocaleKey"\] } ## Properties | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | accountId | String | The ID of the user. Using this ID, this API fetches users associated with territories linked to this account. | Required | 64.0 | | fieldNames | String | The additional user fields that you want to retrieve. The user ID and name is fetched by default. | Optional | 64.0 | ## Response Body for POST [AccountUserTerritoryInfoOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_account_user_territory_info.htm "The details of the users and the territories associacted with the account.") # AccountPlan Life Sciences Cloud fields extend the standard Account Plan object to represent information about customers with measurable objectives and executable steps to proactively manage and grow customer relationships. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: AccountPlan](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountplan.htm) ## Fields ### ActionPlanCompletedPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The completed percentage of action plans associated with the account plan. ### EconomicalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The evaluation of economic factors that can affect the account, including market trends, economic indicators, and financial health of the customer and their industry. ### EnvironmentalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The assessment of environmental factors that can impact the account, such as sustainability considerations, climate change-related risks, and regulatory compliance with environmental standards. ### LegalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed analysis of the legal landscape relevant to the account, including regulations, compliance requirements, and potential legal risks or opportunities. ### PoliticalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of political factors that can influence the account, such as government policies, regulatory changes, and political stability in the relevant regions. ### SocialAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The examination of social factors that can impact the account, including demographic trends, cultural considerations, and social responsibility initiatives. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### TechnologicalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The evaluation of technological factors that can affect the account, including emerging technologies, industry-specific innovations, and the customer's technological capabilities and infrastructure. ## 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. [AccountPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AccountPlanShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AccountPlanObjective Life Sciences Cloud fields extend the standard Account Plan Objective object to represent information about strategic objectives or initiatives pursued by a relationship team with a customer to enhance customer engagement and satisfaction. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: AccountPlanObjective](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountplanobjective.htm) ## Fields ### ActionPlanCompletedPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The completed percentage of action plans associated with the account plan objective. ### DueDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the objective is due to be completed. ### GoalDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The goal definition associated with the account plan objective. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Refers To**: GoalDefinition ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ## 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. [AccountPlanObjectiveChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanObjectiveFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanObjectiveHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AccountPlanObjectiveShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AccountPlanParticipant Represents the team members participating in the account plan. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan that the participant is working on. This field is a relationship field. - **Relationship Name**: AccountPlan - **Relationship Type**: Master-detail - **Refers To**: AccountPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan participant record. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The specific team member participating in the account plan. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Refers To**: Group, User ### ParticipantRoleId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The plan participant's role in executing the account plan, such as sales representative or collaborator. This field is a relationship field. - **Relationship Name**: ParticipantRole - **Refers To**: ParticipantRole ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ## 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. [AccountPlanParticipantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanParticipantFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanParticipantHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AccountPlanProduct Represents all the products associated with an account plan or its objectives. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan associated with a product. This field is a relationship field. - **Relationship Name**: AccountPlan - **Relationship Type**: Master-detail - **Refers To**: AccountPlan (the master object) ### AccountPlanObjectiveId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account plan objective associated with a product. This field is a relationship field. - **Relationship Name**: AccountPlanObjective - **Refers To**: AccountPlanObjective ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan product record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The specific product associated with an account plan or objective. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ## 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. [AccountPlanProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # AccountPlanRelaObjAnalysis Represents the strategic analysis done on objects related to the account plan. This object helps to identify internal and external factors that could potentially affect the plan, its objectives, or any related objects. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan for which object analysis is done. This field is a relationship field. - **Relationship Name**: AccountPlan - **Relationship Type**: Master-detail - **Refers To**: AccountPlan (the master object) ### EconomicalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of economic factors that can impact the account, including market trends, economic indicators, and financial health of the customer and their industry. ### EnvironmentalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of environmental factors that can impact the account, such as sustainability considerations, climate change-related risks, and regulatory compliance with environmental standards. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LegalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of legal information relevant to the account, including regulations, compliance requirements, and potential legal risks or opportunities. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan related object analysis record. ### OpportunitiesAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The in-depth analysis of identified opportunities within the account based on factors like their potential impact, feasibility, and alignment with the overall strategic objectives. ### PoliticalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of political factors that can influence the account, such as government policies, regulatory changes, and political stability in relevant regions. ### RelatedObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the specific object for which this analysis is done. This field is a polymorphic relationship field. - **Relationship Name**: RelatedObject - **Refers To**: LifeSciMarketableProduct, Product2 ### SocialAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of social factors that can impact the account, including demographic trends, cultural considerations, and social responsibility initiatives. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### StrengthAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The assessment of the internal strengths of the account, such as key capabilities, competitive advantages, and resources that can be leveraged to achieve the plan's objectives. ### TechnologicalAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of technological factors that can affect the account, including emerging technologies, industry-specific innovations, and the customer's technological capabilities and infrastructure. ### ThreatsAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The identification and assessment of potential threats to the account, such as competitive pressures, market disruptions, and regulatory changes. ### WeaknessAnalysisInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The detailed assessment of internal weaknesses of the account, such as areas for improvement, resource constraints, and potential vulnerabilities that could hinder the achievement of the plan's objectives. ## 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. [AccountPlanRelaObjAnalysisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanRelaObjAnalysisFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanRelaObjAnalysisHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AccountPlanRelationship Represents the relationship between multiple account plans for key account management. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The primary account plan associated with a particular account plan. This field is a relationship field. - **Relationship Name**: AccountPlan - **Relationship Type**: Master-detail - **Refers To**: AccountPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan relationship record. ### RelatedAccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related account plan associated with an account plan. This field is a relationship field. - **Relationship Name**: RelatedAccountPlan - **Refers To**: AccountPlan ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object ## 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. [AccountPlanRelationshipChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanRelationshipFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AccountPlanStakeholder Represents the key individuals who can influence an account's actions or have a vested interest in its outcomes. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan associated with the stakeholder. This field is a relationship field. - **Relationship Name**: AccountPlan - **Relationship Type**: Master-detail - **Refers To**: AccountPlan (the master object) ### AccountPlanObjectiveId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account plan objective associated with the stakeholder. This field is a relationship field. - **Relationship Name**: AccountPlanObjective - **Refers To**: AccountPlanObjective ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional comments or notes relevant to the stakeholder, such as their communication preferences, key interests, or past interactions with the company. ### InfluenceLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the level of influence that the stakeholder has within their organization or network, which can impact their ability to affect decisions or drive adoption of products or services. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan stakeholder record. ### RoleType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of professional role or title of the stakeholder, such as pharmacist and manager. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### StakeholderRefnRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The stakeholder record associated with the account plan stakeholder. This field is a polymorphic relationship field. - **Relationship Name**: StakeholderReferenceRecord - **Refers To**: Account, Contact ### Strength - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the perceived level of support or advocacy the stakeholder has for the company, its products, or its initiatives. ## 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. [AccountPlanStakeholderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanStakeholderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanStakeholderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AccountPlanStkhldrAction Represents a junction between an account plan stakeholder and an action. Stores information about an action for an account plan that's associated with a stakeholder. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanStakeholderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan stakeholder for whom the action is performed. This field is a relationship field. - **Relationship Name**: AccountPlanStakeholder - **Relationship Type**: Master-detail - **Refers To**: AccountPlanStakeholder (the master object) ### ActionReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The action plan or action plan item referencing an action to be performed for the account plan stakeholder. This field is a polymorphic relationship field. - **Relationship Name**: ActionReferenceRecord - **Refers To**: ActionPlan, ActionPlanItem ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan stakeholder action record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### StakeholderName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the referenced stakeholder, defined as an account or contact. ## 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. [AccountPlanStkhldrActionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # AccountPlanStkhldrProduct Represents a junction between an account plan stakeholder and a product. Stores information about the products associated with a stakeholder for an account plan. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanStakeholderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan stakeholder associated with the account plan. This field is a relationship field. - **Relationship Name**: AccountPlanStakeholder - **Relationship Type**: Master-detail - **Refers To**: AccountPlanStakeholder (the master object) ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional description about the relationship between the account plan, account plan stakeholder, and the associated products. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan stakeholder product record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the account plan stakeholder. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### StakeholderName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the referenced stakeholder, defined as an account or contact. ## 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. [AccountPlanStkhldrProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AccountPlanStkhldrProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccountPlanStkhldrProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Accreditation Represents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute care hospital. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Healthcare facility (Account) that this accreditation is associated with. ### AccreditationRating - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Rating system used by the accrediting body. ### AccreditingBody - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The organization that provided the accreditation. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this accreditation is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this accreditation is no longer effective. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare facility associated with the accreditation. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. This field is a relationship field. - **Relationship Name**: HealthcareFacility - **Refers To**: HealthcareFacility ### LastFullSurveyDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of the last full survey completed by accrediting body. ### LastOnsiteSurveyDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date that accrediting body was last onsite. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the accreditation. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner that this accreditation is associated with. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Accreditation status. ### SubType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Subtype of the accreditation. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of accreditation. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AccreditationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [AccreditationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AccreditationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AccreditationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AccreditationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AcctPlanPtcpStakeholder Represents a junction between an account plan participant and an account plan stakeholder. Stores information about the account plan participant who collaborates with the account plan stakeholder for performing account plan tasks. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountPlanParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account plan participant who collaborates with the account plan stakeholder for performing account plan tasks. This field is a relationship field. - **Relationship Name**: AccountPlanParticipant - **Relationship Type**: Master-detail - **Refers To**: AccountPlanParticipant (the master object) ### AccountPlanStakeholderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account plan stakeholder who collaborates with the account plan participant and influences the decisions of the account plan. This field is a relationship field. - **Relationship Name**: AccountPlanStakeholder - **Refers To**: AccountPlanStakeholder ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the account plan participant stakeholder record. ### ParticipantName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the referenced account plan participant, defined as a user or a group. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### StakeholderName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the referenced stakeholder, defined as an account or a contact. ## 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. [AcctPlanPtcpStakeholderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AcctPlanPtcpStakeholderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AcctPlanPtcpStakeholderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Action Plan Context Filters Input Input representation of the action plan context filters. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the Generic Visit Task Context record. | Optional | 55.0 | | kpiIds | String\[\] | IDs of the corresponding key performance indicators (KPI) associated with the context ID. | Optional | 55.0 | # Action Plan Template Input Input representation of an action plan template. ## JSON Example "actionPlanTemplate": { "templateId": "0PTxx0000004C92GAE", "templateItemFilters": \[ { "templateItemId": "0PJxx0000004C92GAE" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | templateId | String | ID of an action plan template. | Optional | 55.0 | | templateItemFilters | [Action Plan Template Item Filters Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_action_plan_template_item_filters.htm "Input representation of the action plan template item filters.")\[\] | Details of the action plan template item filters. | Optional | 55.0 | # Action Plan Template Item Filters Input Input representation of the action plan template item filters. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextFilters | [Action Plan Context Filters Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_action_plan_context_filters.htm "Input representation of the action plan context filters.")\[\] | Details of the action plan context filters. | Optional | 55.0 | | templateItemId | String | ID of the action plan template item. | Optional | 55.0 | # ActionableList Represents an actionable list. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableListDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The list definition that's associated with the actionable list. This field is a relationship field. - **Relationship Name**: ActionableListDefinition - **Refers To**: ActionableListDefinition ### ActionableListType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of the actionable list based on its definition. This value is derived from the ActionableListDefinition record. ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person to whom an actionable list is assigned. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: Group, User ### AssigneeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of assignee of an actionable list. - **Possible values**: - Queue - RecordOwner - User ### AssignmentStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The status of the assignment done for an actionable list. - **Possible values**: - Failed - InProgress - PartiallyComplete - Success - Waiting ### AutomaticAssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assignee to whom the new members in an actionable list are automatically assigned. This field is a polymorphic relationship field. - **Relationship Name**: AutomaticAssignee - **Refers To**: Group, User ### AutomaticAssigneeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of assignee to which the new members in an actionable list are automatically assigned. - **Possible values**: - Queue - RecordOwner - User ### BatchCalcJobDefinitionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The batch calculation job definition associated with the actionable list. This field is a relationship field. - **Relationship Name**: BatchCalcJobDefinition - **Refers To**: BatchCalcJobDefinition ### CompletionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last date for completing engagement with the members in an actionable list. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code for the postauthorization request. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### DefaultMemberStatusId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The default actionable list member status. This field is a relationship field. - **Relationship Name**: DefaultMemberStatus - **Refers To**: ActionableListMemberStatus ### DefaultSortMemberField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The default field name used for sorting the actionable list members in Outreach List. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the actionable list. ### IsActionableListConfigured - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether an actionable list is configured (true) or not (false). - **Default value**: false ### IsAutoAssignmentAllowed - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether automatic assignment of new actionable list members is allowed (true) or not (false). - **Default value**: false ### LastMemberAddDateTime - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date and time when the last member was added to an actionable list in epoch time format. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### ListStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the actionable list. - **Possible values**: - Active - Archived - Draft - Processing ### MemberCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The actionable list members count. ### MemberCountLastModDtTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the member count of an actionable list was last modified. ### MemberSortOrder - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the default sort order for sorting the actionable list members in Outreach List. - **Possible values**: - Ascending - Descending ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the actionable list. ### ObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the object for which the actionable list is created. - **Possible values**: - Account - Asset - CareRequest - CareRequestItem - Case - Claim - ClinicalServiceRequest - Contact - HealthcareFacility - InsurancePolicy - Lead - MemberPlan - Opportunity - PersonLifeEvent ### OmniScriptKey - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The key that's created by combining the type, subtype, and language of the OmniScript with a '/' separating these values. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the priority of the actionable list. - **Possible values**: - High - Low - Medium ### SourceType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the source type of the actionable list. - **Possible values**: - CrmAnalytics—Crm Analytics - DataCloudPlatform—Data Cloud Platform ### Status - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the status of the actionable list. - **Possible values**: - Failed - Queued - Success ### SynchronizationOperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of operation that's performed when an actionable list synchronizes with a Data Cloud segment. - **Possible values**: - Insert - Update ## 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. [ActionableListChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ActionableListFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ActionableListHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ActionableListShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ActionableListDefinition Represents the data source definition details associated with an actionable list. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location ActionableListDefinition components have the suffix .actionableListDefinition and are stored in the actionableListDefinitions folder. ## Version ActionableListDefinition components are available in API version 57.0 and later. ## Fields ### actionableListDatasetColumns - **Field Type**: [ActionableListDatasetColumn](#ActionableListDatasetColumn)\[\] - **Description**: The object that stores columns in a dataset associated with an actionable list. ### actionableListMemberStatuses - **Field Type**: [ActionableListMemberStatus](#ActionableListMemberStatus)\[\] - **Description**: The object that stores the status and the corresponding status icon details of an individual actionable list member. ### batchCalcJobDefinition - **Field Type**: string - **Description**: The batch calculation job definition that's associated with the creation of an actionable list. This field is a relationship field. ### datasetName - **Field Type**: string - **Description**: The name of the dataset that is associated with the actionable list. ### edgeMart - **Field Type**: string - **Description**: The edgemart dataset that's associated with the actionable list. Available in API version 58.0 and later. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the actionable list definition is active (true) or not (false). - **Default value**: false ### masterLabel - **Field Type**: string - **Description**: Required. The master label of the actionable list definition. ### objectName - **Field Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: Required. The object for which the actionable list is created. - **Default value**: LifeScience - **Possible values**: - Account - Asset - CareRequest - CareRequestItem - Case - Claim - ClinicalServiceRequest - Contact - HealthcareFacility - InsurancePolicy - Lead - MemberPlan - Opportunity - PersonLifeEvent ### type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the actionable list that can be built using the actionable list definition. - **Possible values**: - RetailStoreList - HealthcareProviderList ## ActionableListDatasetColumn Fields Represents the information about the columns in a dataset associated with an actionable list. ### dataDomain - **Field Type**: DatasetColumnDataType (enumeration of type string) - **Description**: The data domain that is mapped to the data type of the dataset column. - **Possible values**: - Dates - Dimensions - Measures ### dataType - **Field Type**: DatatableDataType (enumeration of type string) - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The data type of the dataset column in the actionable list. Available in API version 58.0 and later. - **Possible values**: - Boolean - Currency - Date - DateTime - Email - Location - Number - Percent - Phone - Text - Url ### displayOrder - **Field Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order in which the actionable list dataset columns are displayed. Available in API version 58.0 and later. ### isDefault - **Field Type**: boolean - **Description**: Indicates whether the dataset column is added to the actionable list by default (true) or not (false). - **Default value**: false ### isGroupedByListDefObj - **Field Type**: boolean - **Description**: Indicates whether the dataset column is grouped by the object defined in the actionable list definition (true) or not (false). Available in API version 59.0 and later. ### IsTypeAheadSearchEnabled - **Field Type**: boolean - **Description**: Indicates whether the type-ahead search for filters is enabled (true) or not (false). Available in API version 60.0 and later. ### objectName - **Field Type**: string - **Description**: The name of the object that's associated with the dataset column. - **Possible values**: - Account - Asset - CareRequest - CareRequestItem - Case - Claim - ClinicalServiceRequest - Contact - HealthcareFacility - InsurancePolicy - Lead - MemberPlan - Opportunity - PersonLifeEvent ### sourceColumnApiName - **Field Type**: string - **Description**: The API name of the column in the source dataset. ### sourceFieldName - **Field Type**: string - **Description**: The name of the field in the object for which the actionable list dataset is created. ## ActionableListMemberStatus Fields Represents the status and the corresponding status icon details of an individual actionable list member. ### iconName - **Field Type**: string - **Description**: The name of the icon that's mapped to the status. ### status - **Field Type**: string - **Description**: The status of the actionable list member. ## Declarative Metadata Sample Definition The following is an example of a ActionableListDefinition component. true NewColumn1 ApiName Dimensions false NewColumn2 Account 1 Text NewMember1 Active true NewMember2 Account true Test1 AccountDef The following is an example package.xml that references the previous definition. \* ActionableListDefinition 68.0 ## Wildcard Support in the Manifest File ### Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). # ActionableListFilterCriteria Represents a logical expression containing filter conditions to include or exclude data from the dataset that's associated with the actionable list. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableListId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The actionable list associated with the filter criteria. This field is a relationship field. - **Relationship Name**: ActionableList - **Relationship Type**: Master-detail - **Refers To**: ActionableList (the master object) ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO code for any currency allowed by the organization. Available only for organizations with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### FilterLogic - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The logical expression of the filter criteria in the text format. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-assigned number that identifies the actionable list filter criteria record. ### SourceType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the source type of the actionable list. - **Possible values**: - CrmAnalytics—Crm Analytics - DataCloudPlatform—Data Cloud Platform # ActionPlan Standard and custom fields extend the standard ActionPlan object to represent an instance of the compliance program assigned to an account. The ActionPlan object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Provider Engagement Compliance. To learn about the fields that are used in Key Account Management, see the ActionPlan object documentation in the Key Account Management section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### StartedByType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates how the provider engagement compliance is started. ### StatusCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the action plan. - **Possible values**: - Canceled - Completed - In Progress - Not Started - Restarted ### TargetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Indicates the account the provider engagement compliance program is targeted for. This field is a polymorphic relationship field. - **Relationship Name**: Target - **Refers To**: Account, AccountPlanObjective, Applicant, ApplicationForm, ApplicationFormProduct, Asset, Benefit, BenefitAssignment, Budget, BusinessLicense, BusinessLicenseApplication, BusinessMilestone, CareBarrier, CarePgmEnrolleeWkOrdStep, CarePlan, Case, Claim, Contact, Contract, CustodyItem, FinancialGoal, GoalAssignment, HealthCondition, IndividualApplication, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PartyProfile, PartyRelationshipGroup, PersonLifeEvent, PreliminaryApplicationRef, Program, ProgramEnrollment, PublicComplaint, RecordAlert, RegulatoryCodeViolation, RelatedListValidation\_\_c, ResidentialLoanApplication, ViolationEnforcementAction, Visit, WorkOrder, WorkOrderLineItem, omnistudio\_\_VlocityScheduledJob\_\_c ### TargetReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference record associated with the action plan. This field is a polymorphic relationship field. - **Relationship Name**: TargetReferenceRecord - **Refers To**: CareProgram, Visit # ActionPlan Life Sciences Cloud fields extend the standard ActionPlan object to represent the instance of an action plan. The ActionPlan object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Key Account Management. To learn about the fields that are used in Provider Engagement Compliance, see the ActionPlan object documentation in the Provider Engagement Compliance section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ActionPlan](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplan.htm) ## Fields ### CompletedPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the action plan that has been completed. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### SprintId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sprint which tracks the action plan. This field is a relationship field. - **Relationship Name**: Sprint - **Refers To**: Sprint ### StatusCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the action plan. - **Possible values**: - Canceled - Completed - In Progress - Not Started - Restarted ### TargetReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference record associated with the action plan. This field is a polymorphic relationship field. - **Relationship Name**: TargetReferenceRecord - **Refers To**: CareProgram, Visit ## 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. [ActionPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ActionPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ActionPlanShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ActionPlanItem Life Sciences Cloud fields extend the standard ActionPlanItem object to represent the instance of an action plan item. The ActionPlanItem object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Key Account Management. To learn about the fields that are used in Provider Engagement Compliance, see the ActionPlanItem object documentation in the Provider Engagement Compliance section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ActionPlanItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplanitem.htm) ## Fields ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ## 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. [ActionPlanItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # ActionPlanItem Standard and custom fields extend the standard ActionPlanItem object to represent the junction between Action Plan and Provider Engagement Compliance Cycle. The ActionPlanItem object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Provider Engagement Compliance. To learn about the fields that are used in Key Account Management, see the ActionPlanItem object documentation in the Key Account Management section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() #### See Also - [_Key Account Management_: ActionPlanItem](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplanitem_kam.htm "Life Sciences Cloud fields extend the standard ActionPlanItem object to represent the instance of an action plan item.") ## Fields ### ActionPlanTemplateItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the action plan template item this item was created from. This field is a relationship field. - **Relationship Name**: ActionPlanTemplateItem - **Refers To**: ActionPlanTemplateItem ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. # ActionPlanStatusPeriod Represents the historical changes to the status of an action plan. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### ActionPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Action Plan associated with the Action Plan status period. This field is a relationship field. - **Relationship Name**: ActionPlan - **Relationship Type**: Master-detail - **Refers To**: ActionPlan (the master object) ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The effective end date and time of the Action Plan status. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the action plan status period. ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the action plan was assigned the status. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The effective start date and time of the action plan status. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the action plan. - **Default value**: Not Started - **Possible values**: - Not Started - In Progress - Cancelled - Restarted - DraftAssigned ## 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. [ActionPlanStatusPeriodChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ActionPlanStatusPeriodFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ActionPlanStatusPeriodHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ActionPlanTemplate Represents the instance of an action plan template. In Life Sciences cloud, this object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionPlanType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: This action plan template’s type. - **Possible values**: - - PrvdEngmtCompliance—Provider Engagement Compliance ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category that the action plan template belongs to. Available in API version 64.0 and later. - **Possible values**: - Onboarding - Application ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of this action plan template. ### EstimatedCompletionDays - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The estimated number of days to complete the action plan. Available in API version 64.0 and later. ### FileBasedTemplatePath - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The path of the file based template using which the action plan template is created. Available in API version 64.0 and later. ### IsAdHocItemCreationEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether users can add tasks or other items to generated action plans (true) or not (false). ### IsLocked - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this action plan template is locked or not. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MayEdit - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this action plan template can be edited or not. - **Default value**: false ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this action plan template. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this action plan template. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the parent template associated with the action plan template. This field is a relationship field. - **Relationship Name**: ParentTemplate - **Refers To**: ActionPlanTemplate ### SourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the source type to which the action plan template belongs to. Available in API version 64.0 and later. - **Possible values**: - CRM - MigratedFromSandbox ### Status - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The status of this action plan template. - **Possible values**: - Draft - Final—Published - Obsolete - ReadOnly ### Subcategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The subcategory to which the action plan template belongs. Available in API version 64.0 and later. - **Possible values**: - Product Onboarding - Customer Onboarding ### TargetEntityType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: The parent object this action plan template relates to. - **Possible values**: - RelatedListValidation\_\_c—RelatedListValidation - omnistudio\_\_VlocityScheduledJob\_\_c—Vlocity Scheduled Job ### UniqueName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name for this action plan template. This field is unique within your organization. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplateAssignment Represents the association of an action plan template with its related care plan template, goal, or problem definition. When instantiated, the action plan generates the corresponding intervention tasks and links them to the appropriate record, such as a condition, goal, or care plan. ## Special Access Rules The ActionPlanTemplateAssignment object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic lists the fields for both features. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionPlanTemplateVersionId - **Type**: Reference - **Properties**: Create, Filter, Group, Sort - **Description**: Action plan template that’s mapped to a problem defintion, goal definition, or care plan template. This field is a relationship field. In Life Sciences Cloud (Medical Management), it is the version of the action plan template. - **Relationship Name**: ActionPlanTemplateVersion - **Relationship Type**: Master-Detail - **Refers To**: ActionPlanTemplateVersion ### AssociatedObjectId - **Type**: Reference Polymorphic lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The object to which the action plan template is associated. For example: a problem definition, goal definition, or care plan template, associated with an action plan template. - **Relationship Name**: AssociatedObject (Life Sciences Cloud - Medical Management) - **Refers To**: CarePlanTemplate - **Relationship Type**: Lookup - **Refers To** - Benefit - CarePlanTemplate - CareProgram - GoalDefinition - ProblemDefinition - Program - RegulatoryCode ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the action plan template assignment record. ## 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. [ActionPlanTemplateAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [ActionPlanTemplateAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. # ActionPlanTemplateItem Represents the instance of an item on an action plan template version. This object is available in API version 64.0 and later in Key Account Management feature in the Life Sciences Cloud. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionPlanTemplateVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The version of the action plan template this item is for. This field is a relationship field in Key Account Management feature. - **Relationship Name**: ActionPlanTemplateVersion - **Relationship Type**: Master-detail - **Refers To**: ActionPlanTemplateVersion (the master object) ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order in which this item is displayed within the action plan template version. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the task created from this template item is active. - **Default value**: false ### IsLocked - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this action plan template item is locked or not. This field is available in Intelligent Sales in API version 44.0 and later. - **Default value**: false ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the task created from this template item is required. - **Default value**: false ### ItemEntityType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of action plan template item entity. Always set to Task. - **Possible values**: - Document Checklist Item - Event—This value is available in API version 64.0. - RecordAction - Task - PrvdEngmtComplianceCycle—Provider Engagement Compliance Cycle. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MayEdit - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this action plan template item can be edited or not. This field is available in Intelligent Sales in API version 44.0 and later. - **Default value**: false ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique identifier for this action plan template item record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. This field is available in Key Account Management in API version 64.0 and later. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. This field is available in Key Account Management in API version 63.0 and later. ### UniqueName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name for this action plan template item. This field is unique within your organization. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ActionPlanTemplateItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) Change events are available for the object. [ActionPlanTemplateItemFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ActionPlanTemplateItemHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ActionPlanTemplateItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ActionPlanTemplateItemShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ActionPlanTemplateItemValue Life Sciences Cloud fields extend the standard ActionPlanTemplateItemValue object to represent the value associated with an action plan template item. The ActionPlanTemplateItemValue object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Key Account Management. To learn about the fields that are used in Provider Engagement Compliance, see the ActionPlanTemplateItemValue object documentation in the Provider Engagement Compliance section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ActionPlanTemplateItemValue](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitemvalue.htm) ## Fields ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ## 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. [ActionPlanTemplateItemValueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # ActionPlanTemplateItemValue Standard and custom fields extend the standard ActionPlanTemplateItemValue object to represent the value associated with an action plan template item. The ActionPlanTemplateItemValue object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Provider Engagement Compliance. To learn about the fields that are used in Key Account Management, see the ActionPlanTemplateItemValue object documentation in the Key Account Management section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Key Account Management_: ActionPlanTemplateItemValue](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitemvalue_kam.htm "Life Sciences Cloud fields extend the standard ActionPlanTemplateItemValue object to represent the value associated with an action plan template item.") ## Fields ### ActionPlanTemplateItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the compliance program cycle. This field is a relationship field. - **Relationship Name**: ActionPlanTemplateItem - **Relationship Type**: Master-detail - **Refers To**: ActionPlanTemplateItem (the master object) ### ItemEntityFieldName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The name of the field on the action plan template item that this value is for. Specifies the combination of Item Entity Type and Name field values. - **Possible values**: - PrvdEngmtComplianceCycle.DurationInDays—Duration In Days ### ItemEntityType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of action plan template item. - **Possible values**: - PrvdEngmtComplianceCycle—Provider Engagement Compliance Cycle ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### ValueLiteral - **Type**: textarea - **Properties**: Create, Filter, Nillable, Update - **Description**: The duration of the compliance program cycle in days. # ActionPlanTemplateVersion Life Sciences Cloud fields extend the standard ActionPlanTemplateVersion object to represent a version of an action plan template. The ActionPlanTemplateVersion object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Key Account Management. To learn about the fields that are used in Provider Engagement Compliance, see the ActionPlanTemplateVersion object documentation in the Provider Engagement Compliance section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ActionPlanTemplateVersion](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateversion.htm) ## Fields ### ActionPlanTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the action plan template this version represents. This field is a relationship field. - **Relationship Name**: ActionPlanTemplate - **Relationship Type**: Master-detail - **Refers To**: ActionPlanTemplate (the master object) ### ActivationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort - **Description**: The date and time when this version becomes active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the action plan template version. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the action plan template version. - **Possible values**: - Draft - Final—Published - Obsolete - ReadOnly ### Version - **Type**: int - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: The index number of this action plan template version. ## 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. [ActionPlanTemplateVersionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # ActionPlanTemplateVersion Represents the version of an action plan template. The ActionPlanTemplateVersion object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic only lists the fields used in Provider Engagement Compliance. To learn about the fields that are used in Key Account Management, see the ActionPlanTemplateVersion object documentation in the Key Account Management section. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionPlanTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the compliance program template that the action plan template version represents. This field is a relationship field. - **Relationship Name**: ActionPlanTemplate - **Relationship Type**: Master-detail - **Refers To**: ActionPlanTemplate (the master object) ### ActivationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort - **Description**: The date when the provider engagement compliance template becomes active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the action plan template version. # Activity Plans Activity plans allow administrators to define goals for specific employees, including targeted accounts, plan cycle duration, types of activities, links to products, and weight of activity type. Employees and managers can review and edit these goals before final approval by the administrator. After plans are approved, employees execute activities against their goals, with the option to request changes during an active plan. Charts provide a visual representation of the employee's progress toward goals. ![Activity Plans entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_activity_plans_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_activity_plans.htm "HTML (New Window)"). ## Activity Plans Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Activity Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplan.htm) - [Activity Plan Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplanterritory.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Activity Goal](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoal.htm) - [Provider Activity Goal Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoalmeasure.htm) - [Provider Activity Goal Measure Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdactvtygoalmeasureprodt.htm) - [Provider Activity Measure Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitymeasuretype.htm) - [Provider Activity Plan Adjustment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractvtyplanadjusment.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # ActivityPlan Represents the user's activity goals for the cycle. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivityChgRvwThresholdPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum percentage by which an account's overall activity goal can be changed during the review of a future activity plan. ### AssigneeDueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The due date for the activity plan assignee to review the activity plan. ### AssigneePlanAdjEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date by which the assignee must complete the activity plan adjustments. ### AssigneePlanAdjStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the assignee can start making adjustments to the activity plan. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the comments or observations on the activity plan. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the activity plan is active (true) or not (false). - **Default value**: false ### IsCalculationEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether plan calculations are enabled for this activity plan (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the activity plan. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the activity plan. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent activity plan for this activity plan. This field is a relationship field. - **Relationship Name**: ParentRecord - **Refers To**: ActivityPlan ### ReviewerDueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The due date for the activity plan reviewer to approve any changes made by the assignee. ### ReviewerPlanAdjEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date by which the approver must complete approving the assignee's activity plan adjustments. ### ReviewerPlanAdjStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the reviewer can start approving the assignee's activity plan adjustments. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the activity plan. - **Possible values**: - AdminReview—Admin Review - Approved - EmployeeReview—Employee Review - InProgress—In Progress - ManagerReview—Manager Review - Rejected - Submitted ### TerritoryList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A list of territories included in this activity plan. ### TimePeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The period of the activity plan, for example, FY 2024. This field is a relationship field. - **Relationship Name**: Period - **Refers To**: Period ### TotalAcctAdjThresholdPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum percentage by which the total number of accounts in an active activity plan can be changed during the adjustment phase. ### TotalAcctChgThresholdPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum percentage by which the total number of accounts in the activity plan can be changed during the review of a future activity plan. ### TotalActvtyChgThresholdPct - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum percentage by which the combined overall goals of all accounts can be changed during the review of a future activity plan. ### TotalAllowAdjRequestCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of approved plan adjustment requests allowed for an active activity plan. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the type of the activity plan. - **Possible values**: - AccountGoal—Account Goal - AccountGoalShared—Account Goal Shared - WeightedTerritoryGoals—Weighted Territory Goals ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the usage type of the activity plan. - **Possible values**: - ProviderPlanCycle—Provider Plan Cycle ### WorkingDayCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of working days available for the activity plan. ## 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. [ActivityPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ActivityPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ActivityPlanShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ActivityPlanTerritory Represents the territory details associated with an activity plan. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### ActivityPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The activity plan associated with activity plan territory. This field is a relationship field. - **Relationship Name**: ActivityPlan - **Relationship Type**: Master-detail - **Refers To**: ActivityPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the activity plan territory. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory associated with the activity plan. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 # ActivityPlanToTerritories Properties Properties for pairing a source activity plan ID with territory IDs for assignment. | Property | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | activityPlanId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the source activity plan to associate with the specified territories. | Required | 65.0 | | territoryIds | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm)<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)\> | IDs of the territories to assign to the cloned activity plan. | Required | 65.0 | # ActivityPlanToTerritories(activityPlanId, territoryIds) Creates an instance of the ActivityPlanToTerritories class to pair a source activity plan with territory IDs. ## API Version 65.0 ## Requires Chatter No ## Signature public ActivityPlanToTerritories(String activityPlanId, List territoryIds) ## Parameters activityPlanId Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ID of the source activity plan to associate with the specified territories. territoryIds Type: [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm)<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)\> IDs of the territories to assign to the cloned activity plan. ## Return Value Type: ActivityPlanToTerritories - **[ActivityPlanToTerritories Properties](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_input_activity_plan_to_territories.htm)** Properties for pairing a source activity plan ID with territory IDs for assignment. # ActivityTiming Represents detailed information about an activity that’s repeated in regular intervals over a period of time. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivityCountPerRepetition - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The recommended number of times the activity should be performed in a repetition cycle. ### ActivityDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The length of time that the activity should be performed during each occurrence. ### ActivityDurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the length of time that the activity should be performed during each occurrence. This is a relationship field. - **Referenced Object**: UnitOfMeasure ### ActivityTime - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The approximate time of day or a daily event that acts as a point of reference for when the activity should be performed. - **Possible values**: - Default ### ActivityTimeOffset - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of minutes before or after the reference point specified in ActivityTime when the activity should be performed. ### CountInPeriod - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The recommended number of times the activity should be performed in the specified period. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed th reecord. ### MaxActivityCountPerRepetition - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of times the activity should be performed in a repetition cycle. ### MaxActivityDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum length of time that the activity should be performed during each occurrence. ### MaxCountInPeriod - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of times the activity should be performed in the specified period. ### MaxRepetitionCycleLength - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum length of each cycle of repetition. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the ActivityTiming record. This value is generated automatically. ### OwnerId - **Type**: Polymorphic reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the ActivityTiming record. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Referenced Object**: Group, User ### PeriodEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date of the period during which this activity should be performed. ### PeriodLength - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The length of the period during which this activity should be performed. ### PeriodLengthLowerLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lower limit of the length of the period during which this activity should be performed. ### PeriodLengthUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the period's length. This field is used to specify the unit for PeriodLength, PeriodLengthLowerLimit, and PeriodLengthUpperLimit. - **Referenced Object**: UnitOfMeasure ### PeriodLengthUpperLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The upper limit of the length of the period during which this activity should be performed. ### PeriodStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date of the period during which this activity should be performed. ### RepetitionCycleLength - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The recommended length of each cycle of repetition. ### RepetitionCycleUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the length of each cycle of repetition. - **Referenced Object**: UnitOfMeasure ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system the record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last changed in the source system. ### TimingCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the timing information of an activity. This code is expected 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 an activity. This is a relationship field. - **Referenced Object**: CodeSet ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of activity the timing information is used for. - **Possible values**: - CareObservation—Care Observation - ClinicalServiceRequest—Clinical Service Request - MedicationDosage—Medication Dosage ### WeeklyActivityTimeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The day and time of the week when this activity should be performed. - **Referenced Object**: OperatingHours ## Usage ActivityTiming records are referenced from MedicationDosage records to specify the timing of their activities. Here’s an example of an activity’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 run at 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 than 15 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 between 60-84 times. **Sample Record:** Id: 1CDR00000000006OAA OwnerId: 005R0000000dNImIAM IsDeleted: false Name: AT-3147 CreatedDate: 2021-04-15T10:48:14.000+0000 CreatedById: 005R0000000dNImIAM LastModifiedDate: 2021-04-15T10:49:47.000+0000 LastModifiedById: 005R0000000dNImIAM SystemModstamp: 2021-04-15T10:49:47.000+0000 LastViewedDate: 2021-04-15T11:14:26.000+0000 LastReferencedDate: 2021-04-15T11:14:26.000+0000 TimingCodeId: null PeriodStartDateTime: null PeriodEndDateTime: null PeriodLength: null PeriodLengthLowerLimit: 3 PeriodLengthUpperLimit: 4 PeriodLengthUnitId: 0hER0000000001VMAQ CountInPeriod: 60 MaxCountInPeriod: 84 ActivityDuration: 10 MaxActivityDuration: 15 ActivityDurationUnitId: 0hER0000000001aMAA ActivityCountPerRepetition: 5 MaxActivityCountPerRepetition: 7 RepetitionCycleLength: 2 MaxRepetitionCycleLength: 3 RepetitionCycleUnitId: 0hER0000000001fMAA ActivityTime: AfterMeal ActivityTimeOffset: 30 WeeklyActivityTimeId: 0OHR00000000HanOAE UsageType: MedicationDosage SourceSystem: WWHR SourceSystemIdentifier: 763851 SourceSystemModified: 2021-04-05T23:00:00.000+0000 ## 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. [ActivityTimingChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [ActivityTimingFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ActivityTimingHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ActivityTimingShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Address The Address FHIR resource maps to the Contact​Point​Address​ object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Address](https://www.hl7.org/fhir/datatypes.html#Address) map to the fields in Salesforce. Table 1. Address - Salesforce | Address Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | use | Contact​Point​Address​.Usage​Type | Picklist | 0.1 | FHIR defines Contact​Point​Address​.use as a code set. However, the Salesforce implementation of Contact​Point​Address​.Content​Type is a picklist. | | type | N/A | N/A | N/A | Not supported | | text | N/A | N/A | N/A | Not supported | | line | Contact​Point​Address​.Street | String | 0.1 | While FHIR defines address.line as zero-many, Salesforce supports only one string for each record. If you have multiple lines, it’s recommended to merge them into a single string before passing it to Salesforce. | | city | Contact​Point​Address​.City | String | 0.1 | N/A | | district | N/A | N/A | N/A | Not supported | | state | Contact​Point​Address​.State | String | 0.1 | N/A | | postal​Code | Contact​Point​Address​.Postal​Code | String | 0.1 | N/A | | country | Contact​Point​Address​.Country | String | 0.1 | N/A | | period | Contact​Point​Address​.Active​From​Date | Date | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation flattens address​.period to a set of from and to dates. | | period | Contact​Point​Address​.Active​To​Date | Date | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation flattens address​.period to a set of from and to dates. | # Advanced Provider Search Facilitate three distinct types of account searches: Healthcare Provider (HCP), Healthcare Organization (HCO), and license-based searches. For HCP and HCO searches, the API processes fields from the account, healthcare provider, and contact point address entities.The license-based searches use fields from the business license entity. ## Resource /connect/life-sciences/commercial/advanced-provider-search ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/advanced-provider-search?externalSearch=true ## Available Version 65.0 ## HTTP Methods POST ## Query Parameters for POST | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | external​Search | Boolean | Indicates whether to perform the search on an external system (true) or not (false. By default, this value is set to false and an internal search is performed. This is a URL parameter, not part of the input representation. | Optional | ## Request Body for POST { "account": \[ { "field": "Name", "value": "Robert" }, { "field": "AccountNumber", "value": "123456" } \], "healthcareProvider": \[ { "field": "Specialties", "value": "Robert" }, { "field": "PhoneticName", "value": "Robrt" } \], "contactPointAddress": \[ { "field": "IsPrimary", "value": "false" }, { "field": "CountryCode", "value": "US" } \], "businessLicense": \[ { "field": "ComplianceScope", "value": "Address" }, { "field": "LicenseNumber", "value": "123456" } \] } | Property Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | account | List | List of account fields and their corresponding search values. At least one field from either account or healthcare provider must be populated. | Optional | | business​License | List | List of business license fields and their corresponding search values. | Optional | | contact​Point​Address | List | List of contact point address fields and their corresponding search values. | Optional | | health​care​Provider | List | List of healthcare provider fields and their corresponding search values. At least one field from either account or healthcare provider must be populated. | Optional | ## Response Body for POST [Provider Search Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_provider_search.htm "Output representation for provider search request.") # Advanced Therapy Management Advanced Therapy Management helps streamline complex procedures that involve multiple appointments across different locations. Use Advanced Therapy Management’s Multi-Step Scheduling solution for easy scheduling of appointments for program participants. Configure procedure steps based on lead times and set up affiliated service territories to establish where work types are sequentially performed. Advanced Therapy Management’s Multi-Step Scheduling is powered by Salesforce Scheduler to search for available slots at affiliated service territories. With the combined help of new Advanced Therapy Management objects and existing Scheduler objects, Multi-Step Scheduling provides a centralized platform that helps users book, reschedule, and cancel slots for various procedure steps. Advanced Therapy Management helps pharmaceutical companies conduct complex therapies like cell and gene therapy with ease. Treatment center coordinators can schedule appointments for procedure steps like apheresis, manufacturing, and infusion at one go. Service territory relationships streamline search results by defining relationships between affiliated sites where consecutive therapy steps are performed. Salesforce Scheduler’s existing objects support effective slot management by helping users configure service resources, assets, and their availabilities at designated locations. Advanced Therapy Management objects are available to users with the Multi-Step Scheduling permission set and permission set license. Admins must also purchase the Asset Scheduler Add-On license for each asset assigned to a service territory. ![The data model diagram for Advanced Therapy Management with Health Cloud objects and Salesforce Scheduler objects.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/images/health-cloud-advanced-therapy-management-data-model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/advanced-therapy-management.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Adverse Events Adverse Events data model helps you in managing and documenting any unfavorable or unintended signs, symptoms, or diseases that occur in participants during the research study. These adverse events can include a wide range of physical or psychological effects that varies from mild discomfort to serious health complications.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Life Sciences Cloud or Health Cloud
The adverse events objects are available to users with Health Cloud Starter or Health Cloud license. Available in API version 61.0 and later. ![Adverse events entity verification diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_adverse_events_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/adverse-events.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # AdverseEvent The AdverseEvent FHIR resource maps to the AdverseEvent objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [adverseEvent](https://build.fhir.org/adverseevent-definitions.html) map to the fields in Salesforce. Table 1. adverseEvent - Salesforce | Adverse​Event Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | status | Adverse​Event​Entry.​Status | Dynamic Enum | 1.1 | While FHIR defines adverse​Event​Entry​.status as a code set, the Salesforce implementation of Adverse​Event​Entry​.Status is text. | | actuality | Adverse​Event​Entry​.​Type | Dynamic Enum | 1.1 | While FHIR defines adverse​Event​Entry​.actuality as a code set, the Salesforce implementation of Adverse​Event​Entry​.type is dynamic enum. | | category | Adverse​Event​​Entry​.Category | Picklist (Multi-Select) | 0.M | While FHIR defines adverse​Event​Entry​.category as a code set bundle, the Salesforce implementation of Adverse​Event​Entry​.Category is picklist (Multi-Select). | | code | Adverse​Event​Entry​.Event​Code | Look​up: Code Set, Code Set Bundle | 0.1 | While FHIR defines adverse​Event​Entry​.event​Code as a code set bundle, the Salesforce implementation of Adverse​Event​Entry​.EventCode is a lookup. | | subject | Adverse​Event​Entry​.Subject | Polymorphic Look​up: Care​Program​​​Enrollee, Account, Team​Member, Care​Program​Group, Team, Health​Care​Provider | 1.1 | N/A | | encounter | Adverse​Event​Entry​.Clinical​Encounter | Look​up: Clinical Encounter | 0.1 | N/A | | cause | Adverse​Event​Entry.​Cause​Start​Date​Time | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, adverse​Event​.​cause is flattened into a set of cause start date time and cause end date time fields. | | cause | Adverse​Event​Entry​.Cause​End​Date​Time | Date​/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, adverse​Event​.​cause is flattened into a set of cause start date time and cause end date time fields. | | effect | Adverse​Event​Entry​.Event​Start​Date​Time | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, adverse​Event​.​effect is flattened into a set of event start date time and event end date time fields. | | effect | Adverse​Event​Entry​.Event​End​Date​Time | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, adverse​Event​.​effect is flattened into a set of event start date time and event end date time fields. | | detected | Adverse​Event​Entry​.Detected​Date | Date/Time | 0.1 | N/A | | recorded​Date | Adverse​Event​Entry​.Recorded​Date | Date/Time | 0.1 | N/A | | resulting​Effect | Adverse​Event​Resulting​Effect​.Effect | Lookup: Health Condition, Care Observation | 1.1 | While FHIR defines adverse​Event​Resulting​Effect​.resulting​Effect as a zero-to-many resource, the Salesforce implementation of Adverse​Event​Resulting​Effect​.Effect is one-to-many. | | location | Adverse​Event​Entry​.Location | Lookup: Healthcare Facility, Care Program Site | 0.1 | N/A | | seriousness | Adverse​Event​Entry​.Severity | Picklist | 0.1 | While FHIR defines adverse​Event​Entry​.Severity as a code set bundle, the Salesforce implementation of Adverse​Event​Entry​.Severity is picklist. | | outcome | Adverse​Event​Outcome​.Outcome​Code | Look​up: Code Set, Code Set Bundle | 1.1 | While FHIR defines adverse​Event​Outcome.outcome as a Code​Set​Bundle, the Salesforce implementation of Adverse​Event​​Outcome.Outcome​Code is a lookup. | | recorder | Adverse​Event​Entry.​Recorded​By | Look​up: Account Care Program Enrollee | 1.1 | While FHIR defines adverse​Event​Outcome​.recorder as a zero-to-many resource, the Salesforce implementation of Adverse​Event​Outcome​.RecordedBy is one-to-one. | | participant​.function | Adverse​Event​Party​.Role | Dynamic Enum | 0.1 | N/A | | participant​.actor | Adverse​Event​Party​.Party | Look​up: Account, Contact, Care Program Enrollee, Healthcare Facility, Care Registered Device, Healthcare Practitioner Facility | 1.1 | N/A | | expected​In​Research​Study | Adverse​Event​Entry​.Expected | Boolean | 0.1 | N/A | | suspect​Entity​.instance | Adverse​Event​Cause.​Cause | Look​up: Patient Immunization, Medication, Medication Statement, Research Study, Patient Medical Procedure, Care Registered Device | 1.1 | While FHIR defines adverse​Event​Cause​.suspect​Entity​.instance as a Code​Set​Bundle, the Salesforce implementation of Adverse​Event​Cause​.Cause is a lookup. | | suspect​Entity.​causality​.assessment​Method | Adverse​Event​Cause.​Assessment​Method​Code | Look​up: Code​Set, Code​Set​Bundle | 0.1 | N/A | | suspect​Entity.​causality.​entity​Relatedness | Adverse​Event​Cause.​Probability | Dynamic Enum | 0.1 | N/A | | suspect​Entity.​causality​.author | Adverse​Event​Cause.​Authored​By | Polymorphic Look​up: Account, Contact, User, Healthcare​Facility, Healthcare​Practitioner​Facility, Research​Study​Participant | 0.1 | N/A | | contributing​Factor​.item | Adverse​Event​Contributing​Factor.​Contributing​Factor | Polymorphic Look​up: Health​Condition, Care​Observation, Allergy​Intolerance, Patient​Immunization, Care​Registered​Device, Medication, Medication​Statement, Diagnostic​Summary, Patient​Medical​Procedure, Medication​Administration | 1.M | While FHIR defines adverse​Event​Contributing​Factor.​contributing​Factor​.item as a zero-to-many resource, the Salesforce implementation of Adverse​Event​Contributing​Factor.​Contributing​Factor is one-to-many. | | preventive​Action​.item | Adverse​Event​Action​.Action​Code | Polymorphic Look​up: Code​Set, Code​Set​Bundle | 0.1 | While FHIR defines adverse​Event​Action.​preventive​Action​.item as a one-to-one resource, the Salesforce implementation of Adverse​Event​Action​.ActionCode is zero-to-one. | | mitigating​Action​.item | Adverse​Event​Action​.Action​Code | Polymorphic Look​up: Code​Set, Code​Set​Bundle | 0.1 | While FHIR defines adverse​Event​Action.​mitigating​Action​.item as a one-to-one resource, the Salesforce implementation of Adverse​Event​Action​.ActionCode is zero-to-one. | | supporting​Info​.item | Adverse​Event​Supporting​Information​.Supporting​Information | Polymorphic Look​up: Health​Condition, Care​Observation, Allergy​Intolerance, Patient​Immunization, Diagnostic​Summary, Medication, Medication​Statement | 1.1 | N/A | # AdverseEventAction Preventive actions that contributed to avoiding the adverse event or Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the adverse incident action. This field is a polymorphic relationship field. - **Relationship Name**: ActionCode - **Refers To**: CodeSet, CodeSetBundle ### ActionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The reference of the action that caused the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: ActionReference - **Refers To**: DiagnosticSummary, Medication, MedicationRequest, PatientImmunization, PatientMedicalProcedure ### ActionType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifes the type of action that contributed to the adverse incident. - **Default value**: Preventive - **Possible values**: - Mitigative - Preventive ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent adverse incident associated with the action. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ## 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. [AdverseEventActionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventActionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventActionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEventCause Describes the entity that is suspected to have caused the adverse event. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The adverse incident associated with the adverse incident cause. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### AssessmentMethodCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assessment method code associated with the adverse incident cause. This field is a polymorphic relationship field. - **Relationship Name**: AssessmentMethodCode - **Refers To**: CodeSet, CodeSetBundle ### AuthoredById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who has authored the adverse incident cause. This field is a polymorphic relationship field. - **Relationship Name**: AuthoredBy - **Refers To**: Account, Contact, HealthcareFacility, HealthcarePractitionerFacility, ResearchStudyCandidate, User ### CauseCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the adverse incident cause. This field is a polymorphic relationship field. - **Relationship Name**: CauseCode - **Refers To**: CodeSet, CodeSetBundle ### CauseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The cause of the adverse event. This field is a polymorphic relationship field. - **Relationship Name**: Cause - **Refers To**: CareRegisteredDevice, Medication, MedicationStatement, PatientImmunization, PatientMedicalProcedure, ResearchStudy ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ### Probability - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the probability of the cause to have been the reason for the adverse incident. - **Possible values**: - Certain - Likely - Possible - Unlikely - Conditional or Classified - Unassessable or Unclassifiable ## 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. [AdverseEventCauseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventCauseFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventCauseHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEventContribFactor The contributing factors suspected to have increased the probability or severity of the adverse event. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent adverse incident associated with the contributing factor of the incident. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### ContributingFactorCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contributing factor of the adverse event. This field is a polymorphic relationship field. - **Relationship Name**: ContributingFactorCode - **Refers To**: CodeSet, CodeSetBundle ### ContributingFactorId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code of the adverse event contributing factor. This field is a polymorphic relationship field. - **Relationship Name**: ContributingFactor - **Refers To**: AllergyIntolerance, CareObservation, CareRegisteredDevice, DiagnosticSummary, HealthCondition, Medication, MedicationStatement, PatientImmunization, PatientMedicalProcedure ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ## 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. [AdverseEventContribFactorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventContribFactorFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventContribFactorHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEventEntry Represents the event related to unintended/anticipated effects on research participants. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the category of the adverse event. - **Possible values**: - Wrong Patient - Procedure Incident - Medication Incident - Device Malfunction - Unsafe Physical Environment - Hospital Acquired Infection - Wrong Body Site ### CauseEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the cause. ### CauseStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the cause. ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter associated with the adverse incident. This field is a relationship field. - **Relationship Name**: ClinicalEncounter - **Refers To**: ClinicalEncounter ### DetectedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the adverse event was detected. ### EventCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: EventCode - **Refers To**: CodeSet, CodeSetBundle ### EventEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the incident. ### EventStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the incident. ### HasSubjectDiscontinuedStudy - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the subject has discontinued from the research study due to the adverse incident. - **Default value**: false ### IsExpected - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the adverse incident is expected for the research study. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The site where the adverse event occured. This field is a polymorphic relationship field. - **Relationship Name**: Location - **Refers To**: CareProgramSite, HealthcareFacility ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the adverse event. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RecordedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account or person who recorded the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: RecordedBy - **Refers To**: Account, CareProgramEnrollee ### RecordedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the adverse event was recorded. ### RelatedAdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The adverse event entry that's associated with this record. This field is a relationship field. - **Relationship Name**: RelatedAdverseEventEntry - **Refers To**: AdverseEventEntry ### ReportingContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context for which the adverse incident has been reported. This field is a polymorphic relationship field. - **Relationship Name**: ReportingContext - **Refers To**: ResearchStudy ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the severity of the adverse event. - **Possible values**: - Mild - Moderate - Serious - Life Threatening or Disabling - Death - Unserious ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the adverse incident. - **Possible values**: - In Progress - Completed - Entered-in-Error - Unknown ### SubjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The subject of the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: Subject - **Refers To**: Account, CareProgramEnrollee, HealthcareProvider ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of adverse incident. - **Possible values**: - Actual Adverse Event - Potential Adverse Event ## 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. [AdverseEventEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventEntryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventEntryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AdverseEventEntryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AdverseEventOutcome Type of outcome from the adverse event. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent adverse incident associated with the outcome. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ### OutcomeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code of the adverse event outcome. This field is a polymorphic relationship field. - **Relationship Name**: OutcomeCode - **Refers To**: CodeSet, CodeSetBundle ## 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. [AdverseEventOutcomeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventOutcomeFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventOutcomeHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEventParty Indicates who or what participated in the adverse event and how they were involved. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The adverse incident associated with the party. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the adverse event. ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the adverse event party. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Refers To**: Account, CareProgramEnrollee, CareRegisteredDevice, Contact, HealthcareFacility, HealthcarePractitionerFacility ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the role of the party in the adverse incident. - **Possible values**: - Informant - Participant - Witness - Author - LSAdverseEventPartyRole ## 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. [AdverseEventPartyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventPartyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventPartyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEventSupportInfo Supporting information relevant to the event. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent adverse incident associated with the supporting information. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ### SupportingInfoCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the supporting information. This field is a polymorphic relationship field. - **Relationship Name**: SupportingInfoCode - **Refers To**: CodeSet, CodeSetBundle ### SupportingInformationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The supporting information of the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: SupportingInformation - **Refers To**: AllergyIntolerance, CareObservation, DiagnosticSummary, HealthCondition, Medication, MedicationStatement, PatientImmunization ## 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. [AdverseEventSupportInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEventSupportInfoFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEventSupportInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdverseEvntResultingEffect Effect on the subject due to this event. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdverseEventEntryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent adverse incident associated with the effect. This field is a relationship field. - **Relationship Name**: AdverseEventEntry - **Relationship Type**: Master-detail - **Refers To**: AdverseEventEntry (the master object) ### EffectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The effect of the adverse incident. This field is a polymorphic relationship field. - **Relationship Name**: Effect - **Refers To**: CareObservation, HealthCondition ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ## 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. [AdverseEvntResultingEffectChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AdverseEvntResultingEffectFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdverseEvntResultingEffectHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AdvTherapyFieldOptOverride Represents a list of fields with changed optionality, based on certain parameters. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country for which the override is applicable. This field is a relationship field. - **Relationship Name**: Country - **Relationship Type**: Lookup - **Refers To**: GeoCountry ### FieldList - **Type**: textarea - **Properties**: Create, Update - **Description**: The list of fields with optionality that's overruled based on the priority of the conditions. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the field optionality override record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the field optionality override record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Priority - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The priority of each condition. ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory condition for which the override is applicable. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### TaskName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The task condition for which the override is applicable. ### WorkProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work procedure condition for which the override is applicable. This field is a relationship field. - **Relationship Name**: WorkProcedure - **Relationship Type**: Lookup - **Refers To**: WorkProcedure ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type condition for which the override is applicable. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### WorkTypeStepId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type step condition for which the override is applicable. This field is a relationship field. - **Relationship Name**: WorkTypeStep - **Relationship Type**: Lookup - **Refers To**: WorkTypeStep ## 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. [AdvTherapyFieldOptOverrideChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [AdvTherapyFieldOptOverrideFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AdvTherapyFieldOptOverrideHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AdvTherapyFieldOptOverrideOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AdvTherapyFieldOptOverrideShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AL1 - Patient Allergy Information The 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](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below. Table 1. AL1 - Salesforce | AL1 | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | AL1.2 - Allergy Type | AllergyIntolerance.Category | Picklist | N/A | | AL1.3 - Allergy Code/Mnemonic/ Description | AllergyIntolerance.CodeId | Lookup: CodeSetBundle | N/A | | AL1.4 - Allergy Severity | Patient​Health​Reaction​.Severity | Picklist | N/A | | AL1.5 - Allergy Reaction | Patient​Health​Reaction​.Manifested​SymptomId | Lookup: CodeSetBundle | N/A | | AL1.6 - Identification Date | onset​.onset​Date​Time | DateTime | N/A | # AllergyIntolerance Represents a clinical assessment of a patient’s allergy or intolerance. 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() ## Additional Information for AllergyIntolerance in Other Objects In addition to creating a record using these fields, you can add more details to your AllergyIntolerance record by creating records in certain other objects, and referencing your AllergyIntolerance record as the parent record. Here’s the list of objects you can relate to AllergyIntolerance in this way, the type of information they add, and the field they use to reference AllergyIntolerance. | Object | Type of Information | Reference Field | | --- | --- | --- | | PatientMedicalReaction | Specifies the information about the patient’s adverse reaction linked to the allergy or intolerance. | ParentId | | Identifier | Associates an identifier value to the allergy intolerance. | ParentRecordId | ## Fields ### AssertionSourceId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the person who asserted the information about the allergy or intolerance. - **Example**: The patient or the provider who assessed the patient’s condition. - **Referenced Objects**: - Account - HealthcareProvider ### Category - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the categories the allergy or intolerance belongs to. - **Possible values**: - Biologic - Environment - Food - Medication ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter where the allergy or intolerance was asserted. - **Example**: The encounter record for a patient’s ER visit after a bee sting. ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the allergy or intolerance. ### LastOccurrenceDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date of the last occurrence of the allergy or intolerance. - **Example**: 1993-11-09T21:45:00.384Z ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the AllergyIntolerance record. ### OnsetEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end of the estimated onset period. - **Example**: 1993-11-09T23:50:00.384Z ### OnsetStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The onset date of the allergy intolerance or the estimated start date of the allergy intolerance's onset. - **Example**: 1993-11-09T21:45:00.384Z ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the allergy intolerance record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient who has the allergy or intolerance. - **Referenced Objects**: - Account ### RecordCreationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time the record for the allergy or intolerance was created. ### RecordCreatorId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who created the record for the allergy or intolerance. - **Referenced Objects**: - Account - HealthcareProvider ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the severity of the allergy or intolerance. - **Possible values**: - High - Low - Unable to assess ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the allergy or intolerance. - **Possible values**: - Active - Inactive - Resolved ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the record is about an allergy or an intolerance. - **Possible values**: - Allergy - Intolerance ### VerificationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the allergy or intolerance has been verified. - **Possible values**: - Confirmed - Entered in error - Refuted - Unconfirmed ## 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. [AllergyIntoleranceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [AllergyIntoleranceOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [AllergyIntoleranceShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # Allergy​Intolerance The allergy​Intolerance FHIR resource maps to the Allergy​Intolerance and PatientHealthReaction objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [allergy​Intolerance](https://www.hl7.org/fhir/allergyintolerance.html) map to the fields in Salesforce. Table 1. allergy​Intolerance - Salesforce | Allergy​Intolerance Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0.M | The identifier information for an allergy intolerance is represented as Identifier records that reference the Allergy​Intolerance record using their Identifier​.Parent​RecordId field. | | clinical​Status | Allergy​Intolerance​.Status | Picklist | 0.1 | While FHIR defines allergy​Intolerance​.clinical​Status as a code set bundle, the Salesforce implementation of Allergy​Intolerance​.Status is picklist. | | verificationStatus | Allergy​Intolerance​.VerificationStatus | Picklist | 0.1 | While FHIR defines allergy​Intolerance​.verification​Status as a code set bundle, the Salesforce implementation of Allergy​Intolerance​.Verification​Status is picklist. | | type | Allergy​Intolerance​.Type | Picklist | 0.1 | While FHIR defines allergy​Intolerance​.category as a code set bundle, the Salesforce implementation of Allergy​Intolerance​.Categories is a picklist. | | category | Allergy​Intolerance​.Category | Multi-Select Picklist | 0.M | While FHIR defines allergy​Intolerance​.category as a code set bundle, the Salesforce implementation of Allergy​Intolerance​.Category is a picklist. | | criticality | Allergy​Intolerance​.Severity | Picklist | 0.1 | While FHIR defines allergy​Intolerance​.criticality as a code set bundle, the Salesforce implementation of Allergy​Intolerance​.Severity is picklist. | | code | Allergy​Intolerance​.CodeId | Lookup: CodeSetBundle | 1.1 | N/A | | patient | Allergy​Intolerance​.PatientId | Master-Detail Reference: Account | 1.1 | N/A | | encounter | Allergy​Intolerance​.Clinical​EncounterId | Lookup: Clinical​Encounter | 0.1 | N/A | | onset​.onset​Date​Time | Allergy​Intolerance​.Onset​Start​Date​Time | Date​Time | 0.1 | Allergy​Intolerance​.Onset​Start​Date​Time is used as both the equivalent of allergy​Intolerance​.onset​.onset​Date​Time and the start date of allergy​Intolerance​.onset​.onset​Period | | onset​.onset​Age | N/A | N/A | N/A | Not supported | | onset​.onset​Period | Allergy​Intolerance​.Onset​Start​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, allergy​Intolerance​.onset​.onset​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of allergy​Intolerance​.onset​.onset​Date​Time | | onset​.onset​Period | Allergy​Intolerance​.Onset​End​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, allergy​Intolerance​.onset​.onset​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of allergy​Intolerance​.onset​.onset​Date​Time | | onset​.onset​Range | N/A | N/A | N/A | Not supported | | onset​.onset​String | N/A | N/A | N/A | Not supported | | recorded​Date | Allergy​Intolerance​.Record​Creation​Date​Time | Date​Time | 0.1 | N/A | | recorder | Allergy​Intolerance​.Record​Creator​Id | Polymorphic Lookup: Account, Healthcare​.Provider | 0.1 | N/A | | asserter | Allergy​Intolerance​.Assertion​SourceId | Polymorphic Lookup: Account, Healthcare​.Provider | 0.1 | N/A | | last​Occurrence | Allergy​Intolerance​.Last​Occurence​Date​Time | Date​Time | 0.1 | N/A | | note | N/A | N/A | N/A | Not supported | | reaction | Patient​Health​Reaction | Object | 0.M | The reaction information for an allergy intolerance is represented as Patient​Health​Reaction records that reference the Allergy​Intolerance record using their Patient​Health​Reaction​.ParentId field. | | reaction​.substance | Patient​Health​Reaction​.Causative​Substance​Id | Lookup: CodeSet​Bundle | 0.1 | N/A | | reaction​.manifestation | Patient​Health​Reaction​.Manifested​SymptomId | Lookup: CodeSet​Bundle | 0.1 | While FHIR defines allergy​Intolerance​.reaction​.manifestation as a one-to-many resource, the Salesforce implementation of Patient​Health​Reaction​.Manifested​SymptomId is zero-to-one. | | reaction​.description | Patient​Health​Reaction​.Details | String | 0.1 | N/A | | reaction​.onset | Patient​Health​Reaction​.Reaction​Date​Time | Date​Time | 0.1 | N/A | | reaction​.severity | Patient​Health​Reaction​.Severity | Picklist | 0.1 | While FHIR defines allergy​Intolerance​.reaction​.severity as a code set bundle, the Salesforce implementation of Patient​Health​Reaction​.Severity is a picklist. | | reaction​.exposure​Route | Patient​Health​Reaction​.Exposure​RouteId | Lookup: CodeSet​Bundle | 0.1 | N/A | | reaction​.note | N/A | N/A | N/A | Not supported | #### See Also - [AllergyIntolerance](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_AllergyIntolerance.htm "Represents a clinical assessment of a patient’s allergy or intolerance. This object is available in API version 51.0 and later.") # Annotation The Annotation FHIR resource maps to the AuthorNote​ object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Annotation](https://www.hl7.org/fhir/datatypes.html#Annotation) map to the fields in Salesforce. Table 1. Annotation - Salesforce | Annotation Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | author​.author​Reference | Author​Note​.AuthorId | Lookup: Account, Contact, Healthcare​Provider | 0.1 | N/A | | author​.author​String | Author​Note​.Author​Name | String | 0.1 | N/A | | time | Author​Note​.Authored​DateTime | DateTime | 0.1 | N/A | | text | Activity​Timing​.Note​Text | Double | 0.1 | N/A | # Apex Reference This Apex reference goes into detail about the built-in Apex classes, interfaces, methods, or enums for Life Sciences Cloud. For Apex-related objects and SOAP API calls, see [Objects and SOAP API Calls and Headers for Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/soap-apex.htm) in the SOAP API Developer Guide. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When you write triggers on ContentDocument and ContentDocumentLink, exclude execution for the CloudIntegrationUser user type. - **[ActivityPlanToTerritories(activityPlanId, territoryIds)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_ActivityPlanToTerritories_ActivityPlanToTerritories.htm)** Creates an instance of the ActivityPlanToTerritories class to pair a source activity plan with territory IDs. - **[embeddedai Namespace](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_namespace_embeddedai.htm)** The embeddedai namespace provides classes and methods to manage and represent records and data in Apex to support embedded AI features. - **[ConnectApi Namespace](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_classes_connect_api.htm)** The ConnectApi namespace (also called Connect in Apex) provides classes for accessing the same data available in Connect REST API. Use Connect in Apex to create custom experiences in Salesforce. # ApexMap Class Create, clone, and convert string based key-value pairs to a JSON string format. ## Namespace [embeddedai](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_namespace_embeddedai.htm "The embeddedai namespace provides classes and methods to manage and represent records and data in Apex to support embedded AI features.") - **[ApexMap Constructors](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_constructors)** Learn more about the constructors available with the ApexMap class. - **[ApexMap Properties](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_properties)** - **[ApexMap Methods](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_methods)** Create a copy of the ApexMap object and convert key-value pairs to string format. ## ApexMap Constructors Learn more about the constructors available with the ApexMap class. The ApexMap class includes these constructors. - **[ApexMap(key, value)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_ctor)** Initializes a new instance of the ApexMap class by assigning the specified key and value. This constructor creates a single key–value entry that can be included in an embedded AI Apex map for passing contextual data to embedded AI logic. - **[ApexMap()](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_ctor_2)** Initializes the ApexMap class. ### ApexMap(key, value) Initializes a new instance of the ApexMap class by assigning the specified key and value. This constructor creates a single key–value entry that can be included in an embedded AI Apex map for passing contextual data to embedded AI logic. #### Signature public ApexMap(String key, String value) #### Parameters - **key**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) The unique identifier for an entry in the embedded AI Apex map. This key references and retrieves the associated value during embedded AI processing. - **value**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) The data associated with the specified key in the embedded AI Apex map. This value stores the contextual information consumed by embedded AI logic. ### ApexMap() Initializes the ApexMap class. #### Signature public ApexMap() ## ApexMap Properties These are the properties for ApexMap. - **[key](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_key)** Represents key of the key-value pair. This property is used to store the unique ID or name of the data. - **[value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_value)** Represents value of the key-value pair. This property is used to store the data associated with the key. ### key Represents key of the key-value pair. This property is used to store the unique ID or name of the data. #### Signature public String key {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### value Represents value of the key-value pair. This property is used to store the data associated with the key. #### Signature public String value {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## ApexMap Methods Create a copy of the ApexMap object and convert key-value pairs to string format. These are the methods for ApexMap. - **[toString()](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_toString)** Returns a string representation of the ApexMap object. ### toString() Returns a string representation of the ApexMap object. #### Signature public String toString() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # API End-of-Life Policy Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality and performance of the API, versions that are over 3 years old sometimes are no longer supported. Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends. # App Alerts App Alerts keep users informed of critical updates, events, and insights that require timely action, helping to prevent missed opportunities. These alerts can deliver messages from admins and managers, as well as system-triggered updates and external recommendations, enabling users to act directly or dismiss suggestions with feedback. Serving as a direct, immediate communication channel, App Alerts integrate across components to streamline teamwork and enhance commercial engagement. ![App Alerts entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_app_alerts_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/app-alerts.html "HTML (New Window)"). ## App Alerts Objects in Life Sciences Customer Engagement - [App Alert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalert.htm) - [App Alert Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalertterritory.htm) - [App Alert User Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalertuserresponse.htm) - [Record Alert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_recordalert.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # AppAlert Represents an alert message at the object, tab, or global level. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional details of the message that are communicated in the app alert. This field contains information such as the tag, alert action, URL, or color. ### DisplayContextName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context name related to the app alert display. Possible values are the object name or API name of the tab. ### DisplayContextType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the context type related to the app alert display. - **Possible values**: - Global - Object - Tab ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time that the alert becomes active. ### ImageURL - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the app alert is silent or not. - **Default value**: false ### IsSilent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the app alert is silent or not. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Message - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The message communicated in the app alert. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the app alert. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this app alert record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SnoozeUntilDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date until which the alert is snoozed. ### Source - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source of the app alert. ### SourceSystemIdentifier - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### Subject - **Type**: textarea - **Properties**: Create, Update - **Description**: The subject of the app alert. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of app alert. - **Possible values**: - GuidedAction - Notification - Recommendation - Announcement ### ValidUntilDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the alert becomes invalid. ## 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. [AppAlertChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AppAlertFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AppAlertHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AppAlertShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AppAlertTerritory Represents a junction between an Alert and a Territory where the alert is sent. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AlertReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The app alert or record alert that's associated with the alert territory. This field is a polymorphic relationship field. - **Relationship Name**: AlertReferenceRecord - **Refers To**: AppAlert, RecordAlert ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the app alert territory. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this app alert territory record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory that's associated with the alert. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. [AppAlertTerritoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AppAlertTerritoryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AppAlertTerritoryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AppAlertTerritoryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AppAlertTerritoryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AppAlertUserResponse Represents the user action for an alert. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AlertReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The app alert or record alert that's associated with the alert user action. This field is a polymorphic relationship field. - **Relationship Name**: AlertReferenceRecord - **Refers To**: AppAlert, RecordAlert ### DismissalReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the user dismissed the alert. ### IsAlertRead - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user read the alert or not. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the app alert user response. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this app alert user response record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### UserAction - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the action performed by the user on the alert. - **Possible values**: - Dismissed - Resolved ### UserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The user who acted upon the alert. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User ## 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. [AppAlertUserResponseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [AppAlertUserResponseFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AppAlertUserResponseHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AppAlertUserResponseShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Applicant Specify the care program enrollee represented as an applicant. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account ID associated with the applicant. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ApplicationFormId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The application that's submitted for a product request. This field is a relationship field. - **Relationship Name**: ApplicationForm - **Relationship Type**: Lookup - **Refers To**: ApplicationForm ### BirthDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date of birth of the applicant. ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is a relationship field. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related contact ID associated with the account. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### Email - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The email address of the applicant. ### FirstName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The first name of the applicant. ### LastName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The last name of the applicant. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MiddleName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The middle name of the applicant. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: A unique number that represents the applicant. ### PartyProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The party profile requesting a product with the application form. This field is a relationship field. - **Relationship Name**: PartyProfile - **Relationship Type**: Lookup - **Refers To**: PartyProfile ### Phone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The applicant's phone number. ### Suffix - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The suffix of the applicant. ### UniqueReferenceNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The customer reference number of the applicant. ## Associated Objects This object has these associated objects. If the API version isn’t specified, they’re available in the same API version as this object. Otherwise, they’re available in the specified API version and later. [ApplicantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ApplicantFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ApplicantHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ApplicantOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ApplicantShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ApplnFormAppealStsChgEvnt Notifies subscribers of changes to the status of an appeal filed against a Financial Assistance Program. This object is available in API version 63.0 and later. ## Supported Calls create(), describeSObjects() ## Special Access Rules This object is available to users with Health Cloud Starter and Manage Financial Assistance Program permission set. ## Fields ### AppealIdentifier - **Type**: string - **Properties**: Create, Nillable - **Description**: The identifier of an appeal that has a status change. ### AppealStatus - **Type**: picklist - **Properties**: Create, Nillable, Restricted picklist - **Description**: Specifies the status of an appeal. - **Possible values**: - Accepted - Rejected ### ApplicationFormIdentifier - **Type**: string - **Properties**: Create, Nillable - **Description**: The identifier of the application associated with an appeal. ### EventCreationDateTime - **Type**: dateTime - **Properties**: Create, Nillable - **Description**: The date and time when the event was created. # Appointed Representative Person who is an appointed representative for the member. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | firstName | String | First Name of the appointed representative. Maps to: Account.FirstName | Big, 46.0 | 46.0 | | lastName | String | Last Name of the appointed representative. Maps to: Account.LastName | Big, 46.0 | 46.0 | # Appointed Representative Input Person who is the appointed representative for the member. ## Root XML tag ## JSON example { "firstName": "Jane", "lastName": "Doe" } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | firstName | String | First Name of the appointed representative. | No | 46.0 | | lastName | String | Last Name of the appointed representative. | No | 46.0 | | suffix | String | Name suffix of the appointed representative. | No | 46.0 | | birthDate | String | Birth date of the appointed representative. | No | 46.0 | ![Tip](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_tip.png) #### Tip All the fields in this input are optional. However, it is advisable to provide as much information as possible to find a unique appointed representative record to associate with your care request. # AsmtIndDefExt Represents the translations of assessment indicator definitions. The API name for the Assessment Indicator Definition object is 29 characters, exceeding the 25-character limit for data translation. So, translating assessment indicator definitions requires a new object. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentIndDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment indicator definition associated with the translation. This field is a relationship field. - **Relationship Name**: AssessmentIndDefinition - **Relationship Type**: Master-detail - **Refers To**: AssessmentIndicatorDefinition ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the assessment indicator definition associated with the translation. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the assessment indicator definition translation. # AssessmentConfiguration Represents a configuration for Assessment component. An AssessmentConfiguration entry indicates configuration for user flows such as sending out emails or reminder actions on assessments initiated by the patient. This object is available in API version 58.0 and later. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### Configuration - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The configuration name that identifies the action. - **Possible values**: - Send ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the AssessmentConfiguration ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label that identifies the AssessmentConfiguration throughout the Salesforce user interface. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### ResolutionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The flow definition that is used to perform the action This field is a relationship field. - **Relationship Name**: Resolution - **Relationship Type**: Lookup - **Refers To**: FlowDefinition ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The feature-specific value for this assessment configuration. - **Possible values**: - DiscoveryFramework—Discovery Framework ## 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. [AssessmentConfigurationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # AssessmentEnvelope Represents information about an envelope that contains the assessments related to a user. For example, you can create an envelope that contains assessments for a patient or a caregiver related to depression or anxiety. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The recipient of the assessment envelope, such as a patient. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The recipient of the assessment envelope, such as a caregiver. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### ExpirationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time of assessment envelope expiration. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the assessment envelope. ### NotificationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The sent status of the assessment envelope - **Possible values**: - NotSent - Sent ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RequestReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference to the context of the assessment envelope request. This field is a polymorphic relationship field. - **Relationship Name**: RequestReference - **Relationship Type**: Lookup - **Refers To**: Case, ClinicalEncounter, ClinicalServiceRequest, ServiceAppointment ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the envelope that contains the assessments - **Possible values**: - Completed - InProgress—In Progress - NotStarted—Not Started ## Associated Objects This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. [AssessmentEnvelopeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [AssessmentEnvelopeFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AssessmentEnvelopeHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AssessmentEnvelopeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AssessmentEnvelopeShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # AssessmentEnvelopeItem Represents information about an item in an envelope that contains the assessments related to a user. For example, you can create an item that contains an assessment for depression or anxiety. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentEnvelopeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment envelope that is associated with the item. This field is a relationship field. - **Relationship Name**: AssessmentEnvelope - **Relationship Type**: Lookup - **Refers To**: AssessmentEnvelope ### AssessmentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the assessment envelope item. This field is a relationship field. - **Relationship Name**: Assessment - **Relationship Type**: Lookup - **Refers To**: Assessment ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Tne name of the assessment envelope item. ### OmniProcessId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represent the related OmniProcess. This field is a relationship field. - **Relationship Name**: OmniProcess - **Relationship Type**: Lookup - **Refers To**: OmniProcess ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the status of the assessment envelope item. - **Possible values**: - Completed - InProgress - NotStarted ## 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. [AssessmentEnvelopeItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [AssessmentEnvelopeItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AssessmentEnvelopeItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # AssessmentTask Perform activities such as patient registration or order authorization to capture information. ## Special Access Rules In Life Sciences Cloud, standard and custom fields extend the standard AssessmentTask object to represent tasks to complete a provider engagement compliance cycle. The AssessmentTask object and its fields are used by the Key Account Management and the Provider Engagement Compliance feature areas. This topic lists the fields used in both of these features. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentTaskDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assessment task definition that is referenced for the task. This field is a relationship field. - **Relationship Name**: AssessmentTaskDefinition - **Refers To**: AssessmentTaskDefinition ### AssignedToId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the user that's assigned the task. This field is a polymorphic relationship field. - **Relationship Name**: AssignedTo - **Relationship Type**: Lookup - **Refers To**: User ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of task that has to be performed at the store. ### EndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the assessment task is completed. ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicate whether a task must be completed to complete a visit. - **Default value**: False ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this assessment template. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with an assessment task. This field is a relationship field. - **Relationship Name**: Parent - **Refers To**: Visit ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the record with which the associated task is related. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWkOrdStep, ActionPlan, PrvdEngmtComplianceCycle Based on the availability of objects in your org. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the tasks must be performed. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### StartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time when the task was started by a field rep. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: View the status of a task. - **Default value**: Not Started - **Possible values**: - Completed - InProgress—In Progress - NotStarted—Not Started - Skipped ### TaskType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: Type of a task that the sales rep can perform during the visit. In Life Sciences Cloud, the task type must match the task type of the assessment task definition. - **Possible values**: - ComponentTask—Component Task - DeliveryTask—Delivery Task - Other - RecordAction—Record Action - SignatureTask—Signature Task ## 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. - [AssessmentTaskShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") - [AssessmentTaskFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") # Assign Candidate to Research Study Group Action Assign candidates, enrolled in the clinical trials through randomization to research study comparison groups. This action is available in API version 61.0 and later. ## Special Access Rules The Assign Candidate to Research Study Group action is available in Enterprise and Unlimited Editions with Life Sciences Cloud and the Participant Enrollment Add-On license. Additionally, the org must be enabled with Research Study Randomization. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/assignCndtToResearchStudyGroup Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
researchStudy​CandidateId string Required.

ID of the research study candidate record that’s randomly assigned to a research study comparison group.
## Outputs The researchStudyComparisonGroupId parameter is shown in the response body only if one of these conditions is met. - The DoesAsgnCandidatesToGroups field on the ResearchStdyRandomization object is set to false. - The DoesAsgnCandidatesToGroups field is set to true and the user has access to the ResearchStdyCmprGroupCndt object. | Output | Type | Description | | --- | --- | --- | | candidateAllocation​SourceId | string | ID of the context object or process that’s used to determine the group to assign a candidate to. | | researchStudy​ComparisonGroupId | string | ID of the research study comparison group that’s assigned to a candidate. | ## Example **POST** This sample request is for the Assign Candidate to Research Study Group action. { "inputs": \[ { "researchStudyCandidateId": "7evxx00000000cjAAA" } \] } This sample response is for the Assign Candidate to Research Study Group action. \[ { "actionName": "assignCndtToResearchStudyGroup", "errors": null, "invocationId": null, "isSuccess": true, "outputValues": { "researchStudyComparisonGroupId": "1F0xx0000004CSPCA2", "candidateAllocationSourceId": "1LtSG0000002P8n" }, "sortOrder": -1, "version": 1 } \] #### See Also - [_Salesforce Help_: Enable Participant Management](https://help.salesforce.com/s/articleView?id=ind.lsc_admin_enable_participant_management.htm&type=5&language=en_US "Salesforce Help: Enable Participant Management - HTML (New Window)") - [_Salesforce Help_: Anonymize Participant Allocation Using Randomization](https://help.salesforce.com/s/articleView?id=ind.lsc_admin_participant_management_using_randomization.htm&type=5&language=en_US "Salesforce Help: Anonymize Participant Allocation Using Randomization - HTML (New Window)") # Attachment The Attachment FHIR resource maps to the Attachment object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Attachment](https://www.hl7.org/fhir/datatypes.html#Attachment) map to the fields in Salesforce. Table 1. Attachment - Salesforce | Attachment Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | content​Type | Attachment​.Content​Type | String | 0.1 | FHIR defines Attachment​.use as a code set. However, the Salesforce implementation of Attachment​.Content​Type is a string. | | language | Diagnostic​Summary​.Attachment​Language | String | 0.1 | FHIR defines Attachment​.use as a code set. However, the Salesforce implementation of Diagnostic​Summary​.Attachment​Language is a string. | | data | Attachment​.Body | Base64 | 0.1 | N/A | | url | N/A | N/A | N/A | Not supported | | size | Attachment​.Body​Length | Double | 0.1 | N/A | | hash | N/A | N/A | N/A | Not supported | | title | Attachment​.Name | String | 0.1 | N/A | | Creation | Attachment​.Created​Date | Date​Time | 0.1 | N/A | # AuthorNote Stores notes associated with different types of records along with information about the author of the note and the time the note was authored. The author isn’t necessarily the person who created a record. The author is the person who provided the information in the note. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AuthorId - **Type**: Preference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the author of the note. This is a polymorphic relationship field. - **Relationship Name**: Author - **Relationship Type**: Lookup - **Referenced Objects**: - Account - Contact - HealthcareProvider - User—This value is available in API version 55.0 and later. ### AuthorName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the author of the note. ### AuthoredDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the note was authored. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the AuthorNote record. This value is generated automatically. ### NoteText - **Type**: textarea - **Properties**: Create, Update - **Description**: The contents of the note. ### OwnerId - **Type**: Polymorphic reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the AuthorNote record. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Referenced Objects**: Group, User ### ParentRecordId - **Type**: Polymorhpic reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References 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 - MedicationRequest - MedicationStatement - PatientImmunization - PatientMedicalProcedure ### RecipientType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of recipient for an author note. This field is available in API version 55.0 and later. - **Possible values**: - Patient - Provider ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system the record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last changed in the source system. ## Usage When a record requires a related note with the information about the author of that note, that information is stored in an AuthorNote record. This AuthorNote record references the parent record it’s associated with using the ParentRecordId field. ## 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. [AuthorNoteFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AuthorNoteHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AuthorNoteShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. [AuthorNoteChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # Award Represents a person's or organization's professional awards. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the organization receiving the award. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### AwardDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date award was received. ### AwardedBy - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the issuing organization. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person who received the award and is listed as a contact. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Healthcare provider that this award is associated with. This field is a relationship field. - **Relationship Name**: HealthcareProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### Identifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Issuing organization's identifier for the award recipient. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Award name. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user who owns this record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Award status. Example values: - Inactive - Revoked - Draft - Verified ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the person who received the award and is listed as a user. This field is a relationship field. - **Relationship Name**: User - **Relationship Type**: Lookup - **Refers To**: User ### VerificationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Current award status. Example values: - Authorized - Pending - Unverified ### VerifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Award was validated on this date. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [AwardChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [AwardFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [AwardHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [AwardOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [AwardShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # BatchJob Represents an instance of a batch job that is either running and has been run. This object is available in Life Sciences Cloud API version 65.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the batch job. This field is available in API version 65.0 when Life Sciences Cloud is enabled. ### BatchJobDefinitionId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The unique identifier of the associated batch job definition. This is a relationship field. - **Relationship Name**: BatchJobDefinition - **Relationship Type**: Lookup - **Refers To**: BatchJobDefinition ### BatchJobDefinitionName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The developer name of the associated batch job definition. ### BatchJobPartCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of the batch job parts. This field is available in API version 65.0 when Life Sciences Cloud is enabled. ### EndTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the batch job run was completed. ### ErrorDescription - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: The error message in case the batch job run failed. ### ExternalReference - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unique identifier of the process that's running or has run the batch job. ### IsDebugOn - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if debug mode is turned on. - **Default value**: false ### IsDebugRecipeDeleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed the batch job. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this item. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The name of the batch job. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Unique identifier of the user who initiated the batch job run. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProcessGroup - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The group or team for which the batch job is run. ### RetryCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of times the batch job run is automatically rerun in case it fails. ### RuntimeParameter - **Type**: textarea - **Properties**: Nillable - **Description**: The values of the input variables that are used as filter criteria in a Batch Management job. ### StartTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the batch job run was started. ### Status - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: The status of the batch job run. - **Possible values**: - Canceled - Completed - CompletedWithFailures - Failed - InProgress - Submitted ### Type - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: The type of batch job that is run. - **Possible values**: - Calc Data Processing Engine - DecisionTableRefresh - Flow ## 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. [BatchJobFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Change events are available for the object. [BatchJobHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") Feed tracking is available for the object. # BatchJobPart Represents one part of a batch job. This object is available in Life Sciences Cloud in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### BatchJobId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The unique identifier of the associated batch job. This is a relationship field. - **Relationship Name**: BatchJob - **Relationship Type**: Lookup - **Refers To**: BatchJob ### EndTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the batch job part was processed. ### ErrorDescription - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: The error message in case the batch job part failed. ### FailedRecordCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of records that the batch job part couldn't process. ### FailedRecFile - **Type**: FILE - **Properties**: Filter, Group, Sort - **Description**: The file containing failed records downloaded as CSV, JSON, or TXT formats during a Data Processing Engine definition’s run by using CRM Analytics (CRMA) or Data Cloud runtime. ### InputRecordCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of records that the batch job part must process. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The name of the batch job part. ### OutputRecordCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of records the batch job part has processed. ### ParentBatchJobPartId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unique identifier of the part batch job part associated with the batch job part. This is a relationship field. - **Relationship Name**: ParentBatchJobPart - **Relationship Type**: Lookup - **Refers To**: BatchJobPart ### PrimarySrcObjProcessedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of output records from the first object in a junction when the source of the batch job is a junction object. This field is available in API version 65.0 when Life Sciences Cloud is enabled. ### RetryCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of times the batch job part is automatically rerun in case it fails. ### SecondarySrcObjProcessedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of output records from the second object in a junction when the source of the batch job is a junction object. This field is available in API version 65.0 when Life Sciences Cloud is enabled. ### StartTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the batch job part's run was started. ### Status - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: The status of the batch job part. - **Possible values**: - Canceled - Completed - Failed - InProgress ### Type - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of node in case the associated batch job is of the type Calc (Data Processing Engine). - **Possible values**: - Aggregate - Append - Compute - Custom - Datasync - Filter - Forecast - Hierarchy - Join - Slice - Source - Transform - Writeback ## 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. [BatchJobPartFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Change events are available for the object. [BatchJobPartHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") Feed tracking is available for the object. # Benefit Represents information about benefits associated with the financial assistance program. Benefits are mapped to the members based on the program rules. 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 ### BenefitTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the benefit type. This field is a relationship field. - **Relationship Name**: BenefitType - **Relationship Type**: Lookup - **Refers To**: BenefitType ### BudgetAmountUsed - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The budget amount used by an employee after enrolling in a corresponding program. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date of the benefit. ### EnrolleeAmountLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount limit allocated to enrollee for a corresponding program. ### EnrolleeLimitFrequency - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The assigned frequency for an enrollee limit for a corresponding program. - **Possible values**: - Monthly - Monthly, Yearly , Annual, Weekly, Quarterly - Yearly ### EnrolleeTrxnAmountLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The enrollee transaction amount limit for a corresponding program. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Required. Indicates whether the program benefit is active. ### MaxBenefitAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be disbursed for a period. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the benefit. ### PayoutFrequency - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Possible values**: - Annual - BiWeekly - Bi-Weekly - Monthly - OnDemand - On-Demand - Quaterly - Weekly ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the program that's associated with the benefit. This field is a relationship field. # Benefit Verification Use these resources to verify the health benefits covered by the patient's insurer. The call center agent can view the coverages in the patient's record page. - **[Benefits Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_verify_benefits.htm)** The Verify Benefits API call is the main resource for checking which health benefits are available to a patient. - **[Benefits Verification Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_input.htm)** This is the input structure of a Verify Benefits API call. - **[Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm)** This is what a Verify Benefits request looks like. - **[Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm)** This is the content of the output from running the Verify Benefits API call. - **[Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm)** This is the content of the response from a Verify Benefits API call. # Benefits Verification (POST) The Verify Benefits API call is the main resource for checking which health benefits are available to a patient. ## Resource /connect/health/benefitsverification/verifyBenefits ## Available Version 53.0 ## Requires Chatter No ## HTTP Methods POST ## Root XML tag inputData ## JSON example ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefitsVerificationRequests | [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.")\[\] | List of Benefits Verification Requests | | 53.0 | ## Response Body for POST [Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") #### See Also - [Benefits Verification Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_input.htm "This is the input structure of a Verify Benefits API call.") - [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.") - [Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") - [Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm "This is the content of the response from a Verify Benefits API call.") # Benefits Verification Input This is the input structure of a Verify Benefits API call. ## Root XML tag inputData ## JSON example ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | benefitsVerificationRequests | [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.")\[\] | List of Benefits Verification Requests | | 53.0 | #### See Also - [Benefits Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_verify_benefits.htm "The Verify Benefits API call is the main resource for checking which health benefits are available to a patient.") - [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.") - [Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") - [Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm "This is the content of the response from a Verify Benefits API call.") # Benefits Verification Output This is the content of the output from running the Verify Benefits API call. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | benefitsVerificationResponses | [Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm "This is the content of the response from a Verify Benefits API call.")\[\] | Benefits Verification Responses | Small, 53.0 | 53.0 | | code | String | Benefits Verification api returned code | Small, 53.0 | 53.0 | | isSuccess | Boolean | Benefits Verification api success flag | Small, 53.0 | 53.0 | | message | String | Benefits Verification api message | Small, 53.0 | 53.0 | #### See Also - [Benefits Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_verify_benefits.htm "The Verify Benefits API call is the main resource for checking which health benefits are available to a patient.") - [Benefits Verification Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_input.htm "This is the input structure of a Verify Benefits API call.") - [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.") - [Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm "This is the content of the response from a Verify Benefits API call.") # Benefits Verification Request This is what a Verify Benefits request looks like. ## JSON example ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | encounterDate | String | Encounter Date | | 53.0 | | memberAccountId | String | Member Account Id | | 53.0 | | memberPlanId | String | Member Plan Id | | 53.0 | | providerNpi | String | Provider Npi | | 53.0 | | providerOrganizationName | String | Provider Organization Name | | 53.0 | | providerType | String | Provider Type | | 53.0 | | serviceTypeCodes | String\[\] | Service Type Codes | | 53.0 | #### See Also - [Benefits Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_verify_benefits.htm "The Verify Benefits API call is the main resource for checking which health benefits are available to a patient.") - [Benefits Verification Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_input.htm "This is the input structure of a Verify Benefits API call.") - [Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") - [Benefits Verification Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_response.htm "This is the content of the response from a Verify Benefits API call.") # Benefits Verification Response This is the content of the response from a Verify Benefits API call. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | careBenefitVerifyRequestId | String | Care Benefit Verify Request Id | Small, 53.0 | 53.0 | | code | String | Benefits Verification api returned code | Small, 53.0 | 53.0 | | coverageBenefitId | String | Coverage Benefit Id | Small, 53.0 | 53.0 | | isSuccess | Boolean | Benefits Verification api success flag | Small, 53.0 | 53.0 | | message | String | Benefits Verification api message | Small, 53.0 | 53.0 | #### See Also - [Benefits Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_verify_benefits.htm "The Verify Benefits API call is the main resource for checking which health benefits are available to a patient.") - [Benefits Verification Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_input.htm "This is the input structure of a Verify Benefits API call.") - [Benefits Verification Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_benefits_verification_request.htm "This is what a Verify Benefits request looks like.") - [Benefits Verification Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") # BenefitType Represents information about the type of benefits, such as Financial Assistance Program, available to the care program enrollee. 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 ### Benefit Type Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the benefit type. ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The category of the benefit type. Picklist values aren't provided for this field and must be added based on the requirements of the organization. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of benefit type. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### ProcessType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Required. The process type associated with the benefit. The possible value is: - Financial Assistance Program This value is available in API version 61.0 and later. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The process type associated with the benefit. - **Possible values**: - Monetary - Service - Goods ### UnitofMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the benefit. This is a polymorphic relationship field. - **Relationship Type**: UnitofMeasure - **Refers To**: UnitofMeasure ## Associated Objects This object has these 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. [BenefitTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [BenefitTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # BoardCertification Represents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account that this healthcare provider is associated with. ### BoardName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the organization providing the board certification. ### CertificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of certification. ### CurrentCertificationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of most recent board certification. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this certification is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this certification is no longer effective. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Update - **Description**: Expiration date of the board certification. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the provider. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner that this certification is associated with. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the certification. ### TerminationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for this provider. ### TerminationReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for termination. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [BoardCertificationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [BoardCertificationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [BoardCertificationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [BoardCertificationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [BoardCertificationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Book Slot Chain (POST) Create service appointments for a care program enrollee in advanced therapy management based on the provided appointment slots. This API takes both the published and unpublished slots as inputs. If the provided slots are published, the API calls the Salesforce Scheduler API to book the slots. ## Resource /connect/health/advanced-therapy-management/book-slot-chain ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/advanced-therapy-management/book-slot-chain ## Available Version 60.0 ## HTTP Methods POST ## JSON example { "careProgramEnrolleeId":"08pxx0000004C92AAE", "workProcedureId":"08pxx0000004C92AAE", "slots":\[ { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" }, { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" }, { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | careProgramEnrolleeId | String | ID of the care program enrollee for whom the service appointments must be created. | Required | 60.0 | | slots | [Slots](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_slot_input.htm "Input representation of an appointment slot.") \[\] | Appointment slots to be booked. | Required | 60.0 | | workProcedureId | String | ID of the work procedure for which the service appointments are to be created. | Required | 60.0 | ## Response Body for POST [Book Slot Chain Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_book_slot_chain_output.htm "Output representation of the request to create service appointments.") # Book Slot Chain Input Input representation of the request to create service appointments. ## JSON example { "careProgramEnrolleeId":"08pxx0000004C92AAE", "workProcedureId":"08pxx0000004C92AAE", "slots":\[ { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" }, { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" }, { "schedStartTime":"2022-03-26T16:30:00.000+0000", "schedEndTime":"2022-03-26T16:30:00.000+0000", "workTypeId":"08pxx0000004C92AAE", "serviceTerritoryId":"08pxx0000004C92AAE", "serviceResourceId":"08pxx0000004C92AAE", "contactId":"08pxx0000004C92AAE", "appointmentType":"08pxx0000004C92AAE", "subject":"Apheresis", "additionalInformation":"Needs Cab Assistance", "street":"1 Market Street", "city":"San Francisco", "state":"CA", "postalCode":"94105", "country":"USA", "comments":"", "status":"Scheduled" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | careProgramEnrolleeId | String | ID of the care program enrollee for whom the service appointments must be created. | Required | 60.0 | | slots | [Slots](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_slot_input.htm "Input representation of an appointment slot.") \[\] | Appointment slots to be booked. | Required | 60.0 | | workProcedureId | String | ID of the work procedure for which the service appointments are to be created. | Required | 60.0 | # Book Slot Chain Output Output representation of the request to create service appointments. ## JSON example { "isSuccess":true, "serviceAppointmentIds":\[ "08pxx0000004C92AAE", "08pxx0000004C92AAE", "08pxx0000004C92AAE" \], "serviceAppointmentGroupId":"08pxx0000004C92AAE", "message":"", "code":200 } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | API response code. | Small, 60.0 | 60.0 | | isSuccess | Boolean | Indicates whether the request was successful (true) or not (false). | Small, 60.0 | 60.0 | | message | String | Error message when the request fails. | Small, 60.0 | 60.0 | | serviceAppointmentGroupId | String | ID of the service appointment group to which the created service appointments belong to. | Small, 60.0 | 60.0 | | serviceAppointmentIds | String\[\] | IDs of the created service appointments. | Big, 60.0 | 60.0 | # BudgetMngEventType Each row represents a junction that links a budget to permitted event types, ensuring funds are only allocated to events that align with the budget's purpose. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### BudgetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the budget associated with the managed event type. This field is a relationship field. - **Relationship Name**: Budget - **Refers To**: Budget ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### MngEventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of event for which budget applicability or allocation is defined. This field is a relationship field. - **Relationship Name**: MngEventType - **Refers To**: MngEventType ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Budget Managed Event Type. # BudgetProduct Represents a junction between a budget and the product that the budget is assigned to. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### BudgetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the budget that's associated with the budget product. This field is a relationship field. - **Relationship Name**: Budget - **Relationship Type**: Master-detail - **Refers To**: Budget (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the budget product. ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the product associated with the budget product. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: LifeSciMarketableProduct, Product2, ProductCategory ## 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. BudgetProductFeed Feed tracking is available for the object. BudgetProductHistory History is available for tracked fields of the object. # BudgetTerritory Represents a junction between a budget and the territory that the budget is assigned to. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### BudgetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the budget associated with the budget territory. This field is a relationship field. - **Relationship Name**: Budget - **Relationship Type**: Master-detail - **Refers To**: Budget (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the budget territory. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the territory associated with the budget territory. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. BudgetTerritoryFeed Feed tracking is available for the object. BudgetTerritoryHistory History is available for tracked fields of the object. # Build Identity Verification Context Input Input representation of the Build Identity Verification Context resource. ## Root XML tag ## JSON example { "objectName":"Account", "selectedRecordId":"001xx000003GZeFAAW" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | objectName | String | The API name of the caller’s object. | Optional | 54.0 | | selectedRecordId | String | The record ID of the caller. | Optional | 54.0 | # Build Product Territory Detailed Availability Action Build Product Territory Detailed Availability records using existing Product Territory Availability records. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/buildProdTerrDtlAvlAction Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
productTerritoryAvailabilityId String Required

ID of the Product Territory Availability record for the action to execute on.
## Outputs | Output | Type | Description | | --- | --- | --- | | resultText | String | Message indicating the result of the action. | | success | Boolean | Indicates if the action was successful (true) or not (false). | ## Example This sample request is for the Build Product Territory Detailed Availability action. { "inputs": \[ { "productTerritoryAvailabilityId": "1Kwxx0000004CxxCAE" } \] } This sample input is for calling the Build Product Territory Detailed Availability action from the Apex code. Invocable.Action action = Invocable.Action.createStandardAction('buildProdTerrDtlAvlAction'); action.setInvocationParameter('ProductTerritoryAvailabilityId', '1Kwxx0000004CxxCAE'); List results = action.invoke(); This sample response is for the Build Product Territory Detailed Availability action. \[ { "outputValues": { "success": true, "resultText": "Product Territory Detailed Availabilities built successfully." } } \] # Bulk Presentation (PATCH) Update a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associating metadata. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). ## Resource /connect/life-sciences/commercial/bulk-presentation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/bulk-presentation ## Available Version 65.0 ## HTTP Methods PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - File Input Payload Size: - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload. - ZIP Presentations: If the cumulative payload of pages in a ZIP presentation exceeds the 2 GB API limit, upload them as individual standalone pages using the PRESENTATION\_PAGE contentType. - Rate Limits: - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour. ## Request Body for PATCH { "contentType": "PRESENTATION\_ZIP", // Valid values: PRESENTATION\_PDF, PRESENTATION\_ZIP, or PRESENTATION\_PAGE. // Required for PDF or ZIP content types. Not required for PRESENTATION\_PAGE. "presentation": { "name": "demo-presentation-name", "id": "demo-presentation-id", "enableDoubleTapZoom": true, "enablePinchZoom": false, "playerGesture": "Swipeup", "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", // These fields are only valid for PRESENTATION\_ZIP. "topics": \[ "topic\_id\_1", "topic\_id\_2" \], "sendByEmail": false, "publicContentName": "public\_content\_name", "publicContentUrl": "public\_content\_url", "customFields": \[ { "fieldName": "Custom\_Text\_Field\_\_c", "fieldValue": "custom\_field\_value\_1\_string" } \] }, // Only one page can be provided for PRESENTATION\_PAGE. "pages": \[ { // Required only for PRESENTATION\_PDF. Must be 1 for the file page, and incremented for subsequent PDF pages. Not required for ZIP/PAGE. "pageNumber": 1, "name": "demo-presentation-page1", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", /\* File input (contentDocumentId or fileId) is ONLY required if you are UPDATING the content of the presentation. - For PDF: File input is ONLY provided on the page where pageNumber is 1. Omit fileId/contentDocumentId if only updating metadata. - For ZIP/PAGE: File input is required for ALL pages if their content is changing. \*/ "contentDocumentId": "069xx0000004gbkAAA", //"fileId": "file1-key", /\* Use contentDocumentId OR fileId, but not both. \*/ "id": "demo-page-id-1", // Required for ZIP/PAGE. Omit for PRESENTATION\_PDF. "isAdditionalContent": false, // Required for ZIP/PAGE. Omit for PRESENTATION\_PDF. "customFields": \[ { "fieldName": "custom\_field\_name\_1", "fieldValue": 45 } \], "products": \[ { "productId": "1Kexx0000004C92CAE", "guidanceIds": \[ "1Kgxx0000004C92CAE" \] } \] }, { /\* Second page example. \*/ //"pageNumber": 2, /\* Must be included for a second page if contentType is PRESENTATION\_PDF. \*/ "name": "demo-presentation-page2", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", // File input is required here for ZIP/PAGE if content is being updated. Not required for PDF. "contentDocumentId": "069xx0000004gbcAAB", "id": "demo-page-id-2", // Required for ZIP/PAGE. "isAdditionalContent": false, // Required for ZIP/PAGE. "customFields": \[ { "fieldName": "custom\_field\_name\_1", "fieldValue": "custom\_field\_value\_1" } \], "products": \[ { "productId": "1Kexx0000004C92CAE", "guidanceIds": \[ "1Kgxx0000004C92CAE" \] } \] } \] } **Properties**
Name Type Description Required
content​Type String The type of content. Possible values are:
  • PRESENTATION_PDF
  • PRESENTATION_ZIP
  • PRESENTATION_PAGE.
Required
present​ation Object JSON payload containing presentation metadata. To view all presentation object properties, see Bulk Presentation Update Input. Required only if the content​Type is PRESENTATION_PDFor PRESENTATION_ZIP
pages List<Object> List of presentation pages, each containing its own metadata and file association. Only one page can be provided in the pages input for PRESENTATION_PAGEcontent type.

To view all pages object properties, see Bulk Presentation Pages Update Input.

Optional
## Response Body for PATCH [Update Bulk Presentation Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_content_management_output.htm "Represents the information about the job status and any associated messages returned for Content Management APIs.") # Bulk Presentation (POST) Create a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associated metadata. The JSON payload includes metadata for both the presentation and each page within the presentation. This metadata can include details such as the presentation name, activation date, and page-level information. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). ## Resource /connect/life-sciences/commercial/bulk-presentation ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/bulk-presentation ## Available Version 65.0 ## HTTP Methods POST ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - File Input Payload Size: - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload. - ZIP Presentations: If the cumulative payload of pages in a ZIP presentation exceeds the 2 GB API limit, upload them as individual standalone pages using the PRESENTATION\_PAGE contentType. - Rate Limits: - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour. ## Request Body for POST (PDF Presentation) { "contentType": "PRESENTATION\_PDF", "presentation": { "name": "test-presentation-name", "id": "test-presentation-id", "enableDoubleTapZoom": true, "enablePinchZoom": false, "playerGesture": "Swipeup", "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z" }, "pages": \[ { "pageNumber": 1, "name": "pres-page-name-testfile13-3pages", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", "fileId": "01\_binary\_part\_file" } \] } ## Request Body for POST (ZIP Presentation) { "contentType": "PRESENTATION\_ZIP", "presentation": { "name": "pres-name-testfile1-zip", "id": "presentation-id", "enableDoubleTapZoom": true, "enablePinchZoom": false, "playerGesture": "Swipeup", "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", "customFields": \[ { "fieldName": "Custom\_Text\_Field\_\_c", "fieldValue": "custom\_field\_value\_1\_string" } \], "topics": \["topic\_id\_1", "topic\_id\_2"\], "sendByEmail": false, "publicContentName": "public\_content\_name", "publicContentUrl": "public\_content\_url" }, "pages": \[ { "name": "pres-page-name-testfile1-zip-page1", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", "fileId": "01\_binary\_part\_file", "id": "page\_id\_1", "isAdditionalContent": false, "customFields": \[ { "fieldName": "custom\_field\_name\_1", "fieldValue": "custom\_field\_value\_1\_string" }, { "fieldName": "custom\_field\_name\_2", "fieldValue": 45 }, { "fieldName": "custom\_field\_name\_3", "fieldValue": true } \], "products": \[ { "productId": "1Kexx0000004C92CAE", "guidanceIds": \["1Kgxx0000004C92CAE"\] } \] }, { "name": "isadditionalcontent\_pres-page-name-testfile1-zip-page2", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", "fileId": "02\_binary\_part\_file", "id": "page\_id\_2", "isAdditionalContent": true, "customFields": \[ { "fieldName": "custom\_field\_name\_1", "fieldValue": "custom\_field\_value\_1\_string" }, { "fieldName": "custom\_field\_name\_2", "fieldValue": 45 }, { "fieldName": "custom\_field\_name\_3", "fieldValue": true } \], "products": \[ { "productId": "1Kexx0000004C92CAE", "guidanceIds": \["1Kgxx0000004C92CAE"\] } \] } \] } ## Request Body for POST (Presentation Page) { "contentType": "PRESENTATION\_PAGE", "pages": \[ { "name": "pres-page-name-testfile1-zip-page1", "mandatory": false, "activationDate": "2019-06-03T15:00:00.000Z", "deactivationDate": "2019-06-03T15:00:00.000Z", "fileId": "01\_binary\_part\_file", "id": "page\_id\_1", "isAdditionalContent": false, "customFields": \[ { "fieldName": "custom\_field\_name\_1", "fieldValue": "custom\_field\_value\_1\_string" }, { "fieldName": "custom\_field\_name\_2", "fieldValue": 45 }, { "fieldName": "custom\_field\_name\_3", "fieldValue": true } \], "products": \[ { "productId": "1Kexx0000004C92CAE", "guidanceIds": \["1Kgxx0000004C92CAE"\] } \] } \] } ## Properties
Name Type Description Required
content​Type String The type of content. Valid values are PRESENTATION_PDF, PRESENTATION_ZIP, or PRESENTATION_PAGE.

Note: When uploading a ZIP presentation, each page must reference its associated file in the JSON payload. Provide the reference using either contentDocumentId (ID of an existing Salesforce file) or fileId (multipart form-data key that points to the file being uploaded in the REST request).

Required
present​ation Object JSON payload containing presentation metadata. To view all presentation object properties, see Bulk Presentation Input. Required only if the content​Type is PRESENTATION_PDFor PRESENTATION_ZIP
pages List<Object> List of presentation pages, each containing its own metadata and file association. Only one page can be provided in the pages input for PRESENTATION_PAGEcontent type.

To view all pages object properties, see Bulk Presentation Pages Input.

 Required
## Response Body for POST [Create Bulk Presentation Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_content_management_output.htm "Represents the information about the job status and any associated messages returned for Content Management APIs.") # Bulk Presentation Input Input representation for bulk presentation. ## Properties
Property Name Type Description Required Available version
activation​Date Datetime Date when the presentation becomes active. If no value is provided, the default is the current date and time. Optional 65.0
custom​Fields Object Map of custom field names and their values for the presentation. Optional 65.0
deactivation​Date Datetime Date when the presentation becomes inactive. Optional 65.0
enable​Double​TapZoom Boolean Indicates if double-tap zoom is enabled for the presentation (true) or not (false). The default value is false. Optional 65.0
enable​Pinch​Zoom Boolean Indicates if pinch zoom is enabled for the presentation (true) or not (false). Optional 65.0
id String ID of the presentation. Optional 65.0
name String Name of the presentation. Required 65.0
player​Gesture String Player gesture type. Possible values are:
  • TAPTOP
  • TAPBOTTOM
  • SWIPEUP
  • SWIPEDOWN.
Optional 65.0
public​Content​Name String Public name for the content. Optional 65.0
public​Content​Url String URL for the public content. Optional 65.0
sendBy​Email Boolean Indicates if the presentation can be sent by email (true) or not (false). Optional 65.0
topics List<String> List of topics associated with the presentation. TopicAssignment must be enabled for Presentation before using this field. Optional 65.0
# Bulk Presentation Pages Input Input representation for a presentation page. ## Properties | Property Name | Type | Description | Required | Available version | | --- | --- | --- | --- | --- | | activation​Date | Datetime | Date and time when the page becomes active. | Optional | 65.0 | | content​DocumentId | String | ID of a file that already exists in Salesforce. This ID is generated when the file is uploaded to the Salesforce platform. You cannot provide this paramter when you pass the fileIdas only one of the two parameters are allowed. For the PRESENTATION\_PDF content type, provide the file input (contentDocumentId or fileId) within the metadata only for the first page (pageNumber 1) in the pages list. | Required when content​Type is PRESENTATION\_ZIP, PRESENTATION\_PAGE, PRESENTATION\_PDF. | 65.0 | | custom​Fields | Object | Map of custom field names and their values for the page. | Optional | 65.0 | | deactivation​Date | Datetime | Date and time when the page becomes inactive. | Optional | 65.0 | | fileId | String | The key used in the multipart form data of the REST API request. The value corresponds to the file path on the user’s machine that will be uploaded to Salesforce during the request. You can pass this parameter if you wish to process a new file that you will include in the request. You cannot provide this parameter when you pass the content​DocumentId as only one of the two are allowed. For the PRESENTATION\_PDF content type, provide the file input (contentDocumentId or fileId) within the metadata only for the first page (pageNumber 1) in the pages list. | Required when content​Type is PRESENTATION\_ZIP. | 65.0 | | id | String | ID of the presentation page. This is either the source system ID or the Salesforce ID. | Required | 65.0 | | isAdditional​Content | Boolean | Indicates whether the page contains additional content (true) or not (false). The default value is false. | Optional | 65.0 | | mandatory | Boolean | Indicates if the page is mandatory for the presentation (true) or not (false). The default value is false. | Optional | 65.0 | | name | String | Name of the presentation page. | Required only if the content​Type is PRESENTATION\_PAGEor PRESENTATION\_ZIP | 65.0 | | page​Number | Integer | Page number for the presentation page. This value must be unique and within the range of 1 to 200. | Required only when contentType is PRESENTATION\_PDF. This field is not required when the contentType is PRESENTATION\_ZIPor PRESENTATION\_PAGE. | 65.0 | | products | List<[Products Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_page_products_array_input.htm "Input representation that contains the product and guidance IDs associated with a presentation page.")\> | List of products and their associated guidance IDs for the page. | Optional | 65.0 | # Bulk Presentation Pages Update Input Input representation for a presentation page update. ## Properties | Property Name | Type | Description | Required | Available version | | --- | --- | --- | --- | --- | | activation​Date | Datetime | Date and time when the page becomes active. | Optional | 65.0 | | content​DocumentId | String | ID of the content document for the page. You cannot provide this paramter when you pass the fileIdas only one of the two parameters are allowed as only one of the two are allowed. For bulk presentation PATCH request, this parameter is not mandatory when the contentType is PRESENTATION\_PDF. | Required when content​Type is PRESENTATION\_ZIP. | 65.0 | | custom​Fields | Object | Map of custom field names and their values for the page. | Optional | 65.0 | | deactivation​Date | Datetime | Date and time when the page becomes inactive. | Optional | 65.0 | | fileId | String | File ID for the page content. Pass this parameter if you want to process a new file that you will include in the request. You cannot provide this parameter when you pass the content​DocumentId as only one of the two are allowed. For bulk presentation PATCH request, this parameter is not mandatory when the contentType is PRESENTATION\_PDF. | Required when content​Type is PRESENTATION\_ZIP . | 65.0 | | id | String | ID of the presentation page. This is either the source system ID or the Salesforce ID. | Optional | 65.0 | | isAdditional​Content | Boolean | Indicates whether the page contains additional content (true) or not (false. The default value is false. | Optional | 65.0 | | mandatory | Boolean | Indicates if the page is mandatory for the presentation (true) or not (false. The default value is false | Optional | 65.0 | | name | String | Name of the presentation page. | Optional | 65.0 | | page​Number | Integer | Page number for the presentation page. This value must be unique and within the range of 1 to 200. | Required when contentType is PRESENTATION\_PDF. | 65.0 | | products | List<[Products Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_page_products_array_input.htm "Input representation that contains the product and guidance IDs associated with a presentation page.")\> | List of products and their associated guidance IDs for the page. | Optional | 65.0 | # Bulk Presentation Update Input Input representation for bulk presentation update. ## Properties
Property Name Type Description Required Available version
activation​Date Datetime Date when the presentation becomes active. Optional 65.0
custom​Fields Object Map of custom field names and their values for the presentation. Optional 65.0
deactivation​Date Datetime Date when the presentation becomes inactive. Optional 65.0
enable​Double​TapZoom Boolean Indicates if double-tap zoom is enabled for the presentation (true) or not (false). Optional 65.0
enable​Pinch​Zoom Boolean Indicates if pinch zoom is enabled for the presentation (true) or not (false). Optional 65.0
id String ID of the presentation. Required 65.0
name String Name of the presentation. Optional 65.0
player​Gesture String Player gesture type. Possible values are:
  • TAPTOP
  • TAPBOTTOM
  • SWIPEUP
  • SWIPEDOWN.
Optional 65.0
public​Content​Name String Public name for the content. Optional 65.0
public​Content​Url String URL for the public content. Optional 65.0
sendBy​Email Boolean Indicates if the presentation can be sent by email (true) or not (false). Optional 65.0
topics List<String> List of topics associated with the presentation. Optional 65.0
# BusinessLicense Represents the licenses of a party role like healthcare provider or producer. ## Special Access Rules In Life Science Cloud, this object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the organization holding the license. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ComplianceScope - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The scope of compliance for the business license. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - Address - Jurisdiction - StateDistributorLicense ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the person who holds the license and is listed as a contact. This field is a relationship field. - **Relationship Name**: Contact - **Refers To**: Contact ### ContactPointAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the person who holds the license and is listed as a contact. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Relationship Name**: ContactPointAddress - **Refers To**: ContactPointAddress ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the license. ### HealthCareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID associated with the healthcare facility. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Relationship Name**: HealthCareFacility - **Refers To**: HealthcareFacility ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the Healthcare Provider who holds this license. This field is a relationship field. This field is a lookup to HealthcareProvider. - **Relationship Name**: HealthcareProvider - **Refers To**: HealthcareProvider ### Identifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Issuer's ID for the licensee. This field is unique within your organization. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the license is active (true) or not (false). - **Default value**: false ### IsLicenseValidated - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the business license is valid (true) or not (false). This field is a calculated field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### IsPrimaryLicense - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the license is the primary license. - **Default value**: false ### IssueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the license or certification was issued. ### Issuer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: License issuer's name. ### JurisdictionCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Country where license is valid. ### JurisdictionOther - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of other jurisdiction. ### JurisdictionState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: State where license is valid. ### JurisdictionType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Jurisdiction for the license. - **Default value**: STATE - **Possible values**: - COUNTRY - COUNTY - PROVINCE - STATE ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### LicenseClass - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The class that the distributor’s license belongs to. - **Possible values**: - APN - Advanced Practice Nurse - LPN - Licensed Practical Nurse - MD - Medical Doctor (MD) - PC - Professional Counselor - PT - Physical Therapist ### LicenseNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of the license. ### LineOfAuthority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The line of authority that the distributor is licensed for. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - Accident & Health or Sickness - Casualty - Property ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the business or professional license. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PeriodEnd - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: License's expiration date. ### PeriodStart - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: License's effective start date. ### ResidenceStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Residence status of the producer. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - Non-resident - Resident ### SourceSystemUpdateDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the date when the record was last updated in the source system. ### StateDstrLicenseCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The State Distributor License category for the business license. - **Possible values**: - CategoryII—Category II - CategoryIII—Category III - LimitedCategoryII—Limited Category II - LimitedCategoryIII—Limited Category III This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Current status of the license. - **Default value**: Inactive - **Possible values**: - Draft - Inactive - Revoked - Verified ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who holds the license and is listed as a user. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User ### VerificationStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Current status for the license. - **Default value**: Authorized - **Possible values**: - Authorized ### VerifiedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: License was validated on this date. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [BusinessLicenseFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [BusinessLicenseHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [BusinessLicenseOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [BusinessLicenseShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # BusinessLicenseProduct Represents the licenses required to be linked to a product for the healthcare provider. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BusinessLicenseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID associated with the parent business license record. This field is a relationship field. - **Relationship Name**: BusinessLicense - **Relationship Type**: Master-detail - **Refers To**: BusinessLicense (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the business license product. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product ID associated with the business license. This field is a polymorphic relationship field. - **Relationship Name**: Product2 - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [BusinessLicenseProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [BusinessLicenseProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [BusinessLicenseProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Care Authorization Request Output of create or update request for care services review. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | careDiagnoses | [Care Diagnoses](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_diagnosis_output.htm "Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.")\[\] | A list of associated diagnoses including code type, name, and description. One or more care diagnoses can be associated with a care request. | Big, 46.0 | 46.0 | | careRequest | [Care Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_output.htm "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 prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances.") | 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 prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances. | Big, 46.0 | 46.0 | | careRequestCase | [Care Request Case](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_case_output.htm "Case related to the care request.") | Case related to the care request. | Big, 46.0 | 46.0 | | careRequestDrugs | [Care Request Drug](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_drug_output.htm "Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request.")\[\] | A list of requested drugs including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. | Big, 46.0 | 46.0 | | careRequestItems | [Care Request Item](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_item_output.htm "The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request.")\[\] | A list of care request items containing name, modifiers, and the effective date. One or more care service requests can be associated with a care request. | Big, 46.0 | 46.0 | | patient | [Patient](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_patient_output.htm "The patient for whom the request is being raised.") | The patient for whom the request is raised. | Big, 46.0 | 46.0 | | subscriber | [Subscriber](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_subscriber_output.htm "The primary member on the plan.") | The primary member on the plan. | Big, 46.0 | 46.0 | | tracked​Communications | [Tracked Communication​ Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_tracked_communication_output.htm "Output representation of tracked communications for a care request.")\[\] | A list of tracked communications for a care request. | Big, 57.0 | 57.0 | | transportLocations | [Transport Locations](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_transport_location_output.htm "Transport Location output representation")\[\] | Transport location output. | Big, 46.0 | 46.0 | # Care Authorization Request Input A complete care authorization request. ## Root XML tag ## JSON example { "careRequestCase": { "caseOrigin": "Web", "subject": "Case No 10" }, "contentDocumentLinks": \[ { "id": "069xx0000004CNZAA2" }, { "id": "069xx0000004CNYAA2" } \], "assessmentLinks": \[ { "id": "0U3SG00000068Cb0AI" } \], "patient": { "lastName": "Fedex", "firstName": "Roger" }, "careRequestItems": \[ { "name": "95810", "codeType": "CPT", "sourceSystem": "source\_system\_name", "codeDescription": "Dysuria", "sourceSystemIdentifier": "0015cmi", "quantity": "15" } \], "careRequestDrugs": \[ { "sourceSystem": "source\_system\_name", "daysSupply": "10", "frequency": "16", "name": "Metoprolol" } \], "careRequest": { "requestingPractitionerSpecialty": "Neurologist", "placeOfService": "InPatient", "sourceSystemIdentifier": "0015", "name": "Care Request 15", "requestingPractitionerLicense": "M.D", "sourceSystem": "source\_system\_name", "servicingPractitionerLicense": "M.D", "servicingPractitionerSpecialty": "Hospitalist", "recordType": "Complaint" }, "careDiagnoses": \[ { "sourceSystem": "ajSource", "name": "G47.30", "codeDescription": "Sleep apnea, unspecified", "codeType": "ICD-10-CM" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | assessmentLinks | [Assessment Links Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_links_input.htm "HTML (New Window)")\[\] | The details of the associated assessments used as the supporting content. | Optional | 55.0 | | careDiagnoses | [Care Diagnosis Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_diagnosis_input.htm "Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request.")\[\] | List of associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request. | Optional | 46.0 | | careRequest | [Care Request Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_input.htm "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 or drugs. Care requests include prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances.")\[\] | 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 prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances. | Optional | 46.0 | | careRequestDrugs | [Care Request Drug Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_drug_input.htm "Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request.")\[\] | List of requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. | Optional | 46.0 | | careRequestItems | [Care Request Item Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_item_input.htm "The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request.")\[\] | The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request. | Optional | 46.0 | | contentDocumentLinks | [Documents Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_content_document_input.htm "Input representation for documents linked to the care request record.")\[\] | List of clinical documents to be attached as content document links to the prior authorization request. | Optional | 55.0 | | careRequestCase | [Care Request Case Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_authorization_case_input.htm "Case related to the care request.")\[\] | Case related to the care request. | Optional | 46.0 | | patient | [Care Request Patient Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_authorization_patient_input.htm "The patient for whom the request is being raised.")\[\] | The patient for whom the request is being raised. | Optional | 46.0 | | subscriber | [Care Request Subscriber Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_subscriber_input.htm "The primary member on the plan.")\[\] | The primary member on the plan. | Optional | 46.0 | | transportLocations | [Transport Location Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_transport_location_input.htm "Input representation for Transport Location")\[\] | List of Transport Locations. | Optional | 46.0 | # Care Authorization Request Related Record Care Authorization request related record output representation | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isSuccess | Boolean | Indicates if the operation was a success. | Small, 46.0 | 46.0 | | created | Boolean | Indicate if the record was created. | Big, 46.0 | 46.0 | | id | String | Id for the newly created record. | Big, 46.0 | 46.0 | | objectType | String | The type of the object created. | Big, 46.0 | 46.0 | | status | String | Indicates the status of the record creation. | Big, 46.0 | 46.0 | # Care Authorization Request Response The response body for the Care Services Review GET request. ## JSON example { "careAuthorizationRequests": \[ { "careDiagnoses": \[ { "careRequestReviewers": \[\], "healthConditionId": "0j4RM0000004Mk9YAE", "id": "0VCRM0000004COJ4A2", "modifiedPrimaryDiagnosis": false, "name": "CD Connect 1.0", "presentOnAdmission": "Yes", "primary": false, "primaryDischargeDiagnosis": false } \], "careRequest": { "appointedRepresentative": {}, "authorizationRefIdentifier": "1234", "careRequestReviewers": \[\], "caseSubStatus": "active", "extendedRequest": false, "firstReviewer": {}, "generalPractitioner": { "generalPractitionerNpi": "1234" }, "id": "0UmRM0000004HOG0A2", "initialDenialNotificationTime": "", "isIndependentReviewRequired": false, "isReadmission": false, "lastModifiedDate": "2022-11-29T15:39:56.000Z", "medicalDirector": {}, "member": "001RM000005XHdbYAG", "memberPrimaryPlan": "Gold Plan", "originalDenialMedicalDirector": {}, "reconsiderationDenialNotificationTime": "", "recordType": "Admission", "reopenedBy": {}, "requestingPractitioner": { "healthCareProviderId": "0cmRM0000000tldYAA", "requestingPractitionerNpi": "742963" }, "serviceorMedicationReceived": false, "servicingFacility": { "servicingFacilityId": "0klRM0000004CBnYAM", "servicingFacilityNpi": "742963" }, "servicingPractitioner": { "servicingPractitionerNpi": "1234" } }, "careRequestCase": { "caseNumber": "00001078", "caseOrigin": "Web", "caseOwner": "Chiranjeevi User", "closed": false, "createdBy": "005RM000002dmjJYAQ", "dateOpened": "2022-11-29T15:39:56.000Z", "escalated": false, "lastModifiedBy": "005RM000002dmjJYAQ", "lastModifiedDate": "2022-11-29T15:39:56.000Z", "lastReferencedDate": "2022-11-29T15:39:56.000Z", "lastViewedDate": "2022-11-29T15:39:56.000Z", "priority": "Medium", "status": "New" }, "careRequestDrugs": \[ { "authApprovalIdentifier": "123", "authorizationRefIdentifier": "123", "careRequestReviewers": \[\], "dispenserAddress": {}, "drugAdministrationSetting": "Inpatient", "id": "0VDRM0000004Cla4AE", "medicationRefObjectId": "0kmRM0000004CSeYAM", "name": "CRD Connect 1.0", "priority": "Routine", "requestType": "Filler Order", "servicingFacility": { "servicingFacilityId": "0klRM0000004CBnYAM", "servicingFacilityNpi": "742963" }, "servicingProvider": { "healthCareProviderId": "0cmRM0000000tldYAA", "servicingPractitionerNpi": "1234" }, "status": "Active", "statusReason": "Insufficient Information" } \], "careRequestItems": \[ { "authApprovalIdentifier": "123", "authorizationRefIdentifier": "123", "careRequestReviewers": \[\], "clinicalServiceRequestId": "0jyRM0000004CAGYA2", "id": "0VKRM0000004CPd4AM", "name": "CRI Connect-1.0", "priority": "Stat", "reasonCode": "0hsRM00000003ytYAA", "requestType": "Order", "servicingFacility": { "servicingFacilityId": "0klRM0000004CBnYAM", "servicingFacilityNpi": "742963" }, "servicingProvider": { "healthCareProviderId": "0cmRM0000000tldYAA", "servicingPractitionerNpi": "1234" } } \], "patient": { "firstName": "Charles", "lastName": "Green", "memberId": "001RM000005XHdbYAG" }, "subscriber": {}, "trackedCommunications": \[ { "categories": \[ "0hsRM00000003ytYAA" \], "mediums": \[ "0hsRM00000003ytYAA" \], "name": "CX Label Test", "notes": \[ "0nNRM00000000272AA" \], "payloads": \[ { "authorNoteId": "0nNRM00000000272AA", "codeSetBundleId": "0hsRM00000003ytYAA" } \], "priority": "Urgent", "reasonCodes": \[ "0hsRM00000003ytYAA" \], "recipients": \[ "001RM000005ZZgSYAW" \], "replacedItems": \[ "108RM0000004C9IYAU" \], "status": "Active", "statusReason": "Unknown", "type": "COMMUNICATIONREQUEST" } \], "transportLocations": \[\] } \], "errorMessage": "", "isSuccess": true } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | careAuthorizationRequests | [Care Authorization Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_request_output.htm "Output of create or update request for care services review.")\[\] | A list of care authorization requests. | Small, 46.0 | 46.0 | | errorMessage | String | If the parameters were invalid, this property contains the error message. | Small, 46.0 | 46.0 | | isSuccess | Boolean | This flag indicates if the request was successful or not. | Small, 46.0 | 46.0 | ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When you call the CareAuthorization GET API with the sectionNames attribute set, empty sections may appear in the response body. This is normal and can be ignored. # Care Authorization Request Result Result of POST or PATCH request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | relatedRecords | [Care Authorization Request Related Record](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_request_related_record_resul.htm "Care Authorization request related record output representation")\[\] | List of related records | Big, 46.0 | 46.0 | # Care Diagnosis Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | careRequest​Reviewers | [Care Request ​Reviewer Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_reviewer_output.htm "Output representation of the care request reviewer.")\[\] | The care diagnosis associated with the care request reviewer. Maps to: CareDiagnosis.CareRequestReviewers | Big, 52.0 | 52.0 | | code | String | Name of the diagnosis code. Maps to: CareDiagnosis.Name | Big, 46.0 | 46.0 | | codeDescription | String | Diagnosis code description. Maps to: CareDiagnosis.CodeDescription | Big, 46.0 | 46.0 | | codeType | String | Code type for the diagnosis. Maps to: CareDiagnosis.CodeType | Big, 46.0 | 46.0 | | codeTypeID | String | ID of the code type for the diagnosis. Maps to: CareDiagnosis.CodeTypeIdentifier | Big, 46.0 | 46.0 | | diagnosisCodeSet | String | The diagnosis code set. Maps to:CareDiagnosis.DiagnosisCodeSet | Big, 52.0 | 52.0 | | dischargeCode | String | Discharge diagnosis code. Maps to: CareDiagnosis.DischargeCode | Big, 46.0 | 46.0 | | dischargeCode​Description | String | Description of the discharge diagnosis code. Maps to: CareDiagnosis.DischargeCodeDescription | Big, 46.0 | 46.0 | | dischargeCode​Type | String | Code type for the discharge diagnosis. Maps to: CareDiagnosis.DischargeCodeType | Big, 46.0 | 46.0 | | dischargeCodeTypeId | String | ID of the code type for the discharge diagnosis. Maps to: CareDiagnosis.DischargeCodeTypeIdentifier | Big, 46.0 | 46.0 | | dischargeDiagnos​isEffectiveDate | String | Effective date for the discharge diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisEffectiveDate | Big, 46.0 | 46.0 | | dischargeDiagnosis​CodeSet | String | The discharge diagnosis code set associated with the care diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisCodeSet | Big, 52.0 | 52.0 | | dischargeDiagnos​isEndDate | String | Termination date for the discharge diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisEndDate | Big, 46.0 | 46.0 | | effectiveDate | String | Effective date for the diagnosis. Maps to: CareDiagnosis.EffectiveDate | Big, 46.0 | 46.0 | | endDate | String | Termination date for the diagnosis. Maps to: CareDiagnosis.EndDate | Big, 46.0 | 46.0 | | healthcare​DiagnosisCode | String | Healthcare Diagnosis Code. | Big, 46.0 | 46.0 | | healthCondition​Id | String | The health condition that's associated with the member. Maps to: CareDiagnosis.HealthCondition | Big, 57.0 | 57.0 | | id | String | ID of the Care Diagnosis. | Big, 46.0 | 46.0 | | modifiedCode | String | Modified diagnosis code. Maps to: CareDiagnosis.ModifiedCode | Big, 46.0 | 46.0 | | modifiedCode​Description | String | Modified diagnosis code description. Maps to: CareDiagnosis.ModifiedCodeDescription | Big, 46.0 | 46.0 | | modifiedCodeType | String | Code type for the modified diagnosis. Maps to: CareDiagnosis.ModifiedCodeType | Big, 46.0 | 46.0 | | modifiedCodeTypeId | String | ID of the code type for the modified diagnosis. Maps to: CareDiagnosis.ModifiedCodeTypeIdentifier | Big, 46.0 | 46.0 | | modifiedDiagnosis​CodeSet | String | The modified diagnosis code set associated with the care diagnosis. Maps to: CareDiagnosis.ModifiedDiagnosisCodeSet | Big, 52.0 | 52.0 | | modifiedEffective​Date | String | Modified effective date for the diagnosis. Maps to: CareDiagnosis.ModifiedEffectiveDate | Big, 46.0 | 46.0 | | modifiedEndDate | String | Modified termination date for the diagnosis. Maps to: CareDiagnosis.ModifiedEndDate | Big, 46.0 | 46.0 | | modifiedPrimary​Diagnosis | Boolean | Modified Primary Diagnosis | Big, 46.0 | 46.0 | | name | String | Name of the diagnosis code. Maps to: CareDiagnosis.Name | Big, 46.0 | 46.0 | | presentOn​Admission | String | Specifies if the health condition was present at the time of member admission. Maps to: CareDiagnosis.PresentOnAdmission | Big, 57.0 | 57.0 | | primary | Boolean | Indicates whether it is a primary diagnosis (true) or not (false). | Big, 46.0 | 46.0 | | primaryDischarge​Diagnosis | Boolean | Indicates whether it is a primary Discharge Diagnosis (true) or not (false). | Big, 46.0 | 46.0 | | sourceSystem | String | System from which this request was sourced. Maps to: CareDiagnosis.SourceSystem | Big, 46.0 | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareDiagnosis.SourceSystemIdentifier | Big, 46.0 | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareDiagnosis.SourceSystemModified | Big, 46.0 | 46.0 | # Care Diagnosis Input Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request. ## Root XML tag ## JSON example { "sourceSystem": "source\_system\_name", "name": "G47.30", "codeDescription": "Sleep apnea, unspecified", "codeType": "ICD-10-CM" } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | careRequest​Reviewers | [Care Request Reviewer Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_reviewer_input.htm "The general details of the care request, care request item, care request drug, or care diagnosis associated with the care request reviewer.") | The care diagnosis associated with the care request reviewer. Maps to: CareDiagnosis.CareRequestReviewers | No | 52.0 | | codeDescription | String | Diagnosis code description. Maps to: CareDiagnosis.CodeDescription | No | 46.0 | | codeType | String | Code type for the diagnosis. Maps to: CareDiagnosis.CodeType | No | 46.0 | | codeTypeID | String | ID of the code type for the diagnosis. Maps to: CareDiagnosis.CodeTypeIdentifier | No | 46.0 | | diagnosisCodeSet | String | The diagnosis code set. Maps to: CareDiagnosis.DiagnosisCodeSet | No | 52.0 | | dischargeCode | String | Discharge diagnosis code. Maps to: CareDiagnosis.DischargeCode | No | 46.0 | | dischargeCode​Description | String | Description of the discharge diagnosis code. Maps to: CareDiagnosis.DischargeCodeDescription | No | 46.0 | | dischargeCode​Type | String | Code type for the discharge diagnosis. Maps to: CareDiagnosis.DischargeCodeType | No | 46.0 | | dischargeCode​TypeId | String | ID of the code type for the discharge diagnosis. Maps to: CareDiagnosis.DischargeCodeTypeIdentifier | No | 46.0 | | dischargeDiagnosis​CodeSet | String | The discharge diagnosis code set associated with the care diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisCodeSet | No | 52.0 | | dischargeDiagnosis​EffectiveDate | String | Effective date for the discharge diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisEffectiveDate | No | 46.0 | | discharge​DiagnosisEndDate | String | Termination date for the discharge diagnosis. Maps to: CareDiagnosis.DischargeDiagnosisEndDate | No | 46.0 | | effectiveDate | String | Effective date for the diagnosis. Maps to: CareDiagnosis.EffectiveDate | No | 46.0 | | endDate | String | Termination date for the diagnosis. Maps to: CareDiagnosis.EndDate | No | 46.0 | | healthcare​DiagnosisCode | String | Healthcare Diagnosis Code. | No | 46.0 | | healthConditionId | String | The health condition that's associated with the member. Maps to: CareDiagnosis.HealthCondition | No | 57.0 | | id | String | ID of the Care Diagnosis. | Required for PATCH | 46.0 | | modifiedCode | String | Modified diagnosis code. Maps to: CareDiagnosis.ModifiedCode | No | 46.0 | | modifiedCode​Description | String | Modified diagnosis code description. Maps to: CareDiagnosis.ModifiedCodeDescription | No | 46.0 | | modifiedCode​Type | String | Code type for the modified diagnosis. Maps to: CareDiagnosis.ModifiedCodeType | No | 46.0 | | modifiedCode​TypeId | String | ID of the code type for the modified diagnosis. Maps to: CareDiagnosis.ModifiedCodeTypeIdentifier | No | 46.0 | | modifiedDiagnosis​CodeSet | String | The modified diagnosis code set associated with the care diagnosis. Maps to: CareDiagnosis.ModifiedDiagnosisCodeSet | No | 52.0 | | modifiedEffective​Date | String | Modified effective date for the diagnosis. Maps to: CareDiagnosis.ModifiedEffectiveDate | No | 46.0 | | modifiedEnd​Date | String | Modified termination date for the diagnosis. Maps to: CareDiagnosis.ModifiedEndDate | No | 46.0 | | modifiedPrimary​Diagnosis | Boolean | Modified Primary Diagnosis | No | 46.0 | | name | String | Name of the diagnosis code. Maps to: CareDiagnosis.Name | Yes | 46.0 | | presentOn​Admission | String | Specifies if the health condition was present at the time of member admission. Maps to: CareDiagnosis.PresentOnAdmission | No | 57.0 | | primary | Boolean | Indicates whether it is a primary diagnosis (true) or not (false). | No | 46.0 | | primaryDischarge​Diagnosis | Boolean | Indicates whether it is a primary Discharge Diagnosis (true) or not (false). | No | 46.0 | | sourceSystem | String | System from which this request was sourced. Maps to: CareDiagnosis.SourceSystem | No | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareDiagnosis.SourceSystemIdentifier | No | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareDiagnosis.SourceSystemModified | No | 46.0 | # Care Program Enrollment Result Result containing details about a single patient enrollment. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | enrolleeProducts | [Enrollee Product Result](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_enrollee_product_result.htm "Details about the enrollee’s products.")\[\] | A list containing results of care program enrollee products creation for each enrollee. | Small, 46.0 | 46.0 | | enrollmentCard | [Enrollment Card Result](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_enrollment_card_result.htm "Details of the enrollment care for a single enrollee.") | Results of care program enrollment card creation for the enrollee. | Small, 46.0 | 46.0 | | error | [Error Message](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_error_output.htm "A generic error message containing error code and the message text.") | Error code and message. | Small, 46.0 | 46.0 | | isSuccess | Boolean | Indicates if the operation was a success. | Small, 46.0 | 46.0 | | created | Boolean | Indicate if the record was created. | Big, 46.0 | 46.0 | | id | String | Id for the newly created CareProgramEnrollee record. | Big, 46.0 | 46.0 | | objectType | String | The type of the object created. In this case, it is CareProgramEnrollee. | Big, 46.0 | 46.0 | | status | String | Indicates the status of the record creation. | Big, 46.0 | 46.0 | # Care Program Enrollments (POST) Use this API to enroll multiple patients in a care program. A single API call creates both patient enrollment cards, and enrollee products for all the patients. You can enroll up to 200 patients in a single request. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Ensure that you have configured required care system field-mapping records for provider, patient, care program, and the product in **Setup** | **Care System Field Mappings**. For more information, see [CareSystemFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_caresystemfieldmapping.htm "Represents a mapping from source system fields to Salesforce target entities and attributes."). - **[Enrollments](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_resource_enroll-pantients.htm)** Enroll multiple patients into a care program. # Care Program Management Drive increased adherence and improve patient outcomes using the care program management data model. Now you can enroll and manage patients to achieve the maximum impact of your programs. The program management data model represents the entire picture of a program—from products and providers to enrollment eligibility of the enrollee. Available in API version 46.0 and later. ![Care Program entity-relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/images/V3_Care_Program_ERD.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/care-program-management.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Care Request 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 prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances.
Property Name Type Description Filter Group and Version Available Version
acknowledgement​LetterSentDate String Date and time when an acknowledgment letter was sent to the requester. Maps to: CareRequest.AcknowledgementLetterSentDate Big, 46.0 46.0
actualAdmission​Date String Actual admission date for the patient. Maps to: CareRequest.ActualAdmissionDate Big, 46.0 46.0
actualDischarge​Date String Actual discharge date for the patient. Maps to: CareRequest.ActualDischargeDate Big, 46.0 46.0
admissionNotes String Notes related to the admission. Maps to: CareRequest.AdmissionNotes Big, 46.0 46.0
admissionSource String Where the patient was admitted from, for example, a clinic or an emergency room. Maps to: CareRequest.AdmissionSource Big, 46.0 46.0
admissionType String Type of admission, for example, emergency or elective. Maps to: CareRequest.AdmissionType Big, 46.0 46.0
ambulanceTransport​Distance Integer Ambulance Transport Distance Big, 46.0 46.0
ambulanceTransport​Reason String Reason for ambulance transport. Maps to: CareRequestExtention.AmbulanceTransportReason Big, 46.0 46.0
ambulanceTransport​Type String Type of ambulance transport. Maps to: CareRequestExtention.AmbulanceTransportType Big, 46.0 46.0
aorReceived​Date String Date and time when the Appointment of Representative (AOR) form was received. Maps to: CareRequest.AorReceivedDate Big, 46.0 46.0
aorRequested​Date String Date and time when the AOR form was requested. Maps to: CareRequest.AorRequestedDate Big, 46.0 46.0
appealEffectuation​DateTime String The effective date of the outcome of the appeal request. For example, if a claim was successfully appealed, this field displays the date when the claim was paid. Maps to: CareRequestExtension.AppealEffectuationDateTime Big, 52.0 52.0
appealRequest​ReasonType String Specifies the reason for raising the appeal request. Maps to: CareRequest.AppealRequestReasonType Big, 52.0 52.0
appointedRep​VerbalContactDate String Date and time of verbal contact with the member's appointed representative. Maps to: CareRequest.AppointedRepVerbalContactDate Big, 46.0 46.0
appointedRep​WrittenContactDate String Date and time correspondence was sent to the member's appointed representative. Maps to: CareRequest.AppointedRepWrittenContactDate Big, 46.0 46.0
appointedRepresen​tative Appointed Representative Appointed representative for the member. Big, 46.0 46.0
approvedLength​ofStay Integer Approved number of days for the admission. Maps to: CareRequest.ApprovedLengthOfStay Big, 46.0 46.0
approvedLevel​ofCare String Approved level of care for the patient, for example, Hospital-Observaton or SNF-Rehabilitation. Maps to: CareRequest.ApprovedLevelOfCare Big, 46.0 46.0
authorization​RefIdentifier String The unique identifier of the authorization request. Maps to: CareRequestExtension.AuthorizationRefIdentifier Big, 57.0 57.0
careRequest​Reviewers Care Request ​Reviewer Output[] The care request associated with the care request reviewer. Maps to: CareRequest.CareRequestReviewers Big, 52.0 52.0
caseSubStatus String Sub status of care request in each stage of care request. Maps to: CareRequest.CaseSubStatus Big, 57.0 57.0
claimNumber String Claim number for the medical service or medication, if one exists. Maps to: CareRequest.ClaimNumber Big, 46.0 46.0
clinicalCase​Type String Clinical case type for the patient, for example, High Risk Fall or Adult Diabetes. Maps to: CareRequest.ClinicalCaseType Big, 46.0 46.0
criteriaMet String Indicates whether criteria for care was met. Maps to: CareRequest.CriteriaMet Big, 46.0 46.0
cumulativeLength​ofStay Integer Total number of days for the admission. Maps to: CareRequest.CumulativeLengthOfStay Big, 46.0 46.0
currentLevel​ofCare String Level of care that the patient is receiving. Maps to: CareRequest.CurrentLevelOfCare Big, 46.0 46.0
decisionDate String Date by which the decision must be made for the request. Maps to: CareRequest.DecisionDate Big, 46.0 46.0
decisionDays​Remaining Integer Number of days remaining for a decision or resolution. Maps to: CareRequest.DecisionDaysRemaining Big, 46.0 46.0
decisionLetter String The text of the determination letter sent to the member and provider. Maps to: CareRequest.DecisionLetter Big, 46.0 46.0
decisionNotes String Notes related to the decision. Maps to: CareRequest.DecisionNotes Big, 46.0 46.0
decisionReason String Reason for the decision. Maps to: CareRequest.DecisionReason Big, 46.0 46.0
decisionReason​Description String Text describing the reason for the decision. Maps to: CareRequest.DecisionReasonDescription Big, 46.0 46.0
deniedLength​ofStay Integer Number of days denied for the admission. Maps to: CareRequest.DeniedLengthOfStay Big, 46.0 46.0
deniedLevel​ofCare String Level of care denied for the patient. Maps to: CareRequest.DeniedLevelOfCare Big, 46.0 46.0
disposition​Notes String Notes related to the disposition of the request. Maps to: CareRequest.DispositionNotes Big, 46.0 46.0
documentAttachment​Status String The status of the document upload based on the checklist provided to the reviewers. Maps to: CareRequestExtension.DocumentAttachmentStatus
Valid values are:
  • Complete
  • Incomplete
 Big, 55.0 55.0
dueDate String Date the request is due for completion. Maps to: CareRequest.DueDate Big, 46.0 46.0
effectiveFrom String The start date for an effective-date range. Maps to: CareRequest.EffectiveFrom Big, 46.0 46.0
effectiveTo String The end date for an effective-date range. Maps to: CareRequest.EffectiveTo Big, 46.0 46.0
expirationDate String Expiration date for the request. Maps to: CareRequest.ExpirationDate Big, 46.0 46.0
extendedRequest Boolean Extended Request Maps to: CareRequest. Big, 46.0 46.0
extensionRequest​ReceivedDate String Date and time an extension was requested. Maps to: CareRequest.ExtensionRequestReceivedDate Big, 46.0 46.0
external​ComplaintID String Complaint ID number. Maps to: CareRequest.ExternalComplaintIdentifier Big, 46.0 46.0
facilityRecord​Number String The medical record number used to identify a patient. Maps to: CareRequest.FacilityRecordNumber Big, 46.0 46.0
facilityRoom​BedType String Type of facility bed for the patient. Maps to: CareRequest.FacilityRoomBedType Big, 46.0 46.0
facilityRoom​Number String The facility room number for the patient. Maps to: CareRequest.FacilityRoomNumber Big, 46.0 46.0
finalLevel​ofCare String Final level of care the patient. Maps to: CareRequest.FinalLevelOfCare Big, 46.0 46.0
firstReviewer First Reviewer The person who reviewed the request. Big, 46.0 46.0
firstReviewer​Notes String Notes from the first reviewer related to the case. Maps to: CareRequest.FirstReviewerNotes Big, 46.0 46.0
generalPractitioner General Practitioner Member's primary or general care practitioner. Big, 46.0 46.0
generalPractitioner​VerbalNotificationDate String Date when the primary care practitioner was verbally notified of the decision. Maps to: CareRequest.GeneralPractitionerVerbalNotifiedDate Big, 46.0 46.0
generalPractitioner​WrittenNotificationDate String Date when the primary care practitioner was notified of the decision by written correspondence. Maps to: CareRequest.GeneralPractitionerWrittenNotifiedDate Big, 46.0 46.0
grievanceType String Specifies the type of grievance. Maps to: CareRequest.GrievanceType Big, 52.0 52.0
healthcareProvider String The healthcare provider associated with the care request against whom the Grievance is filed. Maps toCareRequestExtension.HealthCareProvider Big, 52.0 52.0
homeHealthCertifi​cationEndDate String Certification end date for home health care. Maps to: CareRequestExtension.HomeHealthCertificationEndDate Big, 46.0 46.0
homeHealthCertifi​cationStartDate String Certification start date for home health care. Maps to: CareRequestExtension.HomeHealthCertificationStartDate Big, 46.0 46.0
homeHealth​StartDate String Date that home health services are scheduled or anticipated to start. Maps to: CareRequestExtension.HomeHealthStartDate Big, 46.0 46.0
id String ID of the Care Request. Big, 46.0 46.0
independentReview​Determination String The determination made by the independent review. Maps to: CareRequestExtension.IndependentReviewDetermination Big, 52.0 52.0
independentReview​DeterminationDate String The date when the determination was made by the independent review. Maps to: CareRequestExtension.IndependentReviewDeterminationDate Big, 52.0 52.0
independentReview​SubmissionDate String The date when the review request was submitted for independent review. Maps to: CareRequestExtension.IndependentReviewSubmissionDate Big, 52.0 52.0
infoReceieved​Date String Date and time when additional information was received from the provider or member. Maps to: CareRequest.InfoReceivedDate Big, 46.0 46.0
infoRequested​Date String Date and time when additional information was requested from the provider or member. Maps to: CareRequest.InfoRequestedDate Big, 46.0 46.0
initialDenial​NotificationDate String Date of initial denial notification. Maps to: CareRequest.InitialDenialNotificationDate Big, 46.0 46.0
initialDenial​NotificationTime String The time when the initial care request was denied. Maps to CareRequest.InitialDenialNotificationTime Big, 52.0 52.0
isIndependent​ReviewRequired Boolean Indicates whether independent review is required. Maps to CareRequestExtension.IsIndependentReviewRequired Big, 52.0 52.0
isReadmission Boolean Indicates whether the care request is for a readmission. Maps to CareRequest.IsReadmission Big, 52.0 52.0
lastModified​Date String Last Modified Date Big, 46.0 46.0
medicalDirector Medical Director The medical director who reviewed the request. Big, 46.0 46.0
medicalDirector​Notes String Notes from the medical director related to the request. Maps to: CareRequest.MedicalDirectorNotes Big, 46.0 46.0
member String Insurance identifier for the member. Maps to: CareRequest.MemberId Big, 46.0 46.0
memberContact​Date String Member Contact Date Maps to: CareRequest. Big, 46.0 46.0
memberGroup​Number String Insurance group number for the member. Maps to: CareRequest.MemberGroupNumber Big, 46.0 46.0
memberPrimary​Plan String The primary insurance plan of a member associated with the care request when the member is insured under multiple plans. Maps to: CareRequest.MemberPrimaryPlan Big, 52.0 52.0
memberSecondary​Plan String The secondary insurance plan of a member associated with the care request when the member is insured under multiple plans. Maps to: CareRequest.MemberSecondaryPlan Big, 52.0 52.0
memberVerbalNotifi​cationDate String Date when the member was verbally notified of the decision. Maps to: CareRequest.MemberVerbalNotificationDate Big, 46.0 46.0
memberWrittenNotifi​cationDate String Date when the member was notified of the decision by written correspondence. Maps to: CareRequest.MemberWrittenNotificationDate Big, 46.0 46.0
modification​Date String Date the case was modified. Maps to: CareRequest.ModificationDate Big, 46.0 46.0
modifiedLength​ofStay Integer Modified number of days for the admission. Maps to: CareRequest.ModifiedLengthOfStay Big, 46.0 46.0
modifiedLevel​ofCare String Modified level of care for the patient. Maps to: CareRequest.ModifiedLevelOfCare Big, 46.0 46.0
nextReview​Date String Date the next review is scheduled for completion. Maps to: CareRequest.NextReviewDate Big, 46.0 46.0
nursingHomeResi​dentialStatus String Nursing home resident status at the time of service. Maps to: CareRequestExtension.NursingHomeResidentialStatus Big, 46.0 46.0
originalDenial​MedicalDirector Original Denial​ Medical Director The medical director who denied the original request. Big, 46.0 46.0
parProvider String Indicator of whether this provider has entered into an agreement with the insurance carrier. Maps to: CareRequest.ParProvider Big, 46.0 46.0
placeof​Service String Place of service for the member's care such as an inpatient hospital or an ambulatory surgery center. Maps to: CareRequest.PlaceOfService Big, 46.0 46.0
practitioner​ContactDate String Date and time when the provider was contacted. Maps to: CareRequest.PractitionerContactDateTime Big, 46.0 46.0
priorDischarge​Status String Specifies the previous discharge status of the member. Maps to: CareRequestExtension.PriorDischargeStatus Big, 52.0 52.0
quantity Integer Quantity of the request. Big, 46.0 46.0
quantityType String Quantity type for the request such as days, units, or visits. Maps to: CareRequest.QuantityType Big, 46.0 46.0
receivedDate String Date the request was received. Maps to: CareRequest.ReceivedDate Big, 46.0 46.0
reconsiderationDenial​NotificationDate String Date of reconsideration denial notification. Maps to: CareRequest.ReconsiderationDenialNotificationDate Big, 46.0 46.0
reconsiderationDenial​NotificationTime String The time of reconsideration denial notification. Maps to: CareRequest.ReconsiderationDenialNotificationTime Big, 52.0 52.0
recordType String Record type of the care request object. Big, 46.0 46.0
referenceCare​RequestCase String The reference care request case number associated with the care request. Maps to: CareRequest.ReferenceCareRequestCase Big, 52.0 52.0
referenceCase​Number String Reference authorization number for an appeal, complaint, or grievance. Maps to: CareRequest.ReferenceCaseNumber Big, 46.0 46.0
reopenDecision​DateTime String Date and time the request was reopened. Maps to: CareRequest.ReopenDecisionDateTime Big, 52.0 52.0
reopenReason String Reason the request was reopened. Maps to: CareRequest.ReopenReason Big, 46.0 46.0
reopenReason​Description String Description of why the request was reopened. Maps to: CareRequest.ReopenReasonDescription Big, 46.0 46.0
reopenRequest​Outcome String The result of the reopen request. Maps to: CareRequestExtension.ReopenRequestOutcome Big, 52.0 52.0
reopenRequest​Type String The type of reopen request. Maps to: CareRequestExtension.ReopenRequestType Big, 52.0 52.0
reopenedBy Reopened By Output The user who reopened the care request. Maps to: CareRequestExtension.ReopenedBy Big, 52.0 52.0
reopenedDate String Date the request was reopened. Maps to: CareRequest.ReopenedDate Big, 46.0 46.0
requestExtension​Reason String The reason for requesting the care extension. Maps to: CareRequestExtension.RequestExtensionReason Big, 52.0 52.0
requestExtn​DecisionDateTime String The date when the decision to extend the care request extension was made. Maps to: CareRequestExtension.RequestExtnDecisionDateTime Big, 52.0 52.0
requestOutcome String Specifies the outcome of the request. Maps to: CareRequestExtension.RequestOutcome Big, 52.0 52.0
requestOutcome​Desc String The description of the request outcome. Maps to: CareRequestExtension.RequestOutcomeDesc Big, 52.0 52.0
requestType String Category type of the request. Maps to: CareRequestExtension.RequestType Big, 46.0 46.0
requested​Date String Date the request was originally requested. Maps to: CareRequest.RequestedDate Big, 46.0 46.0
requestedLength​OfStay Integer Requested length of stay for the patient. Maps to: CareRequest.RequestedLengthOfStay Big, 57.0 57.0
requestedLevel​ofCare String Requested level of care for the patient. Maps to: CareRequest.RequestedLevelOfCare Big, 46.0 46.0
requester​Type String Indicates the role of the individual initiating the request. Maps to: CareRequest.RequesterType Big, 46.0 46.0
requesting​Practitioner Requesting Practitioner Ordering or referring practitioner for the request. Big, 46.0 46.0
requestingPractitione​rLicense String Requesting Practitioner License Maps to: CareRequest.RequestingPractitionerLicense Big, 46.0 46.0
requestingPractitioner​Specialty String Specialty of the practitioner, for example, Family Practice or General Surgery. Maps to: CareRequest.RequestingPractitionerSpecialty Big, 46.0 46.0
requestingPractitioner​VerbalNotificationDate String Date when the practitioner was verbally notified of the decision. Maps to: CareRequest.RequestingPractitionerVerbalNotifiedDate Big, 46.0 46.0
requestingPractitioner​WrittenNotificationDate String Date when the practitioner was notified of the decision by written correspondence. Maps to: CareRequest.RequestingPractitionerWrittenNotifiedDate Big, 46.0 46.0
resolutionDate String Date when the complaint, appeal, or grievance was resolved. Maps to: CareRequest.ResolutionDate Big, 46.0 46.0
resolutionDescription String The resolution details provided for the complaint, appeal, or grievance. Maps to: CareRequestExtension.ResolutionDescription Big, 52.0 52.0
resolutionLetter​SentDate String Date and time when a resolution letter was sent to the requester. Maps to: CareRequest.ResolutionLetterSentDate Big, 46.0 46.0
resolutionNotes String Resolution notes for the request. Maps to: CareRequest.ResolutionNotes Big, 46.0 46.0
reviewDate String Date the review was completed. Maps to: CareRequest.ReviewDate Big, 46.0 46.0
rootCauseNotes String Field for notes related to the root cause for the request. Maps to: CareRequest.RootCauseNotes Big, 46.0 46.0
scheduledAdmission​Date String Anticipated admission date for the patient. Maps to: CareRequest.ScheduledAdmissionDate Big, 46.0 46.0
scheduledDischarge​Date String Scheduled discharge date for the patient. Maps to: CareRequest.ScheduledDischargeDate Big, 46.0 46.0
serviceDate String Date when patient received the service. Maps to: CareRequest.ServiceDate Big, 46.0 46.0
serviceLevel String The level of service rendered. Maps to: CareRequestExtension.ServiceLevel Big, 46.0 46.0
serviceType String Classification of the type of service. Maps to: CareRequestExtention.ServiceType Big, 46.0 46.0
serviceorMedication​Received Boolean Indicates whether the member has already received the medial service or medication. Maps to: CareRequest.IsServiceOrMedicationReceived Big, 46.0 46.0
servicingFacility Servicing Facility Facility where the service is being provided. Big, 46.0 46.0
servicingPractitioner Servicing Practitioner Practitioner administering the service. Big, 46.0 46.0
servicingPractitioner​License String License type of the practitioner. Maps to: CareRequest.ServicingPractitionerLicense Big, 46.0 46.0
servicingPractitioner​Specialty String Specialty of the practitioner. Maps to: CareRequest.ServicingPractitionerSpecialty Big, 46.0 46.0
sourceSystem String System from which this request was sourced. Maps to: CareRequest.SourceSystem Big, 46.0 46.0
sourceSystemIdentifier String ID of the system from which the request was sourced. Maps to: CareRequest.SourceSystemIdentifier Big, 46.0 46.0
sourceSystemModified String Timestamp of the most recent update from the source system. Maps to: CareRequest.SourceSystemModified Big, 46.0 46.0
unitOfMeasure String The unit of measure associated with the prior authorization request. Maps to: CareRequestExtension.UnitofMeasure Big, 55.0 55.0
# Care Request Case Case related to the care request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accountName | String | Name of the account. | Big, 46.0 | 46.0 | | caseNumber | String | Case number. | Big, 46.0 | 46.0 | | caseOrigin | String | The source of the case, such as Email, Phone, or Web. Maps to: Case.Origin | Big, 46.0 | 46.0 | | caseOwner | String | Case owner. | Big, 46.0 | 46.0 | | caseReason | String | The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Maps to: Case.Reason | Big, 46.0 | 46.0 | | closed | Boolean | Indicates if the case is closed. | Big, 46.0 | 46.0 | | contactName | String | Contact Name. | Big, 46.0 | 46.0 | | createdBy | String | Case created by. | Big, 46.0 | 46.0 | | dateClosed | String | Date and time when the case was closed. | Big, 46.0 | 46.0 | | dateOpened | String | Date and time when the case was opened. | Big, 46.0 | 46.0 | | description | String | A text description of the case. | Big, 46.0 | 46.0 | | escalated | Boolean | Indicates if the case is escalated. | Big, 46.0 | 46.0 | | lastModifiedBy | String | Last modified by. | Big, 46.0 | 46.0 | | lastModifiedDate | String | Last modified date of the case. | Big, 46.0 | 46.0 | | lastReferencedDate | String | Last referenced date of the case. | Big, 46.0 | 46.0 | | lastViewedDate | String | Last viewed date of the case. | Big, 46.0 | 46.0 | | parentCase | String | Parent Case. | Big, 46.0 | 46.0 | | priority | String | The importance or urgency of the case, such as High, Medium, or Low. Maps to: Case.Priority | Big, 46.0 | 46.0 | | status | String | The status of the case. Maps to: Case.Status | Big, 46.0 | 46.0 | | subject | String | The subject of the case. Maps to: Case.Subject | Big, 46.0 | 46.0 | | type | String | The type of case, such as Feature Request or Question. Maps to: Case.Type | Big, 46.0 | 46.0 | | webCompany | String | The company name that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedCompany | Big, 46.0 | 46.0 | | webEmail | String | The email address that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedEmail | Big, 46.0 | 46.0 | | webName | String | The name that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedName | Big, 46.0 | 46.0 | | webPhone | String | The phone number that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedPhone | Big, 46.0 | 46.0 | # Care Request Case Input Case related to the care request. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | caseOrigin | String | The source of the case, such as Email, Phone, or Web. Maps to: Case.Origin | Yes | 46.0 | | caseReason | String | The reason why the case was created, such as Instructions not clear, or User didn’t attend training. Maps to: Case.Reason | No | 46.0 | | description | String | A text description of the case. Limit: 32 KB. Maps to: Case.Description | No | 46.0 | | parentCaseNumber | String | The ID of the parent case in the hierarchy. Maps to: Case.ParentId | No | 46.0 | | priority | String | The importance or urgency of the case, such as High, Medium, or Low. Maps to: Case.Priority | No | 46.0 | | status | String | The status of the case. Maps to: Case.Status | No | 46.0 | | subject | String | The subject of the case. Limit: 255 characters. Maps to: Case.Subject | Yes | 46.0 | | type | String | The type of case, such as Feature Request or Question. Maps to: Case.Type | No | 46.0 | | suppliedCompany | String | The company name that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedCompany | No | 46.0 | | suppliedEmail | String | The email address that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedEmail | No | 46.0 | | suppliedName | String | The name that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedName | No | 46.0 | | suppliedPhone | String | The phone number that was entered when the case was created. This field can't be updated after the case has been created. Maps to: Case.SuppliedPhone | No | 46.0 | # Care Request Drug Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | approvedUnits | Integer | Approved quantity of the drug. Maps to: CareRequestDrug.ApprovedUnits | Big, 46.0 | 46.0 | | authApproval​Identifier | String | The unique identifier assigned to the drug on approval of the authorization request. Maps to: CareRequestDrug.AuthApprovalIdentifier | Big, 57.0 | 57.0 | | authorization​RefIdentifier | String | The unique identifier of the authorization request associated with this requested drug. Maps to: CareRequestDrug.AuthorizationRefIdentifier | Big, 57.0 | 57.0 | | careRequest​Reviewers | [Care Request Reviewer Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_reviewer_output.htm "Output representation of the care request reviewer.")\[\] | The care request drug associated with the care request reviewer. Maps to: CareRequestDrug.CareRequestReviewers | Big, 52.0 | 52.0 | | clinical​Determination | String | The clinical determination of the drug request. Maps to: CareRequestDrug.ClinicalDetermination | Big, 52.0 | 52.0 | | clinical​DeterminationNote | String | The notes related to the clinical determination. Maps to: CareRequestDrug.ClinicalDeterminationNote | Big, 52.0 | 52.0 | | clinical​DeterminationReason | String | The reason for the clinical determination. Maps to: CareRequestDrug.ClinicalDeterminationReason | Big, 52.0 | 52.0 | | code | String | Code for the drug. Maps to: CareRequestDrug.Code | Big, 46.0 | 46.0 | | codeType | String | ID code type for the drug. Maps to: CareRequestDrug.CodeType | Big, 46.0 | 46.0 | | daysSupply | Integer | Number of days to supply the drug. Maps to: CareRequestDrug.DaysSupply | Big, 46.0 | 46.0 | | deniedUnits | Integer | Denied quantity of the drug. Maps to: CareRequestDrug.DeniedUnits | Big, 46.0 | 46.0 | | dispenserAddress | [Dispenser Address](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_dispenser_address_output.htm "Pharmacy address.") | Pharmacy address. | Big, 46.0 | 46.0 | | dispenserFax​Number | String | Pharmacy fax number. Maps to: CareRequestDrug.DispenserFaxNumber | Big, 46.0 | 46.0 | | dispenserId | String | ID for the pharmacy. Maps to: CareRequestDrug.DispenserIdentifier | Big, 46.0 | 46.0 | | dispenserName | String | Name of the pharmacy. Maps to: CareRequestDrug.DispenserName | Big, 46.0 | 46.0 | | dispenserPhone​Number | String | Pharmacy phone number. Maps to: CareRequestDrug.DispenserPhoneNumber | Big, 46.0 | 46.0 | | dispenserTaxId | String | Pharmacy tax identification number. Maps to: CareRequestDrug.DispenserTaxIdentifier | Big, 46.0 | 46.0 | | dose | String | Dose of the drug. Maps to: CareRequestDrug.Dose | Big, 46.0 | 46.0 | | drugAdministration​Setting | String | The setting in which the drug is expected to be administered to the patient. Maps to: CareRequestDrug.DrugAdministrationSetting | Big, 57.0 | 57.0 | | frequency | String | Frequency of the drug. Maps to: CareRequestDrug.Frequency | Big, 46.0 | 46.0 | | id | String | Id | Big, 46.0 | 46.0 | | modifiedCode | String | Code for the modified drug. Maps to: CareRequestDrug.ModifiedCode | Big, 46.0 | 46.0 | | medicationRef​ObjectId | String | The medication request or statement associated with the care request drug. Maps to: CareRequestDrug.MedicationRefObject | Big, 57.0 | 57.0 | | modifiedCode​Type | String | ID code type for the modified drug. Maps to: CareRequestDrug.ModifiedCodeType | Big, 46.0 | 46.0 | | modifiedDays​Supply | Integer | Number of days of supply for the modified drug. Maps to: CareRequestDrug.ModifiedDaysSupply | Big, 46.0 | 46.0 | | modifiedDose | String | Dose of the modified drug. Maps to: CareRequestDrug.ModifiedDose | Big, 46.0 | 46.0 | | modifiedFrequency | String | Frequency of the modified drug. Maps to: CareRequestDrug.ModifiedFrequency | Big, 46.0 | 46.0 | | modifiedName | String | Name of the modified drug. Maps to: CareRequestDrug.ModifiedName | Big, 46.0 | 46.0 | | modifiedSig | String | Directions for use of the modified drug. Maps to: CareRequestDrug.ModifiedSig | Big, 46.0 | 46.0 | | modifiedStrength | String | Strength of the modified drug. Maps to: CareRequestDrug.ModifiedStrength | Big, 46.0 | 46.0 | | modifiedTherapy​Duration | Integer | Duration of therapy for the modified drug. Maps to: CareRequestDrug.ModifiedTherapyDuration | Big, 46.0 | 46.0 | | modifiedUnits | Integer | Modified quantity of the drug. Maps to: CareRequestDrug.ModifiedUnits | Big, 46.0 | 46.0 | | name | String | Name of the drug. Maps to: CareRequestDrug.Name | Big, 46.0 | 46.0 | | prescriptionDate | String | Date for the prescription. Maps to: CareRequestDrug.PrescriptionDate | Big, 46.0 | 46.0 | | prescription​FillDate | String | Date for the prescription fills. Maps to: CareRequestDrug.PrescriptionFillDate | Big, 57.0 | 57.0 | | prescriptionFills | Integer | Number of fills for the prescription. Maps to: CareRequestDrug.PrescriptionFills | Big, 46.0 | 46.0 | | priority | String | The priority representing the urgency of the drug's authorization request. Maps to: CareRequestDrug.Priority | Big, 57.0 | 57.0 | | requestType | String | The type of drug request. Maps to: CareRequestDrug.RequestType | Big, 57.0 | 57.0 | | serviceCategory | String | Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. Maps to: CareRequestDrug.ServiceCategory | Big, 46.0 | 46.0 | | serviceCategory​Code | String | Alphanumeric code that uniquely identifies a service type. Maps to: CareRequestDrug.ServiceCategoryCode | Big, 46.0 | 46.0 | | servicingFacility | [Servicing Facility Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_servicing_facility_output.htm "Facility where the service is being provided.") | The facility where a patient receives service of the requested drug. Maps to: CareRequestDrug.ServicingFacility | Big, 57.0 | 57.0 | | servicingProvider | [Servicing Practitioner Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_servicing_practitioner_output.htm "Practitioner administering the service.") | The healthcare provider who provides the service of the requested drug. Maps to: CareRequestDrug.ServicingProvider | Big, 57.0 | 57.0 | | sig | String | Directions for use of the drug. Maps to: CareRequestDrug.Sig | Big, 46.0 | 46.0 | | sourceSystem | String | System from which this request was sourced. Maps to: CareRequestDrug.SourceSystem | Big, 46.0 | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareRequestDrug.SourceSystemIdentifier | Big, 46.0 | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareRequestDrug.SourceSystemModified | Big, 46.0 | 46.0 | | status | String | The authorization status of the requested drug. Maps to: CareRequestDrug.Status | Big, 57.0 | 57.0 | | statusReason | String | The reason for the authorization status of the requested drug. Maps to: CareRequestDrug.StatusReason | Big, 57.0 | 57.0 | | strength | String | Strength of the drug. Maps to: CareRequestDrug.Strength | Big, 46.0 | 46.0 | | therapyDuration | Integer | Duration of therapy for the drug. Maps to: CareRequestDrug.TherapyDuration | Big, 46.0 | 46.0 | | units | Integer | Quantity of the drug. Maps to: CareRequestDrug.Units | Big, 46.0 | 46.0 | # Care Request Drug Input Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. ## Root XML tag ## JSON example { "sourceSystem": "source\_system\_name", "daysSupply": "10", "frequency": "16", "name": "Metoprolol" } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | approvedUnits | Integer | Approved quantity of the drug. Maps to: CareRequestDrug.ApprovedUnits | No | 46.0 | | AssertionIdentifier | String | The unique identifier of the coverage assertion. This is unavailable for PATCH requests. | No | 63.0 | | authApproval​Identifier | String | The unique identifier assigned to the drug on approval of the authorization request. Maps to: CareRequestDrug.AuthApprovalIdentifier | No | 57.0 | | authorization​RefIdentifier | String | The unique identifier of the authorization request associated with this requested drug. Maps to: CareRequestDrug.AuthorizationRefIdentifier | No | 57.0 | | careRequest​Reviewers | [Care Request Reviewer Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_reviewer_input.htm "The general details of the care request, care request item, care request drug, or care diagnosis associated with the care request reviewer.") | The care request drug associated with the care request reviewer. Maps to: CareRequestDrug.CareRequestReviewers | No | 52.0 | | clinical​Determination | String | The clinical determination of the drug request. Maps to: CareRequestDrug.ClinicalDetermination | No | 52.0 | | clinical​DeterminationNote | String | The notes related to the clinical determination. Maps to: CareRequestDrug.ClinicalDeterminationNote | No | 52.0 | | clinical​DeterminationReason | String | The reason for the clinical determination. Maps to: CareRequestDrug.ClinicalDeterminationReason | No | 52.0 | | code | String | Code for the drug. Maps to: CareRequestDrug.Code | No | 46.0 | | codeType | String | ID code type for the drug. Maps to: CareRequestDrug.CodeType | No | 46.0 | | daysSupply | Integer | Number of days to supply the drug. Maps to: CareRequestDrug.DaysSupply | No | 46.0 | | decisionDate | String | The date and time when the decision was made for this drug request. Maps to: CareRequestDrug.DecisionDate | No | 52.0 | | deniedUnits | Integer | Denied quantity of the drug. Maps to: CareRequestDrug.DeniedUnits | No | 46.0 | | dispenser​Address | [Dispenser Address Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_dispenser_address_input.htm "Address of the pharmacy.") | Pharmacy address. | No | 46.0 | | dispenserFax​Number | String | Pharmacy fax number. Maps to: CareRequestDrug.DispenserFaxNumber | No | 46.0 | | dispenserId | String | ID for the pharmacy. Maps to: CareRequestDrug.DispenserIdentifier | No | 46.0 | | dispenserName | String | Name of the pharmacy. Maps to: CareRequestDrug.DispenserName | No | 46.0 | | dispenserPhone​Number | String | Pharmacy phone number. Maps to: CareRequestDrug.DispenserPhoneNumber | No | 46.0 | | dispenserTaxId | String | Pharmacy tax identification number. Maps to: CareRequestDrug.DispenserTaxIdentifier | No | 46.0 | | dispensingPharmacy | String | The pharmacy that dispenses the drug. Maps to: CareRequestDrug.DispensingPharmacy | No | 52.0 | | dose | String | Dose of the drug. Maps to: CareRequestDrug.Dose | No | 46.0 | | drugAdministra​tionSetting | String | The setting in which the drug is expected to be administered to the patient. Maps to: CareRequestDrug.DrugAdministrationSetting | No | 57.0 | | frequency | String | Frequency of the drug. Maps to: CareRequestDrug.Frequency | No | 46.0 | | medicationCode | String | The code of the care request drug. Maps to: CareRequestDrug.MedicationCode | No | 52.0 | | id | String | ID of the Care Request Drug. | Required for PATCH. | 46.0 | | modifiedCode | String | Code for the modified drug. Maps to: CareRequestDrug.ModifiedCode | No | 46.0 | | modifiedCode​Type | String | ID code type for the modified drug. Maps to: CareRequestDrug.ModifiedCodeType | No | 46.0 | | medicationRef​ObjectId | String | The medication request or statement associated with the care request drug. | No | 57.0 | | modifiedDays​Supply | Integer | Number of days of supply for the modified drug. Maps to: CareRequestDrug.ModifiedDaysSupply | No | 46.0 | | modifiedDose | String | Dose of the modified drug. Maps to: CareRequestDrug.ModifiedDose | No | 46.0 | | modified​Frequency | String | Frequency of the modified drug. Maps to: CareRequestDrug.ModifiedFrequency | No | 46.0 | | modifiedName | String | Name of the modified drug. Maps to: CareRequestDrug.ModifiedName | No | 46.0 | | modifiedSig | String | Directions for use of the modified drug. Maps to: CareRequestDrug.ModifiedSig | No | 46.0 | | modifiedStrength | String | Strength of the modified drug. Maps to: CareRequestDrug.ModifiedStrength | No | 46.0 | | modifiedTherapy​Duration | Integer | Duration of therapy for the modified drug. Maps to: CareRequestDrug.ModifiedTherapyDuration | No | 46.0 | | modifiedUnits | Integer | Modified quantity of the drug. Maps to: CareRequestDrug.ModifiedUnits | No | 46.0 | | name | String | Name of the drug. Maps to: CareRequestDrug.Name | No | 46.0 | | prescription​Date | String | Date for the prescription. Maps to: CareRequestDrug.PrescriptionDate | No | 46.0 | | prescription​FillDate | String | Date of fills for the prescription. Maps to: CareRequestDrug.PrescriptionFillDate | No | 57.0 | | prescriptionFills | Integer | Number of fills for the prescription. Maps to: CareRequestDrug.PrescriptionFills | No | 46.0 | | priority | String | The priority representing the urgency of the drug's authorization request. Maps to: CareRequestDrug.Priority | No | 57.0 | | requestType | String | The type of drug request. Maps to: CareRequestDrug.RequestType | No | 57.0 | | responseDateTime | String | The date and time when the response was sent for the drug request. This is unavailable for PATCH requests. | No | 63.0 | | serviceCategory | String | Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. Maps to: CareRequestDrug.ServiceCategory | No | 46.0 | | serviceCategory​Code | String | Alphanumeric code that uniquely identifies a service type. Maps to: CareRequestDrug.ServiceCategoryCode | No | 46.0 | | servicingFacility | [Servicing Facility Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_servicing_facility_input.htm "Facility where the service is being provided.") | The facility where a patient receives service of the requested drug. Maps to: CareRequestDrug.ServicingFacility | No | 57.0 | | servicingProvider | [Servicing Practitioner Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_servicing_practitioner_input.htm "Practitioner administering the service.") | The healthcare provider who provides the service of the requested drug. Maps to: CareRequestDrug.ServicingProvider | No | 57.0 | | sig | String | Directions for use of the drug. Maps to: CareRequestDrug.Sig | No | 46.0 | | sourceSystem | String | System from which this request was sourced. Maps to: CareRequestDrug.SourceSystem | No | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareRequestDrug.SourceSystemIdentifier | No | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareRequestDrug.SourceSystemModified | No | 46.0 | | status | String | The authorization status of the requested drug. Maps to: CareRequestDrug.Status | No | 57.0 | | statusReason | String | The reason for the authorization status of the requested drug. Maps to: CareRequestDrug.StatusReason | No | 57.0 | | strength | String | Strength of the drug. Maps to: CareRequestDrug.Strength | No | 46.0 | | submittedDateTime | String | The date and time when the drug request was submitted. This is unavailable for PATCH requests. | No | 63.0 | | therapyDuration | Integer | Duration of therapy for the drug. Maps to: CareRequestDrug.TherapyDuration | No | 46.0 | | transactioNumber | Integer | The transaction number assigned to the drug request. This is unavailable with PATCH requests. | No | 63.0 | | units | Integer | Quantity of the drug. Maps to: CareRequestDrug.Units | No | 46.0 | # Care Request Input 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 or drugs. Care requests include prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances. ## Root XML tag ## JSON example { "requestingPractitionerSpecialty": "Neurologist", "placeOfService": "InPatient", "sourceSystemIdentifier": "0015", "name": "Care Request 15", "requestingPractitionerLicense": "M.D", "sourceSystem": "source\_system\_name", "servicingPractitionerLicense": "M.D", "servicingPractitionerSpecialty": "Hospitalist", "recordType": "Complaint" } ## Properties
Name Type Description Required Available Version
acknowledgement​LetterSentDate​ String Date and time when an acknowledgment letter was sent to the requester. Maps to: CareRequest.AcknowledgementLetterSentDate No 46.0
actualAdmission​Date String Actual admission date for the patient. Maps to: CareRequest.ActualAdmissionDate No 46.0
actualDischarge​Date String Actual discharge date for the patient. Maps to: CareRequest.ActualDischargeDate No 46.0
admission​Notes String Notes related to the admission. Maps to: CareRequest.AdmissionNotes No 46.0
admission​Source String Where the patient was admitted from, for example, a clinic or an emergency room. Maps to: CareRequest.AdmissionSource No 46.0
admissionType String Type of admission, for example, emergency or elective. Maps to: CareRequest.AdmissionType No 46.0
ambulanceTransport​Distance​ Integer Ambulance Transport Distance No 46.0
ambulanceTransport​Reason String Reason for ambulance transport. Maps to: CareRequestExtention.AmbulanceTransportReason No 46.0
ambulanceTransport​Type String Type of ambulance transport. Maps to: CareRequestExtention.AmbulanceTransportType No 46.0
aorReceived​Date String Date and time when the Appointment of Representative (AOR) form was received. Maps to: CareRequest.AorReceivedDate No 46.0
aorRequestedDate String Date and time when the AOR form was requested. Maps to: CareRequest.AorRequestedDate No 46.0
appealEffectuation​DateTime String The effective date of the outcome of the appeal request. For example, if a claim was successfully appealed, this field displays the date when the claim was paid. Maps to: CareRequestExtension.AppealEffectuationDateTime No 52.0
appealRequest​ReasonType String Specifies the reason for raising the appeal request. Maps to: CareRequest.AppealRequestReasonType No 52.0
appointedRepVerbal​ContactDate String Date and time of verbal contact with the member's appointed representative. Maps to: CareRequest.AppointedRepVerbalContactDate No 46.0
appointedRepWritten​ContactDate String Date and time correspondence was sent to the member's appointed representative. Maps to: CareRequest.AppointedRepWrittenContactDate No 46.0
appointed​Representative Appointed Representative Input Appointed representative for the member. If provided, the first name, last name, birthdate, and suffix fields are used to find at a unique Id, which is used to update CareRequest.AppointedRepresentativeId field. No 46.0
approvedLength​OfStay Integer Approved number of days for the admission. Maps to: CareRequest.ApprovedLengthOfStay No 46.0
approvedLevel​OfCare String Approved level of care for the patient, for example, Hospital-Observaton or SNF-Rehabilitation. Screen reader support enabled. Maps to: CareRequest.ApprovedLevelOfCare No 46.0
authorization​RefIdentifier String The unique identifier of the authorization request. Maps to: CareRequestExtension.AuthorizationRefIdentifier No 57.0
careRequest​Reviewers Care Request Reviewer Input The care request associated with the care request reviewer. Maps to: CareRequest.CareRequestReviewers No 52.0
caseSubStatus String Sub status of care request in each stage of care request. Maps to: CareRequest.CaseSubStatus No 57.0
claimNumber String Claim number for the medical service or medication, if one exists. Maps to: CareRequest.ClaimNumber No 46.0
clientSourceSysIdentifier String An identifier of the client's source system that sent the care request. This is unavailable for PATCH requests. No 63.0
clinicalCase​Type String Clinical case type for the patient, for example, High Risk Fall or Adult Diabetes. Maps to: CareRequest.ClinicalCaseType No 46.0
criteriaMet String Indicates whether criteria for care was met. Maps to: CareRequest.CriteriaMet No 46.0
cumulativeLength​OfStay Integer Total number of days for the admission. Maps to: CareRequest.CumulativeLengthOfStay No 46.0
currentLevel​OfCare String Level of care that the patient is receiving. Maps to: CareRequest.CurrentLevelOfCare No 46.0
decisionDate String Date by which the decision must be made for the request. Maps to: CareRequest.DecisionDate No 46.0
decisionLetter String The text of the determination letter sent to the member and provider. Maps to: CareRequest.DecisionLetter No 46.0
decisionNotes String Notes related to the decision. Maps to: CareRequest.DecisionNotes No 46.0
decisionReason String Reason for the decision. Maps to: CareRequest.DecisionReason No 46.0
decisionReason​Description String Text describing the reason for the decision. Maps to: CareRequest.DecisionReasonDescription No 46.0
deniedLength​OfStay Integer Number of days denied for the admission. Maps to: CareRequest.DeniedLengthOfStay No 46.0
deniedLevel​OfCare String Level of care denied for the patient. Maps to: CareRequest.DeniedLevelOfCare No 46.0
disposition​Notes String Notes related to the disposition of the request. Maps to: CareRequest.DispositionNotes No 46.0
document​AttachmentStatus String The current status of the document upload based on the checklist provided to the reviewers. Maps to: CareRequestExtention.DocumentAttachmentStatus
Valid values are:
  • Complete
  • Incomplete
 No 55.0
dueDate String Date the request is due for completion. Maps to: CareRequest.DueDate No 46.0
effectiveFrom String The start date for an effective-date range. Maps to: CareRequest.EffectiveFrom No 46.0
effectiveTo String The end date for an effective-date range. Maps to: CareRequest.EffectiveTo No 46.0
expirationDate String Expiration date for the request. Maps to: CareRequest.ExpirationDate No 46.0
extendedRequest Boolean Indicates whether a request was extended. Maps to: CareRequest.IsExtendedRequest No 46.0
extensionRequest​ReceivedDate String Date and time an extension was requested. Maps to: CareRequest.ExtensionRequestReceivedDate No 46.0
external​ComplaintId String Complaint ID number. Maps to: CareRequest.ExternalComplaintIdentifier No 46.0
facility​RecordNumber String The medical record number used to identify a patient. Maps to: CareRequest.FacilityRecordNumber No 46.0
facility​RoomBedType String Type of facility bed for the patient. Maps to: CareRequest.FacilityRoomBedType No 46.0
facilityRoom​Number String The facility room number for the patient. Maps to: CareRequest.FacilityRoomNumber No 46.0
finalLevel​OfCare String Final level of care the patient. Maps to: CareRequest.FinalLevelOfCare No 46.0
firstReviewer First Reviewer Input The person who reviewed the request. No 46.0
first​ReviewerNotes String Notes from the first reviewer related to the case. Maps to: CareRequest.FirstReviewerNotes No 46.0
general​Practitioner General Practitioner Input Member's primary or general care practitioner. Maps to CareRequest.generalPractitioner No 46.0
generalPractitioner​VerbalNotification​Date String Date when the primary care practitioner was verbally notified of the decision. Maps to: CareRequest.GeneralPractitionerVerbalNotifiedDate No 46.0
generalPractitioner​WrittenNotification​Date String Date when the primary care practitioner was notified of the decision by written correspondence. Maps to: CareRequest.GeneralPractitionerWrittenNotifiedDate No 46.0
grievanceType String Specifies the type of grievance. Maps to: CareRequest.GrievanceType No 52.0
healthCare​Provider String The healthcare provider associated with the care request against whom the Grievance is filed. Maps toCareRequestExtension.HealthCareProvider No 52.0
homeHealthCertification​EndDate String Certification end date for home health care. Maps to: CareRequestExtension.HomeHealthCertificationEndDate No 46.0
homeHealthCertification​StartDate String Certification start date for home health care. Maps to: CareRequestExtension.HomeHealthCertificationStartDate No 46.0
homeHealth​StartDate String Date that home health services are scheduled or anticipated to start. Maps to: CareRequestExtension.HomeHealthStartDate No 46.0
id String ID of the Care Request. Required for PATCH. 46.0
independentReview​Determination String The determination made by the independent review. Maps to: CareRequestExtension.IndependentReviewDetermination No 52.0
independentReview​DeterminationDate String The date when the determination was made by the independent review. Maps to: CareRequestExtension.IndependentReviewDeterminationDate No 52.0
independentReview​SubmissionDate String The date when the review request was submitted for independent review. Maps to: CareRequestExtension.IndependentReviewSubmissionDate No 52.0
infoReceieved​Date String Date and time when additional information was received from the provider or member. Maps to: CareRequest.InfoReceivedDate No 46.0
infoRequested​Date String Date and time when additional information was requested from the provider or member. Maps to: CareRequest.InfoRequestedDate No 46.0
initialDenial​NotificationDate String Date of initial denial notification. Maps to: CareRequest.InitialDenialNotificationDate No 46.0
initialDenial​NotificationTime String The time when the initial care request was denied. Maps to CareRequest.InitialDenialNotificationTime No 52.0
isIndependentReview​Required Boolean Indicates whether independent review is required. Maps to CareRequestExtension.IsIndependentReviewRequired No 52.0
isReadmission Boolean Indicates whether the care request is for a readmission. Maps to CareRequest.IsReadmission No 52.0
medicalDirector Medical Director Input The medical director who reviewed the request. No 46.0
medicalDirector​Notes String Notes from the medical director related to the request. Maps to: CareRequest.MedicalDirectorNotes No 46.0
memberContact​Date String Date and time when the member was contacted. Maps to: CareRequest.MemberContactDateTime No 46.0
memberGroup​Number String Insurance group number for the member. Maps to: CareRequest.MemberGroupNumber No 46.0
memberPrimary​Plan String The primary insurance plan of a member associated with the care request when the member is insured under multiple plans. Maps to: CareRequest.MemberPrimaryPlan No 52.0
memberSecondary​Plan String The secondary insurance plan of a member associated with the care request when the member is insured under multiple plans. Maps to: CareRequest.MemberSecondaryPlan No 52.0
memberVerbal​NotificationDate String Date when the member was verbally notified of the decision. Maps to: CareRequest.MemberVerbalNotificationDate No 46.0
memberWritten​NotificationDate String Date when the member was notified of the decision by written correspondence. Maps to: CareRequest.MemberWrittenNotificationDate No 46.0
modification​Date String Date the case was modified. Maps to: CareRequest.ModificationDate No 46.0
modifiedLength​OfStay Integer Modified number of days for the admission. Maps to: CareRequest.ModifiedLengthOfStay No 46.0
modifiedLevel​OfCare String Modified level of care for the patient. Maps to: CareRequest.ModifiedLevelOfCare No 46.0
name String Name of the Care Request. Maps to: CareRequest.Name Yes 46.0
nextReview​Date String Date the next review is scheduled for completion. Maps to: CareRequest.NextReviewDate No 46.0
nursingHome​ResidentialStatus String Nursing home-resident status at the time of service. Maps to: CareRequestExtension.NursingHomeResidentialStatus No 46.0
originalDenial​MedicalDirector Original Denial Medical Director Input The medical director who denied the original request. No 46.0
parProvider String Indicator of whether this provider has entered into an agreement with the insurance carrier. Maps to: CareRequest.ParProvider No 46.0
placeOfService String Place of service for the member's care such as an inpatient hospital or an ambulatory surgery center. Maps to: CareRequest.PlaceOfService No 46.0
practitioner​ContactDate String Date and time when the provider was contacted. Maps to: CareRequest.PractitionerContactDateTime No 46.0
priorDischarge​Status String Specifies the previous discharge status of the member. Maps to: CareRequestExtension.PriorDischargeStatus No 52.0
quantity Integer Quantity of the request. No 46.0
quantityType String Quantity type for the request such as days, units, or visits. Maps to: CareRequest.QuantityType No 46.0
receivedDate String Date the request was received. Maps to: CareRequest.ReceivedDate No 46.0
reconsideration​DenialNotification​Date String Date of reconsideration denial notification. Maps to: CareRequest.ReconsiderationDenialNotificationDate No 46.0
reconsideration​DenialNotification​Time String The time of reconsideration denial notification. Maps to: CareRequest.ReconsiderationDenialNotificationTime No 52.0
recordType String Record type of the care request object. No 46.0
recordTypeId String ID of the record type of the care request object. No 46.0
referenceCare​RequestCase String The reference care request case number associated with the care request. Maps to: CareRequest.ReferenceCareRequestCase No 52.0
reference​CaseNumber String Reference authorization number for an appeal, complaint, or grievance. Maps to: CareRequest.ReferenceCaseNumber No 46.0
reopenDecision​DateTime String Date and time the request was reopened. Maps to: CareRequest.ReopenDecisionDateTime No 52.0
reopenReason String Reason the request was reopened. Maps to: CareRequest.ReopenReason No 46.0
reopenReason​Description String Description of why the request was reopened. Maps to: CareRequest.ReopenReasonDescription No 46.0
reopenRequest​Outcome String The result of the reopen request. Maps to: CareRequestExtension.ReopenRequestOutcome No 52.0
reopenRequest​Type String The type of reopen request. Maps to: CareRequestExtension.ReopenRequestType No 52.0
reopenedBy Reopened By Input The user who reopened the care request. Maps to: CareRequestExtension.ReopenedBy No 52.0
reopenedBy​UserId String The ID of the user who reopened the care request. Maps to: CareRequestExtension.ReopenedByUserId No 52.0
reopenedDate String Date the request was reopened. Maps to: CareRequest.ReopenedDate No 46.0
requestExtension​Reason String The reason for requesting the care extension. Maps to: CareRequestExtension.RequestExtensionReason No 52.0
requestExtnDecision​DateTime String The date when the decision to extend the care request extension was made. Maps to: CareRequestExtension.RequestExtnDecisionDateTime No 52.0
requestOutcome String Specifies the outcome of the request. Maps to: CareRequestExtension.RequestOutcome No 52.0
requestOutcome​Desc String The description of the request outcome. Maps to: CareRequestExtension.RequestOutcomeDesc No 52.0
requestType String Category type of the request. Maps to: CareRequestExtension.RequestType No 46.0
requestedDate String Date the request was originally requested. Maps to: CareRequest.RequestedDate No 46.0
requestedLength​OfStay Integer Requested length of stay for the patient. Maps to: CareRequest.RequestedLengthOfStay No 57.0
requestedLevel​OfCare String Requested level of care for the patient. Maps to: CareRequest.RequestedLevelOfCare No 46.0
requesterType String Indicates the role of the individual initiating the request. Maps to: CareRequest.RequesterType No 46.0
requesting​Practitioner Requesting Practitioner Input Ordering or referring practitioner for the request. No 46.0
requesting​PractitionerLicense String Requesting Practitioner License Maps to: CareRequest.RequestingPractitionerLicense No 46.0
requesting​PractitionerSpecialty String Specialty of the practitioner, for example, Family Practice or General Surgery. Maps to: CareRequest.RequestingPractitionerSpecialty No 46.0
requesting​PractitionerVerbal​NotificationDate String Date when the practitioner was verbally notified of the decision. Maps to: CareRequest.RequestingPractitionerVerbalNotifiedDate No 46.0
requesting​PractitionerWritten​NotificationDate String Date when the practitioner was notified of the decision by written correspondence. Maps to: CareRequest.RequestingPractitionerWrittenNotifiedDate No 46.0
resolutionDate String Date when the complaint, appeal, or grievance was resolved. Maps to: CareRequest.ResolutionDate No 46.0
resolution​Description String The resolution details provided for the complaint, appeal, or grievance. Maps to: CareRequestExtension.ResolutionDescription No 52.0
resolution​LetterSentDate String Date and time when a resolution letter was sent to the requester. Maps to: CareRequest.ResolutionLetterSentDate No 46.0
resolutionNotes String Resolution notes for the request. Maps to: CareRequest.ResolutionNotes No 46.0
reviewDate String Date the review was completed. Maps to: CareRequest.ReviewDate No 46.0
rootCauseNotes String Field for notes related to the root cause for the request. Maps to: CareRequest.RootCauseNotes No 46.0
scheduled​AdmissionDate String Anticipated admission date for the patient. Maps to: CareRequest.ScheduledAdmissionDate No 46.0
scheduled​DischargeDate String Scheduled discharge date for the patient. Maps to: CareRequest.ScheduledDischargeDate No 46.0
serviceDate String Date when patient received the service. Maps to: CareRequest.ServiceDate No 46.0
serviceLevel String The level of service rendered. Maps to: CareRequestExtension.ServiceLevel No 46.0
serviceType String Classification of the type of service. Maps to: CareRequestExtension.ServiceType No 46.0
serviceor​MedicationReceived Boolean Indicates whether the member has already received the medial service or medication. Maps to: CareRequest.IsServiceOrMedicationReceived No 46.0
servicingFacility Servicing Facility Input Facility where the service is being provided. No 46.0
servicingPractitioner Servicing Practitioner Input Practitioner administering the service. No 46.0
servicingPractitioner​License String License type of the practitioner. Maps to: CareRequest.ServicingPractitionerLicense No 46.0
servicingPractitioner​Specialty String Specialty of the practitioner. Maps to: CareRequest.ServicingPractitionerSpecialty No 46.0
sourceSystem String System from which this request was sourced. Maps to: CareRequest.SourceSystem No 46.0
sourceSystem​Identifier String ID of the system from which the request was sourced. Maps to: CareRequest.SourceSystemIdentifier No 46.0
sourceSystem​Modified String The timestamp of the most recent update from the source system. Maps to: CareRequest.SourceSystemModified No 46.0
supportingDocUrl String The URL of supporting documentation such as a questionnaire. This is unavailable for PATCH requests. No 63.0
unitOfMeasure String The unit of measure associated with the prior authorization request. Maps to: CareRequestExtention.UnitOfMeasure

This field is a lookup to UnitOfMeasure.

 No 55.0
# Care Request Item The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | approvedLength​OfStay | Integer | The number of days requested for the admission. Maps to: CareRequestItem.ApprovedLengthOfStay | Big, 52.0 | 52.0 | | approvedLevel​OfCare | String | Specifies the approved level of care for the patient. Maps to: CareRequestItem.ApprovedLevelOfCare | Big, 52.0 | 52.0 | | approvedQuantity | Integer | The approved quantity of the care item. Maps to: CareRequestItem.ApprovedQuantity | Big, 46.0 | 46.0 | | approvedService​EndDate | String | The end date of the approved service that the patient received. Maps to: CareRequestItem.ApprovedServiceEndDate | Big, 52.0 | 52.0 | | approvedService​StartDate | String | The start date of the approved service that the patient received. Maps to: CareRequestItem.ApprovedServiceStartDate | Big, 52.0 | 52.0 | | authApproval​Identifier | String | The unique identifier assigned to the item on approval of the prior authorization request. Maps to: CareRequestItem.AuthApprovalIdentifier | Big, 57.0 | 57.0 | | authorization​RefIdentifier | String | The unique identifier of the prior authorization request associated with this requested item. Maps to: CareRequestItem.AuthorizationRefIdentifier | Big, 57.0 | 57.0 | | careRequest​Reviewers | [Care Request Reviewer Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_request_reviewer_output.htm "Output representation of the care request reviewer.")\[\] | The care request item associated with the care request reviewer. Maps to: CareRequestItem.CareRequestReviewers | Big, 52.0 | 52.0 | | clinical​Determination | String | The clinical determination of the care request. Maps to: CareRequestItem.ClinicalDetermintation | Big, 52.0 | 52.0 | | clinical​DeterminationNotes | String | The notes related to the clinical determination. Maps to: CareRequestItem.ClinicalDetermintationNotes | Big, 52.0 | 52.0 | | clinical​DeterminationReason | String | The reason for the clinical determination. Maps to: CareRequestItem.ClinicalDetermintationReason | Big, 52.0 | 52.0 | | clinicalService​RequestId | String | The clinical service request associated with the care request item. Maps to: CareRequestItem.ClinicalServiceRequest | Big, 57.0 | 57.0 | | codeDescription | String | Description of the denied service code. Maps to: CareRequestItem.CodeDescription | Big, 46.0 | 46.0 | | codeType | String | Code type for the service. Maps to: CareRequestItem.CodeType | Big, 46.0 | 46.0 | | codeTypeId | String | ID of the code type for the service. Maps to: CareRequestItem.CodeTypeIdentifier | Big, 46.0 | 46.0 | | cumulativeLength​OfStay | Integer | The number of days a patient is admitted. Maps to: CareRequestItem.CumulativeLengthOfStay | Big, 52.0 | 52.0 | | currentLevel​OfCare | String | Specifies the level of care the patient is receiving. Maps to: CareRequestItem.CurrentLevelOfCare | Big, 52.0 | 52.0 | | decisionDate | String | The date and time when the last decision was made for this care request item. Maps to: CareRequestItem.DecisionDate | Big, 52.0 | 52.0 | | deniedLevel​OfCare | String | The level of care denied for the patient. Maps to: CareRequestItem.DeniedLevelOfCare | Big, 52.0 | 52.0 | | deniedQuantity | Integer | The quantity of the denied service. Maps to: CareRequestItem.DeniedQuantity | Big, 46.0 | 46.0 | | effectiveDate | String | Effective date for the diagnosis Maps to: CareRequestItem.EffectiveDate | Big, 46.0 | 46.0 | | endDate | String | Termination date for the service. Maps to: CareRequestItem.EndDate | Big, 46.0 | 46.0 | | freeForm​ProcedureDescription | String | Free-form description of the procedure. Maps to: CareRequestItem.FreeFormProcedureDescription | Big, 46.0 | 46.0 | | healthcare​ProcedureCode | String | Healthcare Procedure Code. | Big, 46.0 | 46.0 | | id | String | ID of the CareRequestItem. | Big, 46.0 | 46.0 | | modifiedCare​EndDate | String | Modified Care End Date. | Big, 46.0 | 46.0 | | modifiedCode | String | Modified Code. | Big, 46.0 | 46.0 | | modifiedCode​Description | String | Description of the modified service code. Maps to: CareRequestItem.ModifiedCodeDescription | Big, 46.0 | 46.0 | | modifiedCode​Type | String | Code type for the modified service. Maps to: CareRequestItem.ModifiedCodeType | Big, 46.0 | 46.0 | | modifiedCode​TypeId | String | ID of the code type for the modified service. Maps to: CareRequestItem.ModifiedCodeTypeIdentifier | Big, 46.0 | 46.0 | | modified​EffectiveDate | String | Effective date for the modified service. Maps to: CareRequestItem.ModifiedEffectiveDate | Big, 46.0 | 46.0 | | modifiedLevel​OfCare | String | Specifies the modified level of care for the patient. Maps to: CareRequestItem.ModifiedLevelOfCare | Big, 52.0 | 52.0 | | modifiedModifier | String | Modifier for modified service code. Maps to: CareRequestItem.ModifiedModifier | Big, 46.0 | 46.0 | | modifiedModifier​Description | String | Modifier description for modified service code. Maps to: CareRequestItem.ModifiedModifierDescription | Big, 46.0 | 46.0 | | modified​ProcedureCodeSet | String | The code set for the modified service, drug, or device associated with the care request item. Maps to: CareRequestItem.ModifiedProcedureCodeSet | Big, 52.0 | 52.0 | | modifiedQuantity | Integer | The modified quantity of requested care. Maps to: CareRequestItem.ModifiedQuantity | Big, 46.0 | 46.0 | | modifier1 | String | First modifier for the service code. Maps to: CareRequestItem.Modifier | Big, 46.0 | 46.0 | | modifier1​Description | String | Description for the first modifier for the service code. Maps to: CareRequestItem.ModifierDescription | Big, 46.0 | 46.0 | | modifier2 | String | Second modifier for service code. Maps to: CareRequestItem.Modifier2 | Big, 46.0 | 46.0 | | modifier2​Description | String | Description of the second modifier for the service code. Maps to: CareRequestItem.Modifier2Description | Big, 46.0 | 46.0 | | modifier3 | String | Third modifier for service code. Maps to: CareRequestItem.Modifier3 | Big, 46.0 | 46.0 | | modifier3​Description | String | Description of the third modifier for the service code. Maps to: CareRequestItem.Modifier3Description | Big, 46.0 | 46.0 | | modifier4 | String | Fourth modifier for service code. Maps to: CareRequestItem.Modifier4 | Big, 46.0 | 46.0 | | modifier4​Description | String | Description of the fourth modifier for the service code. Maps to: CareRequestItem.Modifier4Description | Big, 46.0 | 46.0 | | modifierCode​Set | String | The modifier code set for the service code associated with the care request item. Maps to CareRequestItem.ModifierCodeSet | Big, 52.0 | 52.0 | | name | String | Name of the care request item. Maps to CareRequestItem.Name | Big, 46.0 | 46.0 | | priority | String | The priority representing the urgency of the item's authorization request. Maps to CareRequestItem.Priority | Big, 57.0 | 57.0 | | procedureCode​Set | String | The code set for the service, drug, or device associated with the care request item. Maps to CareRequestItem.ProcedureCodeSet | Big, 52.0 | 52.0 | | quantity | Integer | The quantity of the item that is requested. Maps to: CareRequestItem.Quantity | Big, 46.0 | 46.0 | | quantityType | String | Quantity type for the request such as days, units, or visits. Maps to: CareRequestItem.QualityType | Big, 46.0 | 46.0 | | serviceCategory | String | Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. Maps to: CareRequestItem.ServiceCategory | Big, 46.0 | 46.0 | | reasonCode | String | The reason justifying the care request of the item. Maps to: CareRequestItem.ReasonCode | Big, 57.0 | 57.0 | | requestType | String | The type of item request. Maps to: CareRequestItem.RequestType | Big, 57.0 | 57.0 | | requestedLength​OfStay | Integer | The number of days requested for the admission. Maps to: CareRequestItem.RequestedLengthOfStay | Big, 52.0 | 52.0 | | requestedLevel​OfCare | String | Specifies the requested level of care for the patient. Maps to: CareRequestItem.RequestedLevelOfCare | Big, 52.0 | 52.0 | | requested​ServiceEndDate | String | The end date of the requested service. Maps to: CareRequestItem.RequestedServiceEndDate | Big, 52.0 | 52.0 | | requested​ServiceStartDate | String | The start date of the requested service. Maps to: CareRequestItem.RequestedServiceStartDate | Big, 52.0 | 52.0 | | serviceCategory​Code | String | Alphanumeric code that uniquely identifies a service type. Maps to: CareRequestItem.ServiceCategoryCode | Big, 46.0 | 46.0 | | servicingFacility | [Servicing Facility Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_servicing_facility_output.htm "Facility where the service is being provided.") | The facility where a patient receives service of the requested item. Maps to: CareRequestItem.ServicingFacility | Big, 57.0 | 57.0 | | servicingProvider | [Servicing Practitioner Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_servicing_practitioner_output.htm "Practitioner administering the service.") | The healthcare provider who provides the service of the requested item. Maps to: CareRequestItem.ServicingProvider | Big, 57.0 | 57.0 | | sourceSystem | String | System from which the request was sourced. Maps to: CareRequestItem.SourceSystem | Big, 46.0 | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareRequestItem.SourceSystemIdentifier | Big, 46.0 | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareRequestItem.SourceSystemModified | Big, 46.0 | 46.0 | | status | String | The authorization status of this service. Maps to: CareRequestItem.Status | Big, 46.0 | 46.0 | | statusReason | String | Reason for the authorization status of this service. Maps to: CareRequestItem.StatusReason | Big, 46.0 | 46.0 | # Care Request Item Input The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request. ## Root XML tag ## JSON example { "name": "95810", "codeType": "CPT", "sourceSystem": "source\_system\_name", "codeDescription": "Dysuria", "sourceSystemIdentifier": "0015cmi", "quantity": "15" } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | approvedLength​OfStay | Integer | The number of days requested for the admission. Maps to: CareRequestItem.ApprovedLengthOfStay | No | 52.0 | | approvedLevel​OfCare | Integer | Specifies the approved level of care for the patient. Maps to: CareRequestItem.ApprovedLevelOfCare | No | 52.0 | | approvedQuantity | Integer | The approved quantity of the care item. Maps to: CareRequestItem.ApprovedQuantity | No | 46.0 | | approvedService​EndDate | String | The end date of the approved service that the patient received. Maps to: CareRequestItem.ApprovedServiceEndDate | No | 52.0 | | approvedService​StartDate | String | The start date of the approved service that the patient received. Maps to: CareRequestItem.ApprovedServiceStartDate | No | 52.0 | | AssertionIdentifier | String | The unique identifier of the coverage assertion. This is unavailable for PATCH requests. | No | 63.0 | | authApproval​Identifier | String | The unique identifier assigned to the item on approval of the prior authorization request. Maps to: CareRequestItem.AuthApprovalIdentifier | No | 57.0 | | authorization​RefIdentifier | String | The unique identifier of the prior authorization request associated with this requested item. Maps to: CareRequestItem.AuthorizationRefIdentifier | No | 57.0 | | careRequest​Reviewers | [Care Request Reviewer Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_request_reviewer_input.htm "The general details of the care request, care request item, care request drug, or care diagnosis associated with the care request reviewer.") | The care request item associated with the care request reviewer. Maps to: CareRequestItem.CareRequestReviewers | No | 52.0 | | clinical​Determination | String | The clinical determination of the care request. Maps to: CareRequestItem.ClinicalDetermintation | No | 52.0 | | clinical​DeterminationNotes | String | The notes related to the clinical determination. Maps to: CareRequestItem.ClinicalDetermintationNotes | No | 52.0 | | clinical​DeterminationReason | String | The reason for the clinical determination. Maps to: CareRequestItem.ClinicalDetermintationReason | No | 52.0 | | clinicalService​RequestId | String | The clinical service request associated with the care request item. Maps to: CareRequestItem.ClinicalServiceRequest | No | 57.0 | | code | String | ID of the service code. Maps to: CareRequestItem.Name | No | 46.0 | | codeDescription | String | Description of the denied service code. Maps to: CareRequestItem.CodeDescription | No | 46.0 | | codeType | String | Code type for the service. Maps to: CareRequestItem.CodeType | No | 46.0 | | codeTypeId | String | ID of the code type for the service. Maps to: CareRequestItem.CodeTypeIdentifier | No | 46.0 | | cumulativeLength​OfStay | Integer | The number of days a patient is admitted. Maps to: CareRequestItem.CumulativeLengthOfStay | No | 52.0 | | currentLevel​OfCare | String | Specifies the level of care the patient is receiving. Maps to: CareRequestItem.CurrentLevelOfCare | No | 52.0 | | decisionDate | String | The date and time when the last decision was made for this care request item. Maps to: CareRequestItem.DecisionDate | No | 52.0 | | deniedLevel​OfCare | String | The level of care denied for the patient. Maps to: CareRequestItem.DeniedLevelOfCare | No | 52.0 | | deniedQuantity | Integer | The quantity of the denied service. Maps to: CareRequestItem.DeniedQuantity | No | 46.0 | | effectiveDate | String | Effective date for the diagnosis Maps to: CareRequestItem.EffectiveDate | No | 46.0 | | endDate | String | Termination date for the service. Maps to: CareRequestItem.EndDate | No | 46.0 | | freeFormProcedure​Description | String | Free-form description of the procedure. Maps to: CareRequestItem.FreeFormProcedureDescription | No | 46.0 | | healthcare​ProcedureCode | String | Healthcare Procedure Code. | No | 46.0 | | id | String | ID of the CareRequestItem. | Required for PATCH. | 46.0 | | modifiedCare​EndDate | String | Modified Care End Date | No | 46.0 | | modifiedCode | String | Modified Code | No | 46.0 | | modifiedCode​Description | String | Description of the modified service code. Maps to: CareRequestItem.ModifiedCodeDescription | No | 46.0 | | modifiedCode​Type | String | Code type for the modified service. Maps to: CareRequestItem.ModifiedCodeType | No | 46.0 | | modifiedCode​TypeId | String | ID of the code type for the modified service. Maps to: CareRequestItem.ModifiedCodeTypeIdentifier | No | 46.0 | | modified​EffectiveDate | String | Effective date for the modified service. Maps to: CareRequestItem.ModifiedEffectiveDate | No | 46.0 | | modifiedLevel​OfCare | String | Specifies the modified level of care for the patient. Maps to: CareRequestItem.ModifiedLevelOfCare | No | 52.0 | | modifiedModifier | String | Modifier for modified service code. Maps to: CareRequestItem.ModifiedModifier | No | 46.0 | | modifiedModifier​Description | String | Modifier description for modified service code. Maps to: CareRequestItem.ModifiedModifierDescription | No | 46.0 | | modifiedProcedure​CodeSet | String | The code set for the modified service, drug, or device associated with the care request item. Maps to: CareRequestItem.ModifiedProcedureCodeSet | No | 52.0 | | modifiedQuantity | Integer | The modified quantity of requested care. Maps to: CareRequestItem.ModifiedQuantity | No | 46.0 | | modifier1 | String | First modifier for the service code. Maps to: CareRequestItem.Modifier | No | 46.0 | | modifier1​Description | String | Description for the first modifier for the service code. Maps to: CareRequestItem.ModifierDescription | No | 46.0 | | modifier2 | String | Second modifier for service code. Maps to: CareRequestItem.Modifier2 | No | 46.0 | | modifier2​Description | String | Description of the second modifier for the service code. Maps to: CareRequestItem.Modifier2Description | No | 46.0 | | modifier3 | String | Third modifier for service code. Maps to: CareRequestItem.Modifier3 | No | 46.0 | | modifier3​Description | String | Description of the third modifier for the service code. Maps to: CareRequestItem.Modifier3Description | No | 46.0 | | modifier4 | String | Fourth modifier for service code. Maps to: CareRequestItem.Modifier4 | No | 46.0 | | modifier4​Description | String | Description of the fourth modifier for the service code. Maps to: CareRequestItem.Modifier4Description | No | 46.0 | | modifierCodeSet | String | The modifier code set for the service code associated with the care request item. Maps to CareRequestItem.ModifierCodeSet | No | 52.0 | | name | String | Name of the care request item. Maps to CareRequestItem.Name | No | 46.0 | | priority | String | The priority representing the urgency of the item's authorization request. Maps to CareRequestItem.Priority | No | 57.0 | | procedureCodeSet | String | The code set for the service, drug, or device associated with the care request item. Maps to CareRequestItem.ProcedureCodeSet | No | 52.0 | | quantity | Integer | The quantity of the item that is requested. Maps to: CareRequestItem.Quantity | No | 46.0 | | quantityType | String | Quantity type for the request such as days, units, or visits. Maps to: CareRequestItem.QualityType | No | 46.0 | | reasonCode | String | The reason justifying the care request of the item. Maps to: CareRequestItem.ReasonCode | No | 57.0 | | requestType | String | The type of item request. Maps to: CareRequestItem.RequestType | No | 57.0 | | requestedLength​OfStay | Integer | The number of days requested for the admission. Maps to: CareRequestItem.RequestedLengthOfStay | No | 52.0 | | requestedLevel​OfCare | String | Specifies the requested level of care for the patient. Maps to: CareRequestItem.RequestedLevelOfCare | No | 52.0 | | requestedService​EndDate | String | The end date of the requested service. Maps to: CareRequestItem.RequestedServiceEndDate | No | 52.0 | | requestedService​StartDate | String | The start date of the requested service. Maps to: CareRequestItem.RequestedServiceStartDate | No | 52.0 | | responseDateTime | String | The date and time when the response was sent for the drug request. | No | 63.0 | | serviceCategory | String | Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. Maps to: CareRequestItem.ServiceCategory | No | 46.0 | | serviceCategory​Code | String | Alphanumeric code that uniquely identifies a service type. Maps to: CareRequestItem.ServiceCategoryCode | No | 46.0 | | servicingFacility | [Servicing Facility Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_servicing_facility_input.htm "Facility where the service is being provided.") | The facility where a patient receives service of the requested item. Maps to: CareRequestItem.ServicingFacility | No | 57.0 | | servicingProvider | [Servicing Practitioner Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_servicing_practitioner_input.htm "Practitioner administering the service.") | The healthcare provider who provides the service of the requested item. Maps to: CareRequestItem.ServicingProvider | No | 57.0 | | sourceSystem | String | System from which the request was sourced. Maps to: CareRequestItem.SourceSystem | No | 46.0 | | sourceSystem​Identifier | String | ID of the system from which the request was sourced. Maps to: CareRequestItem.SourceSystemIdentifier | No | 46.0 | | sourceSystem​Modified | String | Timestamp of the most recent update from the source system. Maps to: CareRequestItem.SourceSystemModified | No | 46.0 | | status | String | The authorization status of this service. Maps to: CareRequestItem.Status | No | 46.0 | | statusReason | String | Reason for the authorization status of this service. Maps to: CareRequestItem.StatusReason | No | 46.0 | | submittedDateTime | String | The date and time when the drug request was submitted. This is unavailable for PATCH requests. | Yes | 63.0 | | transactionNumber | Integer | The transaction number assigned to the drug request. This is unavailable for PATCH requests. | No | 63.0 | # Care Request Patient The patient for whom the request is being raised. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | birthDate | String | Date of birth of the patient. | Big, 46.0 | 46.0 | | firstName | String | First name of the patient. | Big, 46.0 | 46.0 | | lastName | String | Last name of the patient. | Big, 46.0 | 46.0 | | memberId | String | Insurance identifier for the member. | Big, 46.0 | 46.0 | # Care Request Patient Input The patient for whom the request is being raised. ## Root XML tag ## Properties
Name Type Description Required Available Version
addressLine1 String Patient’s address line 1. No 46.0
addressLine2 String Patient’s Address Line 2. No 46.0
birthDate String Date of birth of the patient. Maps to: CareRequest.MemberDateOfBirth

Note: Required if birth date is specified in the member account record. Must be in DateTime format; for example: 1970-04-30T00:00:00.

No 46.0
city String City where the patient lives. No 46.0
firstName String First name of the patient. No 46.0
gender String Gender of the patient. Maps to: CareRequest.MemberGender No 46.0
lastName String Last name of the patient. Yes 46.0
medicareCoverage Boolean Indicates whether the patient has Medicare coverage. Maps to: CareRequestExtension.IsMedicareCoverage No 46.0
memberCondition String Free-form description of the patient’s condition. Maps to: CareRequest.MemberCondition No 46.0
memberId String Lookup to MemberPlan.MemberNumber.

Note: Not the insurance identifier for the member in Account.

 Yes 46.0
memberPrognosis String Indicator of the provider's prognosis for the patient. Maps to: CareRequest.MemberPrognosis No 46.0
memberStatus String The patient’s status at admission, date of outpatient service, or start of care. Maps to: CareRequest.MemberStatus No 46.0
middleName String Middle name of the patient. No 46.0
state String State where the patient lives. No 46.0
suffix String Name suffix of the patient. No 46.0
zipCode String ZIP code of the patient’s address. No 46.0
# Care Request Reviewer Input The general details of the care request, care request item, care request drug, or care diagnosis associated with the care request reviewer. ## Root XML tag ## JSON example "careRequestReviewers": \[{ "reviewer": "0cmx0000000JP7WAAW", "reviewerType": "Registered Nurse Review", "status": "In process", "reviewDate": "2021-04-20T13:09:04.359Z", "reviewerNotes": "Care Request Review is In Process" }\] ## Properties
Name Type Description Required or Optional Available Version
contentDocument Content Document Input The details of the content document. No 57.0
id String The ID of the care request reviewer. Yes 52.0
reviewDate String The date when the care request was reviewed. No 52.0
reviewer String The name of the user who reviewed the care request. Yes 52.0
reviewerNotes String The notes related to the review. No 52.0
reviewerType String The type of the reviewer who reviewed the care request.
Possible values are:
  • Medical Director Review
  • Registered Nurse Review
  • Physician Review
  • Peer Review
 No 52.0
status String The status of the care request.
Possible values are:
  • Approved
  • Denied
  • In process
 No 52.0
# Care Request Reviewer Output Output representation of the care request reviewer.
Property Name Type Description Filter Group and Version Available Version
contentDocument Content Document Output The details of the content document. Big, 57.0 57.0
id String The ID of the care request reviewer. Big, 52.0 52.0
reviewDate String The date when the care request was reviewed. Big, 52.0 52.0
reviewer String The name of the user who reviewed the care request. Big, 52.0 52.0
reviewerNotes String The notes related to the review. Big, 52.0 52.0
reviewerType String The type of the reviewer who reviewed the care request.
Possible values are:
  • Medical Director Review
  • Registered Nurse Review
  • Physician Review
  • Peer Review
 Big, 52.0 52.0
status String The status of the care request.
Possible values are:
  • Approved
  • Denied
  • In process
 Big, 52.0 52.0
# Care Request Subscriber Input The primary member on the plan. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | addressLine1 | String | Subscriber’s address line 1. | No | 46.0 | | addressLine2 | String | Subscriber’s address line 2. | No | 46.0 | | city | String | Subscriber’s city. | No | 46.0 | | firstName | String | First name of the subscriber. Maps to: Account.FirstName | No | 46.0 | | lastName | String | Last name of the subscriber. Maps to: Account.LastName | Yes | 46.0 | | memberId | String | Subscriber Member ID. | Yes | 46.0 | | middleName | String | Middle name of the subscriber. Maps to: Account.MiddleName | No | 46.0 | | state | String | Subscriber’s state. | No | 46.0 | | suffix | String | Name suffix of the subscriber for a person account. Maximum size is 40 characters. Maps to: Account.Suffix | No | 46.0 | | zipCode | String | Subscriber’s zip code. | No | 46.0 | # Care Requests List Input A list of care authorization requests. ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | careRequestsList | [Care Authorization Request Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_care_authorization_request_input.htm "A complete care authorization request.")\[\] | List of Care Requests to be created or updated. (Up to 25 items.) | Yes | 46.0 | ## JSON Schema { "careRequestsList": \[ { "careRequestCase": { "caseOrigin": "Web" }, "careRequest": { "recordType": "Admission", "authorizationRefIdentifier": "1234", "name": "Headache", "member": "001RM000005XHdbYAG", "memberPrimaryPlan": "0SqRM00000000Fp0AI", "caseSubStatus": "active", "servicingFacility": { "npi": "742963", "servicingFacilityId": "0klRM0000004CBnYAM" }, "requestingPractitioner": { "npi": "11111", "healthCareProviderId": "0cmRM0000000tldYAA" } }, "careRequestItems": \[ { "authApprovalIdentifier": "123", "authorizationRefIdentifier": "123", "name": "CRI Connect-1.0", "procedureCodeSet": "0hxxG0000008hKxxAI", "requestType": "Order", "priority": "Stat", "healthcareProcedureCode": "0XSxx000000SXxxA2", "reasonCode": "0hsRM00000003ytYAA", "servicingFacility": { "npi": "742963", "servicingFacilityId": "0klRM0000004CBnYAM" }, "servicingProvider": { "npi": "11111", "healthCareProviderId": "0cmRM0000000tldYAA" }, "clinicalServiceRequestId": "0jyRM0000004CAGYA2" } \], "careDiagnoses": \[ { "name": "CD Connect 1.0", "presentOnAdmission": "Yes", "diagnosisCodeSet": "0hsSG0000008hKjYAI", "healthcareDiagnosisCode": "0XNSG0000000PjB4AU", "healthConditionId": "0j4RM0000004Mk9YAE" } \], "careRequestDrugs": \[ { "name": "CRD Connect 1.0", "status": "Active", "statusReason": "Insufficient Information", "requestType": "Filler Order", "drugAdministrationSetting": "Inpatient", "priority": "Routine", "medicationRefObjectId": "0kmRM0000004CSeYAM", "authApprovalIdentifier": "123", "authorizationRefIdentifier": "123", "servicingFacility": { "npi": "742963", "servicingFacilityId": "0klRM0000004CBnYAM" }, "servicingProvider": { "npi": "11111", "healthCareProviderId": "0cmRM0000000tldYAA" } } \], "assessmentLinks": \[ { "id": "0U3SG00000068Cb0AI" }, "patient": { "memberId": "001RM000005XHdbYAG", "lastName": "Green", "firstName": "Charles", "birthDate": "2001-10-26T21:32:52" } } \] } ## Root XML tag # CareBarrier Represents the circumstances or obstacles affecting a patient or member. Available in API version 45.0 and later. ## Supported Calls describeLayout(),describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### CareBarrierTypeId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Identifier for the care barrier type for the patient or member. This is a relationship field. - **Relationship Name**: CareBarrierType - **Relationship Type**: Lookup - **Refers To**: CareBarrierType ### CaseId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of the associated case. This is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### EffectiveFrom - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date on which the barrier becomes effective. ### EffectiveTo - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Termination date for the barrier. ### ExtlProblemDefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the external problem definition in the source system. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this barrier is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the barrier. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PatientId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Identifier for the patient or member. This is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Lookup - **Refers To**: Account ### Priority - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Priority of the barrier. - **Possible values**: - Low - Normal - High ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care barrier record in the external source system. ### SourceSystemModifiedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care barrier record was last modified in the external source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ### Status - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Status of the barrier. - **Possible values**: - Open - Addressed ### SurveyResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier for the survey response related to the barrier. ## 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. [CareBarrierChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 58.0) Change events are available for the object. [CareBarrierFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareBarrierHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareBarrierOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareBarrierShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareBarrierDeterminant Represents the relationship of a barrier to a determinant for a patient or member. Available in API version 45.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### CareBarrierId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the care barrier associated with this record. This is a relationship field. - **Relationship Name**: CareBarrier - **Relationship Type**: Lookup - **Refers To**: CareBarrier ### CareDeterminantId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: ID of the care determinant associated with this record. This is a relationship field. - **Relationship Name**: CareDeterminant - **Relationship Type**: Lookup - **Refers To**: CareDeterminant ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The name of the relationship between the barrier and the determinant. For example, Mold growth in home - Housing. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareBarrierDeterminantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [CareBarrierDeterminantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareBarrierDeterminantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareBarrierDeterminantOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareBarrierDeterminantShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareBarrierType Represents the standard, defined list of barriers maintained by an organization. Available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Medical vocabulary code for the barrier. ### CodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Medical vocabulary code type for the barrier. - **Possible values**: - ICD-10-CM - SNOMED CT ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the barrier. ### DiagnosisCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code set associated with the care barrier type. This is a polymorphic relationship field. - **Relationship Name**: DiagnosisCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### HealthCareDiagnosisId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code for the barrier. HealthCareDiagnosisId may be deprecated in a future release, so use DiagnosisCodeSetId instead. This is a relationship field. - **Relationship Name**: HealthCareDiagnosis - **Relationship Type**: Lookup - **Refers To**: HealthCareDiagnosis ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this care barrier type is active. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the care barrier type. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## 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. [CareBarrierTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [CareBarrierTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareBarrierTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareBarrierTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareBarrierTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareBenefitVerifyRequest Request for verification of benefits. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignedToId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user assigned to the care benefit verify request. This field is a relationship field. This field is available in API version 62.0 and later. - **Relationship Name**: AssignedTo - **Refers To**: User ### AuthorizedPrescriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authorized prescription associated with the care benefit verify request. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: AuthorizedPrescription - **Relationship Type**: Lookup - **Refers To**: MedicationRequest ### BenefitCategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The benefit category code associated with the care benefit verify request. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: BenefitCategoryCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### BillablePrdEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when billable period ended. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. ### BillablePrdStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when billable period started. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program enrollee associated with the care benefit verify request. This field is a relationship field. This field is available in API version 62.0 and later. - **Relationship Name**: CareProgramEnrollee - **Refers To**: CareProgramEnrollee ### CareProgramId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The care program associated with the care benefit verify request. This field is a relationship field. This field is available in API version 62.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: CareProgram - **Refers To**: CareProgram ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the associated case. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### CoverageBenefitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the set of services covered by the insurance plan. This field is a relationship field. - **Relationship Name**: CoverageBenefit - **Relationship Type**: Lookup - **Refers To**: CoverageBenefit ### InitialFillDuration - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The initial fill duration of the authorized prescription. This field is available in API version 62.0 and later with the Manage Pharmacy Benefits Verification permission set. ### InitialFillQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The initial fill quantity of the authorized prescription. This field is available in API version 62.0 and later with the Manage Pharmacy Benefits Verification permission set. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Identifies the member plan that includes the benefit item being verified. This field is a relationship field. - **Relationship Name**: MemberPlan - **Relationship Type**: Lookup - **Refers To**: MemberPlan ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care benefit verification request. ### OriginalPrescriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The original prescription associated with the care benefit verify request. This field is a polymorphic relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: OriginalPrescription - **Relationship Type**: Lookup - **Refers To**: MedicationRequest ### PayerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The payer associated with the care benefit verify request. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: Payer - **Relationship Type**: Lookup - **Refers To**: Account ### PlanId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The purchaser plan from the member plan associated with the care program enrollee. This field is a relationship field. This field is available in API version 62.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: Plan - **Refers To**: PurchaserPlan ### PrescriberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The prescriber associated with the care benefit verify request. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: Prescriber - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### PrescriptionMedicationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The medication code or medication name of the authorized prescription. This field is a polymorphic relationship field. This field is available in API version 62.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: PrescriptionMedication - **Refers To**: CodeSetBundle, Medication ### PriorityCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority code associated with the care benefit verify request. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: PriorityCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider of the care benefit verify request. This field is a polymorphic relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: Provider - **Relationship Type**: Lookup - **Refers To**: Account, HealthcareProvider ### RelatedCareBnftVerifyRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The original care benefit verify request from which the current request is cloned. This field is a relationship field. This field is available in API version 62.0 and later. - **Relationship Name**: RelatedCareBnftVerifyRequest - **Refers To**: CareBenefitVerifyRequest ### Request - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The JSON request body sent to an external system for care benefit verification. ### RequestDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date of verification request. ### RequestedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person or organization requesting verification. This field is a relationship field. - **Relationship Name**: RequestedBy - **Relationship Type**: Lookup - **Refers To**: User ### RequesterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The requester associated with the care benefit verify request. This field is a polymorphic relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: Requester - **Relationship Type**: Lookup - **Refers To**: Account, HealthcareProvider ### ResponseBody - **Type**: base64 - **Properties**: Create, Nillable, Update - **Description**: Full JSON response from external system. ### ResponseContentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The content type of the response from the external system. - **Possible values**: - 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 - 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/ogg - 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 - 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 ### ResponseLength - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The length of the response from the external system. ### ResponseName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the response from the external system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of the verification request. - **Possible values**: - Acknowledged - Completed - Copy - Error - Partial - Pending - Rejected - TimedOut—Timed Out - Verified - Pending Confirmation - Receieved Confirmation - Ready for Verification ### StatusReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The reason for the specified status of the care benefit verification request. ### VerificationMode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the mode of verification used in the care benefit verify request. This field is available in API version 63.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Possible values**: - Electronic - Manual ## 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. [CareBenefitVerifyRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CareBenefitVerifyRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareBenefitVerifyRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareBenefitVerifySettings Configuration settings for benefit verification requests. This object is available in API version 53.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareBenefitVerifySettings type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the CareBenefitVerifySettings. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label that identifies the CareBenefitVerifySettings throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareBenefitVerifySettings’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### UriPath - **Type**: textarea - **Properties**: Nillable - **Description**: External endpoint where Salesforce can access the verification service data. ## 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. [CareBenefitVerifySettingsChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # CareBnftVrfyRqstStsChgEvent Notifies subscribers of changes to the status of a care benefit verify request. This object is available in API version 65.0 and later. ## Supported Calls create(), describeSObjects() ## Special Access Rules This object is available to users with Manage Pharmacy Benefits Verification and Health Cloud Starter (for Life Sciences Cloud) or Health Cloud Foundation (for Health Cloud) permission set. ## Fields ### EventCreationDateTime - **Type**: dateTime - **Properties**: Create, Nillable - **Description**: The date and time when the event was created. ### RecordIdentifier - **Type**: string - **Properties**: Create - **Description**: The identifier of the associated care benefit verify request record. ### Status - **Type**: string - **Properties**: Create - **Description**: Specifies the status of a care benefit verify request. # 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. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### CareDeterminantTypeId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Care determinant for the patient or member. This is a relationship field. - **Relationship Name**: CareDeterminantType - **Relationship Type**: Lookup - **Refers To**: CareDeterminantType ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this care determinant is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the care determinant. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PatientId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: Identifier for the patient or member. This is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Lookup - **Refers To**: Account ### Priority - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Sort - **Description**: Priority of the determinant such as **Low** or **High**. ### SurveyResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Survey response related to the determinant. ## 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. [CareDeterminantChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 58.0) Change events are available for the object. [CareDeterminantFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareDeterminantHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareDeterminantOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareDeterminantShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # 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. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### Description - **Type**: textarea - **Properties**: Nillable - **Description**: Description of the determinant. ### Domain - **Type**: picklist - **Properties**: Filter, Group, Sort - **Description**: The domain for the determinant. - **Possible values**: - Access to health care - Child care - Clothing - Education - Employment - Finances - Food - General (non-specific) - Housing - Immigration/Migration - Incarceration - Primary Language - Race/Ethnicity - Residential Address - Safety - Social Connections/Isolation - Stress - Transportation - Utilities - Veteran Status ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this care determinant type is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the care determinant type. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Type - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: The type of determinant. - **Possible values**: - Social - Behavior - Genetics ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareDeterminantTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [CareDeterminantTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareDeterminantTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareDeterminantTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareDeterminantTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareInterventionType Represents the standard, defined list of interventions maintained by an organization. Available in API version 45.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Medical vocabulary code for the intervention. ### CodeType - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Nillable, Sort - **Description**: Medical vocabulary code type for the intervention. ### Description - **Type**: textarea - **Properties**: Nillable - **Description**: Description of the intervention. ### HealthCareProcedureId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Procedure code for the intervention. This is a relationship field. - **Relationship Name**: HealthCareProcedure - **Relationship Type**: Lookup - **Refers To**: HealthCareProcedure ### InterventionType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of intervention. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this intervention type is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the intervention type. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProcedureCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The procedure code set associated with the care intervention type. This is a polymorphic relationship field. - **Relationship Name**: ProcedureCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ## 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. [CareInterventionTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 60.0) Change events are available for the object. [CareInterventionTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareInterventionTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareInterventionTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareInterventionTypeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareLimitType Defines the characteristics of limits on benefit provision. This object is available in API version 53.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description** - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareLimitType type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the CareLimitType. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### LimitType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Source of limit on benefit provision, such as a co-insurance requirement. ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label that identifies the CareLimitType throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareLimitType’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### MetricType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the quantity used for calculating the benefit limit, such as number of visits, amount spent, or percentage of allowed expenditure. - **Possible values**: - Amount - Money - Percentage - Text ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ## 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. [CareLimitTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # CarePerformer Represents the person performing care in observations, procedure, and immunizations. This person may be a physician, the patient’s contact, or anyone who administered any sort of care to the patient in the context of the concerned care event. This object is available in API version 51.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AffiliatedOrganizationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the business account of the organization the care performer is affiliated to in the context of the care event. - **Referenced Objects**: - Account ### CareSpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the CareSpecialty record that represents the performer’s specialty. - **Referenced Objects**: - CareSpecialty ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the CarePerformer record. ### ParentRecordId - **Type**: Polymorphic master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the care observation, procedure, or immunization that this performer was involved in. - **Referenced Objects**: - PatientMedicalProcedure - CareObservation - PatientImmunization - MedicationDispense—This value is available in API version 55.0 and later. ### PersonId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References the person who performed care. - **Referenced Objects**: - Account - HealthcareProvider - User—This value is available in API version 55.0 and later. ### RoleId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the care performer's role in the care event. - **Referenced Objects**: - CodeSet - CodeSetBundle ## Usage This object is used to record the relevant details of a care performer in the context of specific care events. The performed care is connected to the procedure, observation, or immunization care event using the ParentRecordId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CarePerformerFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePerformerHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CarePerformerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # CarePgmEnrleeStatusPeriod Represents the historical changes to the status or stage of a care program enrollee. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent Care program Enrollee that's associated with the status period. This field is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Relationship Type**: Master-detail - **Refers To**: CareProgramEnrollee (the master object) ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The effective end date and time of the role. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The effective start date and time of the role. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program enrollee status period. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the enrollee. ### StatusReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the status. ## 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. [CarePgmEnrleeStatusPeriodChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CarePgmEnrleeStatusPeriodFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePgmEnrleeStatusPeriodHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CarePgmEnrolleeWkOrdStep Represents information about the step in a work order that's executed for the care program enrollee. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionPlanTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the action plan template containing the tasks related to each work order step. This field is a relationship field. - **Relationship Name**: ActionPlanTemplate - **Relationship Type**: Lookup - **Refers To**: ActionPlanTemplate ### AreAllTasksCompleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determine whether all the child tasks for the step are completed (true) or not (false). - **Default value**: false ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the end date and time for the execution of the work order step. ### IsCustodyCompleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determine whether all the custody chain entries for the step and the related tasks are completed (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Represents the name of the step associated with the care program enrollee work order record. ### ParentEnrolleeWorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents the parent work order of the care program enrollee that's associated with the step. This field is a relationship field. - **Relationship Name**: ParentEnrolleeWorkOrder - **Relationship Type**: Master-Detail - **Refers To**: CarePgmEnrolleeWorkOrder ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the sequence in which the work order step will be executed. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the start date and time for the execution of the work order step. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the execution status of the work order step. - **Possible values**: - Canceled - Completed - InProgress - NotStarted ### WorkTypeStepId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type step for which the work order step of the care program enrollee is created. This field is a polymorphic relationship field. - **Relationship Name**: WorkTypeStep - **Relationship Type**: Lookup - **Refers To**: WorkTypeStep ## 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. [CarePgmEnrolleeWkOrdStepChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CarePgmEnrolleeWkOrdStepFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. # CarePgmEnrolleeWorkOrder Represents information about the work order that's executed for the care program enrollee. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: This field represents the care program enrollee for whom the work order record is created. This field is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Relationship Type**: Master-Detail - **Refers To**: CareProgramEnrollee ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time for the execution of the care program enrollee work order. ### IsCustodyCompleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether all the custody chain entries for the work order are completed (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the work order record. ### NextWorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field represents next work order that's executed for the associated care program enrollee. This field is a relationship field. - **Relationship Name**: NextWorkOrder - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWorkOrder ### PreviousWorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The previous work order that's executed for the associated care program enrollee. This field is a relationship field. - **Relationship Name**: PreviousWorkOrder - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWorkOrder ### ServiceAppointmentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field represents the service appointment that's associated with the work type. This field is a relationship field. - **Relationship Name**: ServiceAppointment - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time for the execution of the care program enrollee work order. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: This field specifies the execution status of the care program enrollee work order. - **Possible values**: - Canceled - Completed - InProgress - NotStarted ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: This field represents work type for which the work order of the care program enrollee is created. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ## 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. [CarePgmEnrolleeWorkOrderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CarePgmEnrolleeWorkOrderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePgmEnrolleeWorkOrderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CarePgmEnrollmentEvalRslt Represents the result of an evaluation done to assess the eligibility of a participant enrolling for a research study or care program. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramEligibilityRuleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program eligibility rule that’s used to do the evaluation. This field is a relationship field. - **Relationship Name**: CareProgramEligibilityRule - **Refers To**: CareProgramEligibilityRule ### EnrolleeReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record of the object that's associated with the evaluation. This field is a polymorphic relationship field. - **Relationship Name**: EnrolleeReferenceRecord - **Refers To**: CareProgramEnrollee, ResearchStudyCandidate ### EvaluationIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier for each evaluation. ### IsLatestEvaluation - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the evaluation is the latest (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason that describes the evaluation result. ### RefRecordIdentifierList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The list of reference record identifiers for the result. ### Result - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the result of the evaluation. - **Possible values**: - InsufficientData—Insufficient Data - Match - NotMatch—Not Match ## 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. [CarePgmEnrollmentEvalRsltChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CarePgmEnrollmentEvalRsltFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePgmEnrollmentEvalRsltHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CarePgmEnrollmentEvalRsltOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CarePgmEnrollmentEvalRsltShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CarePgmProvHealthcareProvider Represents a junction object identifying the primary healthcare professional associated with a care program provider and to look up all healthcare professionals for care program providers. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the care program provider that is associated with the healthcare provider (healthcare professional). ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when this association record is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when this association record is no longer effective. ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the healthcare provider (healthcare professional) that is associated with the care program provider. ### IsPrimaryProvider - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the healthcare provider (healthcare professional) is the primary provider for the care program provider. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name for this association between a care program provider and a healthcare provider (healthcare professional). ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the system from which the record was sourced. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CarePgmProvHealthcareProviderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [CarePgmProvHealthcareProviderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePgmProvHealthcareProviderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CarePgmTeamMbrRolePeriod Represents the historical changes in the role of a care program team member. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramTeamMemberId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care program team member associated with the role. This field is a relationship field. - **Relationship Name**: CareProgramTeamMember - **Relationship Type**: Master-detail - **Refers To**: CareProgramTeamMember (the master object) ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time until when the team member is assigned the role. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the team member was assigned the role. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program team member role period. ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the role of the care program team member. - **Possible values**: - Collaborator - Contact-General - Contact-Recruitment - Funding Source - Primary Investigator - Sponsor - Sponsor-Investigator - Sponsor-Lead - Study-Chair - Study-Director - Subinvestigator # Care​Plan The Care​Plan FHIR resource maps to the Care​Plan​, Care​PlanDetail​, Care​Plan​Activity, and Care​PlanActivityDetail​ objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Care​Plan](http://hl7.org/fhir/R4/careplan.html#CarePlan) map to the fields in Salesforce. Table 1. Care​Plan - Salesforce | Care​Plan Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.M | The identifier information for a care plan is represented as Identifier records that reference the CarePlan record using their Identifier​.Parent​RecordId field​. | | instantiates​Canonical | N/A | N/A | N/A | Not supported | | instantiates​Uri | N/A | N/A | N/A | Not supported | | basedOn | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Based On as the picklist value in detailType. . | | basedOn | Care​Plan​Detail​.Detail​RecordId | Lookup: CarePlan | 0.M | Select Care Plan as the domain set in DetailRecordId. | | replaces | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Replaced Care Plan as the picklist value in detailType. . | | replaces | Care​Plan​Detail​.Detail​RecordId | Lookup: CarePlan | 0.M | Select Care Plan as the domain set in DetailRecordId. | | partOf | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Part Of as the picklist value in detailType. . | | partOf | Care​Plan​Detail​.Detail​RecordId | Lookup: CarePlan | 0.M | Select Care Plan as the domain set in DetailRecordId. | | status | Care​Plan​.Status | Picklist | 1.1 | While FHIR defines this field as a code, the Salesforce implementation is a picklist. | | intent | Care​Plan​.Authorization​Type | Picklist | 0.1 | While FHIR defines this field as a one-to-one code, the salesforce implementation is a zero-to-one picklist. | | category | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Category as the picklist value in detailType. . | | category | Care​Plan​Detail​.Detail​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.M | Select Category as the picklist value in detailType. . | | title | Care​Plan​.Name | Text | 1.1 | While FHIR defines this as a zero-to-one value, the Salesforce implementation is one-to-one.. | | description | Care​Plan​.Description | Text Area | 0.1 | N/A | | subject | Care​Plan​.ParticipantId | Lookup: Account | 1.1 | The Salesforce implementation doesn’t support Groups. | | encounter | Care​Plan​.Clinical​EncounterId | Lookup: Clinical​Encounter | 0.1 | N/A | | period | Care​Plan​.Created​Date | DateTime | 0.1 | While FHIR defines this field as a Period field, the Salesforce implementation uses a pair of DateTime fields. | | period | Care​Plan​.EndDate | DateTime | 0.1 | While FHIR defines this field as a Period field, the Salesforce implementation uses a pair of DateTime fields. | | created | Care​Plan​.Start​Date | Date | 0.1 | N/A | | author | Care​Plan​.AuthorId | Lookup: Account, Healthcare​Provider, Healthcare​Practitioner​Facility, Care​Registered​Device | 0.1 | The Salesforce implementation doesn’t support careTeam calues for this field. | | contributor | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Part Of as the picklist value in detailType. . | | contributor | Care​Plan​Detail​.Detail​RecordId | Lookup: Account, Healthcare​Provider, Healthcare​Practitioner​Facility, Care​Registered​Device | 0.M | Select an appropriate domain set for DetailRecordId. | | careTeam | CaseTeam | Object | 0.M | Create case teams for the Case record that’s the parent record of the CarePlan record. | | status​Reason | Care​Plan​.status​Reason | Text | 0.1 | N/A | | addresses | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Addressed Item as the picklist value in detailType. | | addresses | Care​Plan​Detail​.Detail​RecordId | Lookup: Health​Condition | 0.M | Select HealthCondition as the domain set for DetailRecordId. | | supporting​Info | Care​Plan​Detail​.Detail​Type | Picklist | 0.M | Select Supporting Information as the picklist value in detailType. | | supporting​Info | Care​Plan​Detail​.Detail​RecordId | Lookup: Care​Plan,Account,Healthcare​Provider,Healthcare​Practitioner​Facility,Care​Registered​Device,Health​Condition | 0.M | Select an appropriate domain set for DetailRecordId. | | goal | Goal​Assignment | Object | 0.M | Associate the Goal​Assignment record to its parent care plan using the Parent​RecordId field. | | activity | Care​Plan​Activity | Object | 0.M | The activity subset of a carePlan FHIR resource is represented in Salesforce as CarePlanActivity records that reference the care plan as its parent. | | activity​.outcome​Codeable​Concept | Care​Plan​Activity​Detail​.Detail​Type | Picklist | 0.M | Select Outcome Code as the picklist value in detailType. . | | activity​.outcome​Codeable​Concept | Care​Plan​Activity​Detail​.Detail​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.M | N/A | | activity​. | | | | | | activity​.outcome​Reference | Care​Plan​Activity​Detail​.Detail​Type | Picklist | 0.M | Select Outcome Code as the picklist value in detail​Type. . | | activity​.outcome​Reference | Care​Plan​Activity​Detail​.Detail​RecordId | Lookup: Clinical​Encounter,Patient​Medical​Procedure,Health​Condition,Care​Observation,Diagnostic​Summary,Account,Healthcare​Provider,Healthcare​Practitioner​Facility,Care​Registered​Device | 0.M | Select an appropriate domain set for Detail​RecordId. | | activity​.progress | AuthorNote | Object | 0. | Represented as Author​Note records that reference Care​Plan​Activity records as their parent. | | activity​.reference | Care​Plan​Activity​​.Reference​RecordId | Lookup: Medication​Statement,Medication​Request,Clinical​Service​Request | 0.1 | The Salesforce implementation of this field doesn’t support Appointment, Communication​Request, Device​Request, Nutrition​Order, Vision​Prescription, and Request​Group. | | activity​.reference | Care​Plan​Activity​​.Reference​TaskId | Lookup: Task | 0.1 | The Salesforce implementation implements the Task data type for this field as a separate field on the object. | | activity​.detail​.kind | Care​Plan​Activity​​.Activity​Type | Picklist | 0.1 | While FHIR defines this field as a code, the Salesforce implementation is a code. | | activity​.detail​.instantiates​Canonical | N/A | N/A | N/A | Not supported | | activity​.detail​.instantiates​Uri | N/A | N/A | N/A | Not supported | | activity​.detail​.code | Care​Plan​Activity​​.Activity​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | N/A | | activity​.detail​.reason​Code | Care​Plan​Activity​Detail​.Detail​Type | Picklist | 0.M | Select Reason Code as the picklist value in detailType. . | | activity​.detail​.reason​Code | Care​Plan​Activity​Detail​.Detail​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.M | N/A | | activity​.detail​.reason​Reference | Care​Plan​Activity​Detail​.Detail​Type | Picklist | 0.M | Select Reason Code as the picklist value in detail​Type. . | | activity​.detail​.reason​Reference | Care​Plan​Activity​Detail​.Detail​RecordId | Lookup: Health​Condition,Care​Observation,Diagnostic​Summary | 0.M | Select an appropriate domain set for Detail​RecordId. | | activity​.detail​.goal | Goal​Assignment | Object | 0.M | Associate the Goal​Assignment record to its parent care plan activity using the Parent​RecordId field. | | activity​.detail​.status | Care​Plan​Activity​​.Status | Picklist | 0.1 | While FHIR defines this field as a one-to-one code, the Salesforce implementation is a zero-to-one picklist. | | activity​.detail​.status​Reason | Care​Plan​Activity​​.Status​Reason​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | N/A | | activity​.detail​.do​Not​Perform | Care​Plan​Activity​​.Prohibited​Activity | Picklist | 0.1 | The Salesforce implementation is a picklist with the values Default, True, and False. | | activity​.detail​.scheduled​Timing | Care​Plan​Activity​​.Activity​TimingId | Lookup: Activity​Timing | 0.1 | N/A | | activity​.detail​.scheduled​Period | Care​Plan​Activity​​.Scheduled​Period​Start​Date​Time | DateTime | 0.1 | The Salesforce implementation uses a pair of DateTime fields instead of a period field. | | activity​.detail​.scheduled​Period | Care​Plan​Activity​​.Scheduled​Period​End​Date​Time | DateTime | 0.1 | The Salesforce implementation uses a pair of DateTime fields instead of a period field. | | activity​.detail​.scheduled​String | Care​Plan​Activity​​.Schedule​​Description | Text | 0.1 | N/A | | activity​.detail​.location | Care​Plan​Activity​​.LocationId | Lookup: Location, Healthcare​Facility | 0.1 | N/A | | activity​.detail​.performer | Care​Plan​Activity​Detail​.Detail​Type | Picklist | 0.M | Select Reason Code as the picklist value in detail​Type. . | | activity​.detail​.performer | Care​Plan​Activity​Detail​.Detail​RecordId | Lookup: Account,Healthcare​Provider,Healthcare​Practitioner​Facility,Care​Registered​Device | 0.M | Select an appropriate domain set for Detail​RecordId. The Salesforce implementation doesn’t support care​Team and health​Service values for this field. | | activity​.detail​.product​Codeable​Concept | Care​Plan​Activity​​.Administered​Product​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | N/A | | activity​.detail​.product​Reference | Care​Plan​Activity​​.Administered​Product​Id | Lookup: Medication | 0.1 | N/A | | activity​.detail​.daily​Amount | Care​Plan​Activity​​.Daily​Dose​Quantity | Number | 0.1 | Salesforce implements the quantity data type as a pair of number and unit fields. | | activity​.detail​.daily​Amount | Care​Plan​Activity​​.Daily​Dose​UnitId | Lookup: Unit​Of​Measure | 0.1 | Salesforce implements the quantity data type as a pair of number and unit fields. | | activity​.detail​.quantity | Care​Plan​Activity​​.Supplied​Quantity | Number | 0.1 | Salesforce implements the quantity data type as a pair of number and unit fields. | | activity​.detail​.quantity | Care​Plan​Activity​​.Supplied​Quantity​UnitId | Lookup: Unit​Of​Measure | 0.1 | Salesforce implements the quantity data type as a pair of number and unit fields. | | activity​.detail​.description | Care​Plan​Activity​​.Description | Text | 0.1 | N/A | | note | AuthorNote | Object | 0. | Represented as Author​Note records that reference Care​Plan records as their parent. | # CarePreauth Represents the details of preauthorizations for care under a member’s plan. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this preauthorization is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date after which this preauthorization is no longer effective. ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the member plan for which this preauthorization is being provided. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of this preauthorization. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes about this preauthorization. ### PayerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the payer covering the cost of this treatment. ### PreauthIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An identifier provided by the insurance company for preauthorization of a service. ### ReferringPhysician - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the doctor who referred the member for this treatment. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this preauthorization record was obtained from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this preauthorization record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this preauthorization was last changed on its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of this preauthorization record. The default the picklist - **Possible values**: - Active - Inactive ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CarePreauthChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CarePreauthFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePreauthHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CarePreauthOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CarePreauthShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CarePreauthItem Represents the details of items included in a preauthorization for care under a member’s plan. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### CarePreauthId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the care preauthorization this item details. ### EndingServiceCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ending service code for the category of care being provided. ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Laterality - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The side of the body receiving care. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of this preauthorized care item. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes about this preauthorized care item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PreauthitemSequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sequence of this item among the preauthorized care items. ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Quantity being preauthorized. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this preauthorization record was obtained from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this preauthorization record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this preauthorization was last changed on its source system. ### StartingServiceCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The starting service code for the category of care being provided. ### Unit - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Units by which the preauthorized quantity is measured. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CarePreauthItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CarePreauthItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CarePreauthItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CarePreauthItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CarePreauthItemShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgram Represents a set of activities, such as a patient therapy, financial assistance, education, wellness, or fitness plan, offered to participants by an employer or insurer. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActiveSiteCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of active sites for conducting the research study. This field is available in API version 64.0 and later when Site Management is enabled. ### AnnounceDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the provider engagement compliance program becomes available to users. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### BudgetAmount - **Type**: Currency - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Approved budget for the care program. ### CancelDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the provider engagement compliance program cancels. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### CareProgramName - **Type**: Text - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the care program. ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the category of the care program. - **Possible values**: - AdvancedTherapy - Patient Services (This field is available with Patient Program Outcome Management permission set in API version 62.0 and later.) - ProviderEngagementCompliance - TrialManagement (This field is available for the Participant Management feature in API version 61.0 and later.) ### CurrentEnrolleeCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of enrollees who have joined the care program to date. This field is available for the Participant Management feature in API version 61.0 and later. ### Description - **Type**: Long Text Area - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A short description explaining the program. ### EndDate - **Type**: Date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Program termination date. ### ExtensionEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the extended provider engagement compliance cycle ends. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### EnrollmentDurationMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the participant enrollment duration. This field is available in API version 64.0 and later when Site Management is enabled. This field is a relationship field. - **Relationship Name**: EnrollmentDurationMeasure - **Refers To**: UnitOfMeasure ### EnrollmentRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The rate of the participant enrollment at the site. This is calculated by dividing the target enrollment count by the target enrollment duration and the number of planned sites. This field is available in API version 64.0 and later when Site Management is enabled. ### FirstSiteClosedOutDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the first site is closed out. ### FirstSiteActivatedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the first site is activated for conducting research studies. This field is available in API version 64.0 and later when Site Management is enabled. ### LastSiteActivatedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the last site is activated for conducting research studies. This field is available in API version 64.0 and later when Site Management is enabled. ### LastSiteClosedOutDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the last site is closed out. This field is available in API version 64.0 and later when Site Management is enabled. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### ModificationEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until which users can edit activities related to the provider engagement compliance program. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the provider engagement compliance program. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentProgram - **Type**: Lookup(Care Program) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of another program that this program is a part of, if any. ### ProgramSponsor - **Type**: Lookup(Account) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the third-party program sponsor, if any. ### PreCycleStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the provider engagement compliance pre cycle starts. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### PreferredContactPointType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the preferred contact point type used to complete the provider engagement compliance cycle. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. This field extends the standard CareProgram object to represent a compliance program to support the post-market regulatory process. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### StartDate - **Type**: Date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective start date of the program. ### Status - **Type**: Pick list - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the program. - **Default value**: New - **Possible values**: - Canceled - Completed - In Progress - New ### TargetEnrollmentDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration in which the enrollment for the targeted number of participants must be completed. This field is available in API version 64.0 and later when Site Management is enabled. ### TargetEnrolleeCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The target enrollee count of the care program. This field is available for the Participant Management feature in API version 61.0 and later. ### TargetSiteCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of sites planned for conducting the research study. This field is available in API version 64.0 and later when Site Management is enabled. ## 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. [CareProgramChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramAssistance Represents a junction between Care Program and Program objects. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The care program associated with the care program assistance. This field is a relationship field. - **Relationship Name**: CareProgram - **Relationship Type**: Master-detail - **Refers To**: CareProgram (the master object) ### CareProgramProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program product associated with the care program assistance. This field is a relationship field. - **Relationship Name**: CareProgramProduct - **Refers To**: CareProgramProduct ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program assistance. ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The program associated with the care program assistance. This field is a relationship field. - **Relationship Name**: Program - **Refers To**: Program # CareProgramCampaign Represents a relationship between the Care Program object and the Campaign object. This junction object enables admins to associate one or more campaigns to a program. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(),  getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CampaignId - **Type**: Lookup(Campaign) - **Properties**: Create, Filter, Group, Sort - **Description**: The campaign associated to the care program. ### CareProgram - **Type**: Master-Detail(Care Program) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the care program. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: A short name for the care program campaign. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the care program campaign was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the care program campaign record. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareProgramCampaignChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [CareProgramCampaignFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramCampaignHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareProgramDetail Represents the detail records related to the care program. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The care program that the specified detail is related to. This field is a relationship field. - **Relationship Name**: CareProgram - **Relationship Type**: Master-detail - **Refers To**: CareProgram (the master object) ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The detail of the specified type, associated with the specified care program. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: CodeSet, CodeSetBundle, OmniProcess ### DetailSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The subtype of the care program detail. ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of detail specified in the Detail Record field for the specified care program. - **Possible values**: - CarePlanTemplate—Care Plan Template - ClassificationCode—Classification Code - ConditionCode—Condition Code - Focus - KeywordCode—Keyword Code - Label - OmniProcess—Omni Process - RegionCode—Region Code - Result - StudyDesignCode—Study Design Code ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program detail. ## 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. [CareProgramDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CareProgramDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareProgramEligibilityRule Represents a rule defining the criteria for patient care program enrollment eligibility. This entity creates an association between Care Program and an Enrollment Eligibility Criteria. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Identifier of a care program. Represents a set of activities, such as therapy, wellness, or a fitness plan, offered to participants by a healthcare provider, life sciences organization, employer, or insurer. ### EligibilityCriteriaId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Criteria that define patient enrollment eligibility for a care program. ### IsInclusionRule - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the rule is included or excluded when determining care program eligibility. This field is available in API version 62.0 and later. - **Default value**: false ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the care program eligibility rule is required. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: Name for the care program eligibility rule. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the eligibility rule is in force or not. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the eligibility Rule. This field is available for the Participant Management feature in API version 61.0 and later. - **Possible values**: - Inclusion Rule - Exclusion Rule - Age Rule - Gender Rule ## 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. [CareProgramEligibilityRuleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramEligibilityRuleFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramEligibilityRuleHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramEligibilityRuleOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramEligibilityRuleShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramEnrollee Represents a participant enrolled in a care program. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: Lookup(Account) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person Account representing the enrollee ### BenefitCoverageType - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the coverage status of the enrollee under both Medicare and Medicaid. - **Possible values**: - ContinuedEnrollee - NewEnrollee ### CareProgramId - **Type**: Master-Detail(Care Program) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Look up for Care Program. ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical service request associated with the care program enrollee. This field is a relationship field and is available in API version 60.0 and later. - **Relationship Name**: ClinicalServiceRequest - **Relationship Type**: Lookup - **Refers To**: ClinicalServiceRequest ### CurrentWorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order that's currently being executed for the care program enrollee. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 58.0 and later. - **Relationship Name**: CurrentWorkOrder - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWorkOrder ### CurrentWorkOrderStepId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order step that's currently being executed for the care program enrollee. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 58.0 and later. - **Relationship Name**: CurrentWorkOrderStep - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWkOrdStep ### EnrolledAtId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The site, location, or territory where the enrollee enrolled in the care program. This field is available in API version 64.0 when Site Management is enabled. This field is a polymorphic relationship field. - **Relationship Name**: EnrolledAt - **Refers To**: CareProgramSite ### EnrolleeType - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the enrollee is a new enrollee or a continued enrollee. - **Possible values**: - Dual - FullBenefitDual - NonDual - PartialBenefitDual ### EnrollmentLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory where an advanced therapy care program is executed. This field is a relationship field and is available for the Advanced Therapy Management feature in API version 59.0 and later. - **Relationship Name**: EnrollmentLocation - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### FlowInterviewId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Runtime instance of the associated flow. This field is a relationship field. - **Relationship Name**: FlowInterview - **Refers To**: FlowInterview ### FlowOrchestrationInstanceId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Runtime instance of the associated flow orchestration. This field is a relationship field. - **Relationship Name**: FlowOrchestrationInstance - **Refers To**: FlowOrchestrationInstance ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a participant enrolled in a care program is active (true) or not (false). ### IsPatientInLtrmCareFacility - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient was at a long-term healthcare facility during outreach or enrollment to the care program. This field is available for the Medication Management feature in API version 56.0 and later. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### LeadId - **Type**: Lookup(Lead) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lead representing the enrollee. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the enrollee. ### OptOutPeriodEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the patient’s opt-out from the care program ends. This field is available in API version 56.0 and later. ### OptOutPeriodStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date that the patient opted out of the care program. This field is available in API version 56.0 and later. ### OptOutReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the patient opted out of the care program. This field is available in API version 56.0 and later. ### ResearchStudyCandidateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related Research Study Candidate record of the care program enrollee. This field is a relationship field. - **Relationship Name**: ResearchStudyCandidate - **Refers To**: ResearchStudyCandidate ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The UserId for the record owner. This field is a polymorphic relationship field. This field is available in API version 58.0 and later. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the enrollee record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the enrollee record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the enrollee. - **Possible values**: - Active - Inactive ### UserId - **Type**: Lookup(User) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User representing the enrollee. ## 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. [CareProgramEnrolleeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramEnrolleeFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramEnrolleeHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramEnrolleeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 58.0) Sharing rules are available for the object. [CareProgramEnrolleeShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 58.0) Sharing is available for the object. # CareProgramEnrolleeProduct Represents the affiliation between a care program enrollee and a care program product, a care program provider, or both. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care program enrollee associated with this care program product or care program provider. ### CareProgramProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program product associated with this care program enrollee and care program provider. ### CareProgramProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program provider associated with this care program enrollee and care program product. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the product the enrollee participates in. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The program that offers financial assistance for this product. This field is a relationship field. This field is available in API version 62.0 and later with the Manage Financial Assistance Program permission set. - **Relationship Name**: Program - **Refers To**: Program ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the care program product or service related to the care program provider and the recipient of the product or service. - **Default value**: Available - **Possible values**: - Available - Canceled - Declined - Offered - Received ## 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. [CareProgramEnrolleeProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramEnrolleeProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramEnrolleeProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramEnrolleeProductOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramEnrolleeProductShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramEnrollmentCard Represents a care program membership card that includes a membership number or enrollment code. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CardNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique card number for a care program. Often a membership number or enrollment code on a physical card assigned to the care program enrollee. ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care program enrollee with whom this care program card is associated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: Name for the care program enrollment card. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a card in relation to a care program enrollee. ## 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. [CareProgramEnrollmentCardChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramEnrollmentCardFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramEnrollmentCardHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramEnrollmentCardOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramEnrollmentCardShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramGoal Represents a business or clinical goal related to a care program. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care program associated with a corresponding goal. ### CompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The completion date of a care program goal. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A detailed description of the care program goal. ### DueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The due date for a care program goal. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: Name of the care program goal. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the care program goal. ### ProgressPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage completion of the care program goal. ### SequenceNumber - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The order or sequence of the care program goal relative to other care program goals. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date for a care program goal. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a care program goal. - **Default value**: New - **Possible values**: - Canceled - Completed - In Progress - New - Not Started ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the care program goal. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareProgramGoalChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [CareProgramGoalFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramGoalHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramGoalOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramGoalShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramProduct Represents the affiliation between a care program and a care program product, care program provider, or both. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Availability - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The default availability of the product to an enrollee in the context of a care program. For example, some products or services are available to all enrollees, others are limited to special circumstances, and others are no longer available. ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier for the care program associated with a care program product. ### CareProgramPrice - **Type**: currency - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A standard list price for a given product in the context of a care program. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Group, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the care program product. ### OwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the user who owns this record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier of the product associated with a care program ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the care program product was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the care program product was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the product in the context of a care program. ## 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. [CareProgramProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramProductOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramProductShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramProvider Represents a business account that is the service provider for a care program product. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account/business entity that is providing the care program product/service to a care program enrollee. ### CareProgramContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary person a patient can contact about the care program. ### CareProgramProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program product to which this care program provider is associated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the provider associated with the care program. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### Role - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of organization delivering the services included in the program. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of a care program provider in relation to a care program product. ## 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. [CareProgramProviderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramProviderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramProviderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProgramProviderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramProviderShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramSite Represents the details about the care program site. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActlFirstPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first participant was enrolled in the study at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlFstPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first enrolled participant at the site had their initial study visit, as specified in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlFstPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first enrolled participant at the site completed their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the last participant was enrolled in the study at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### ActualPtcpEnrollmentCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual number of participants that are enrolled for the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ActualPtcpEnrollmentDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual number of days spent enrolling participants at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ActualPtcpEnrollmentRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual rate of participant enrollment at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the last enrolled participant at the site had their initial study visit, as defined by the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the last enrolled participant at the site completed their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program associated with the research study that's conducted at the specified site. This field is a relationship field. - **Relationship Name**: CareProgram - **Refers To**: CareProgram ### ClnclTrialAgreeSignedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the clinical trial agreement for the site was signed. This field is available in API version 64.0 and later when Site Management is enabled. ### ClnclTrialAgreeTrnarndDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The time taken to execute the clinical trial agreement. This field is available in API version 62.0 and later when Site Management is enabled. ### ForcstFirstPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the first participant enrolls in the study at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstFstPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the first enrolled participant at the site has their initial study visit, such as a screening or a baseline visit. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstFstPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The initially projected date when the first enrolled participant at the site completes their final scheduled study visit, as defined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the final participant enrolls in the study at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the last enrolled participant at the site has their initial study visit, as defined by the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The initially projected date when the last enrolled participant at the site completes their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### HealthCareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health care facility associated with the care program site. This field is a relationship field. - **Relationship Name**: HealthCareFacility - **Refers To**: HealthcareFacility ### InvestigatorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The investigator who is responsible for conducting the research study at the healthcare facility. This field is available in API version 63.0 and later when Site Management is enabled. This field is a relationship field. - **Relationship Name**: Investigator - **Refers To**: HealthcareProvider ### InvtglProductReleaseDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days between the start of the site activation process to the release of the investigational product at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location associated with the care program site. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the care program site. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PlannedPtcpEnrollmentRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The planned rate of participant enrollment, based on the estimates by the investigator at the site. ### PredictedPtcpEnrollmentRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The predicted rate of participant enrollment at the site. ### ProjectedPtcpEnrlCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of participants that are expected to enroll for the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ProjectedPtcpEnrlDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected number of days to enroll participants at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ProtocolDeviationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of protocol deviations reported during the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### QualVstToInitVstDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days between the site qualification visit and site initiation visit. This field is available in API version 62.0 and later when Site Management is enabled. ### RandomizedParticipantCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of participants randomly assigned to different study groups at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### RegulatoryDocTurnaroundDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The turnaround time for the preparation of the regulatory documents for IRB or the ethics committee submission. This field is available in API version 62.0 and later when Site Management is enabled. ### ResearchStudyId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The research study associated with the care program site. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Refers To**: ResearchStudy ### RsrchStudyCmplPtcpCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of participants who completed the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ScreenedParticipantCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of participants screened for the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### SeriousAdverseEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of serious adverse events reported during the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### SiteActivatedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the site was activated for the research study. This field is available in API version 64.0 and later when Site Management is enabled. ### SiteClosedOutDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the site was closed out for the research study. This field is available in API version 64.0 and later when Site Management is enabled. ### SiteIdentifiedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the site was identified for the feasibility for conducting research study. This field is available in API version 64.0 and later when Site Management is enabled. ### SiteActvToFirstPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days between the site activation and the first participant visit to the site. This field is available in API version 62.0 and later when Site Management is enabled. ### SiteActvToLastPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days between the site activation and the last participant visit to the site. This field is available in API version 62.0 and later when Site Management is enabled. ### SponsorRepresentativeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The representative of the sponsor for the site during the research study. This field is available in API version 62.0 and later when Site Management is enabled. This field is a relationship field. - **Relationship Name**: SponsorRepresentative - **Refers To**: Contact ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the care program site. - **Possible values**: - Inactive - Recruitment Closed - Recruitment Ongoing - Trial Completed - Trial Ongoing - Trial Upcoming ### TeamId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The team associated with the care program site. This field is a relationship field. - **Relationship Name**: Team - **Refers To**: Team ### UnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for selected duration. This field is available in API version 62.0 and later when Site Management is enabled. This field is a relationship field. - **Relationship Name**: UnitOfMeasure - **Refers To**: UnitOfMeasure ## 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. [CareProgramSiteOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProgramSiteShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProgramSiteContract Represents the association of a care program site and a contract. This object is available in API version 62.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramSiteId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care program site associated with the record that the sponsor intends to engage through a contract. This field is a relationship field. - **Relationship Name**: CareProgramSite - **Relationship Type**: Master-detail - **Refers To**: CareProgramSite ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The contract associated with the record between the sponsor and the care program site. This field is a relationship field. - **Relationship Name**: Contract - **Refers To**: Contract ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program site contract. # CareProgramStatusPeriod Represents the historical changes to the status of a care program. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AreDatesTentative - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the period dates are actual or expected. - **Default value**: false ### CareProgram - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care program associated with the status. This field is a relationship field. - **Relationship Name**: CareProgram - **Relationship Type**: Master-detail - **Refers To**: CareProgram (the master object) ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the period when the specified status was in effect for the specified care program. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date and time of the period when the specified status was in effect for the specified care program. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care program status period. ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the care program was assigned the status. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the care program. ## 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. [careprogramstatusperiodChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [careprogramstatusperiodFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [careprogramstatusperiodHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareProgramTeamMember Represents a person who delivers services under a program, such as a program manager or care coordinator. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(),  getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: Lookup(Account) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person account representing the team member. ### CareProgramId - **Type**: Master-Detail(CareProgram) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup for the care program. ### Category - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the category that the member belongs to. This field is available for the Participant Management feature in API version 61.0 and later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MemberId - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The team member associated with the care program team member. This field is available for the Participant Management feature in API version 61.0 and later. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the care program team member. ### Role - **Type**: Picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Role of the team member. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### UserId - **Type**: Lookup(User) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User representing the team member. ## 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. [CareProgramTeamMemberChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CareProgramTeamMemberFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProgramTeamMemberHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareProviderAdverseAction Captures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account this adverse action is associated with. ### AccreditationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The accreditation that might be affected by this adverse action. ### ActionIssueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the adverse action was issued by the regulatory authority. ### ActionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of adverse action that is being taken. - **Possible values**: - AdministrativeDisciplinaryAction - CourtOrder - FelonyConviction - MalpracticeJudgement - MisdemeanorConviction - ProbationaryLicense ### BoardCertificationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The board certification that might be affected by this adverse action ### BusinessLicenseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business license that might be affected by this adverse action. ### CaseNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case number associated with this adverse action. ### CourtSentence - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The final sentence by the governing court, if any. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Summary of the adverse action. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this Adverse Action is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this Adverse Action is no longer effective. ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: HealthcareProvider that this Adverse Action is associated with ### IncidentDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the incident took place that resulted in the adverse action. ### IncidentReportedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which the incident was reported to the regulatory authority. ### InsurancePolicyNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of the insurance policy associated with an adverse action. ### InsuranceProviderName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the insurance provider that issued the policy associated with an adverse action. ### Jurisdiction - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the court or goverment body that issued the legal determination. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the adverse action that is being taken. ### PenaltyAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The penalty amount imposed for an adverse action. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Time stamp that indicates when the current user last viewed this record. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The practitioner this adverse action record is associated with. ### RegulatoryBody - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the regulatory authority to which the incident was reported. ### RegulatoryBodyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of regulatory authority to which the incident was reported. ### ReportingEntity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the entity or organization that reported this action. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique record ID in source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the license or certification, such as "revoked" or "suspended." - **Possible values**: - Active - Revoked - Suspended ## 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. [CareProviderAdverseActionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CareProviderAdverseActionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProviderAdverseActionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CareProviderAfflRoleConfig Represents information about the affiliations of the healthcare provider. For example, this object represents an affiliation between a healthcare provider and a hospital. This object is available in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### AffiliationType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Required. Specifies the affiliation of the configuration. This field is unique within your organization. - **Possible values**: - HospitalAffiliation ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareProviderAfflRoleConfig type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the Care Provider Affiliation Role Configuration. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label for the affiliation. In the UI, this field is Care Provider Affiliation Role Configuration. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareProviderAfflRoleConfig’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### ProviderRole - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. The role of the healthcare provider in relation to the affiliate. # CareProviderFacilitySpecialty Represents all the specialties that the practitioner provides at a given location. For example, a physician who is board-certified in both spine and neuro may provide spine services at one location and neuro services at another. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Facility associated with this provider facility specialty record. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this record is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this record is no longer effective. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the healthcare facility associated with the specialty. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. This field is a relationship field. - **Relationship Name**: HealthcareFacility - **Refers To**: HealthcareFacility ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### IsPrimarySpecialty - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this specialty is the practitioner's primary specialty at this facility, or the facility's primary specialty. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the specialty provided at this provider facility. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PractitionerFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner facility associated with this provider facility specialty record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ### SpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the specialty associated with this provider facility specialty record ### SpecialtyRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Role of the specialty for the provider or practitioner. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareProviderFacilitySpecialtyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CareProviderFacilitySpecialtyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareProviderFacilitySpecialtyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareProviderFacilitySpecialtyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareProviderFacilitySpecialtyShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareProviderSearchableField This object holds denormalized data from certain fields in the Provider Relationship Management data model. Provider search APIs query this object instead of multiple objects, which improves search performance. This object is available in API version 47.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Fields ### Address - **Type**: textarea - **Properties**: Nillable - **Description**: Specified in Account.ShippingAddress. ### CertificationType - **Type**: textarea - **Properties**: Nillable - **Description**: Specified in BoardCertification.CertificationType. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note BoardCertification.HealthcareProvider must also be specified. ### Condition - **Type**: textarea - **Properties**: Nillable - **Description**: The conditions represented by the problem definitions that the healthcare provider offers treatment for. ### EducationLevel - **Type**: textarea - **Properties**: Nillable - **Description**: Specified in PersonEducation.EducationLevel. Not applicable for a facility. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Degree, Status, DegreeEarner, and HealthCareProvider must also be specified. ### FacilityId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Represents the facility with which the practitioner is associated. Use for practitioner records only. If the provider is a facility, set this field value to null. ### FacilityName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specified in Account.Name. ### FacilityPhone - **Type**: phone - **Properties**: Filter, Group, Nillable, Sort - **Description**: Facility's main contact phone number. Specified in Account.Phone. ### IsAcceptingNewPatients - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the practitioner is accepting new patients. Specified in HealthcareFacilityNetwork.PanelStatus, where PanelStatus = Open indicates Accepting New Patients = true. The default value is false. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note This field applies only to practitioners, not facilities. ### IsUpdateNeeded - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether a change to data in a healthcare provider record or a related record requires a data sync (true) or not (false). The default value is false. ### LanguagesSpoken - **Type**: textarea - **Properties**: Nillable - **Description**: The languages spoken by the person. Specified in PersonLanguage.Language. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### LicenseJurisdictionCountry - **Type**: String - **Properties**: Filter, Nillable - **Description**: The country where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionCountry. This field is available in API version 57.0 or later. ### LicenseJurisdictionRegion - **Type**: String - **Properties**: Filter, Nillable - **Description**: The region where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionRegion. This field is available in API version 57.0 or later. ### LicenseJurisdictionState - **Type**: String - **Properties**: Filter, Nillable - **Description**: The state where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionState. This field is available in API version 57.0 or later. ### LicenseName - **Type**: String - **Properties**: Filter, Nillable - **Description**: The name of the license associated with the Healthcare Provider. Specified in BusinessLicense.Name. This field is available in API version 57.0 or later. ### LicenseStatus - **Type**: String - **Properties**: Filter, Nillable - **Description**: Specifies the status of the license given to the Healthcare Provider. Specified in BusinessLicense.Status. This field is available in API version 57.0 or later. ### NationalProviderIdentifier - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Provider’s unique NPI number. Specified in HealthcareProviderNpi.Account for a facility, and HealthcareProviderNpi.Practitioner for a practitioner. ### OperatingHoursId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Identifies a set of operating hours for this practitioner at this facility. Specified in Account.OperatingHoursId for a facility, or in HeathcarePractitionerFacility.OperatingHoursId for a practitioner-facility combination. ### PhotoUrl - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The URL for a photograph of the practitioner. Field is synced based on Account-PhotoUrl or Contact.PhotoUrl. ### PlanType - **Type**: textarea - **Properties**: Nillable - **Description**: The type of plan, with the following default options: - PPO - HMO - Medicare - Medicaid - Workers Comp Specified in HealthcareFacilityNetwork.Account for a facility, or HealthcareFacilityNetwork.PractitionerFacility for a practitioner-facility combination. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note HealthcareFacilityNetwork.Name and PayerNetwork.Name must also be populated. ### ProviderGender - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The gender of the HealthcareProvider. Specified in Contact.Gender or Account.PersonGender. ### ProviderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Lookup to HealthcareProvider. Represents a facility or practitioner-facility combination. ### ProviderName - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: Name of the provider. Specified in Account for a facility, or in Contact for a practitioner. ### ProviderType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Type of provider or facility. For example, a pharmacist or an ambulatory care facility. Specified in HealthCareProvider.ProviderType. ### Service - **Type**: textarea - **Properties**: Nillable - **Description**: The list of services that the healthcare provider offers. ### ServiceCode - **Type**: textarea - **Properties**: Nillable - **Description**: The list of codes associated with the service that the healthcare provider offers. ### Specialty - **Type**: textarea - **Properties**: Nillable - **Description**: Specialty associated with the provider. Specified in CareSpecialty.SpecialtyType. For a facility, the Specialty is sourced from a Care Provider Facility Specialty record, which connects a facility (CareProviderFacilitySpecialty.AccountId) to a care specialty (CareProviderFacilitySpecialty.SpecialtyId). For a practitioner, the Specialty is sourced from a Care Provider Facility Specialty record, which connects a Healthcare Practitioner Facility record (CareProviderFacilitySpecialty.PractitionerFacilityId) to a care specialty (CareProviderFacilitySpecialty.SpecialtyId). The Healthcare Practitioner Facility record then connects the facility (HealthcarePractitionerFacility.AccountId) to a practitioner (HealthcarePractitionerFacility.PractitionerId). All source records must be active. ### SubSpecialty - **Type**: textarea - **Properties**: Nillable - **Description**: Provider's subspecialty. Specified in HealthcareProviderTaxonomy.TaxonomyType. Not valid for a practitioner-facility combination. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Taxonomy.TaxonomyType must also be specified. ### SyncLogRecord - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The provider search sync log record that shows the data sync status of a healthcare provider record. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareProviderSearchableFieldChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # CareProviderSearchConfig Represents fields that can appear in provider search results. Use this object to specify fields in arbitrary objects (source) that are made available in the search object (target). This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this configuration is active. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language that the care provider search uses. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### MappedObject - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates mapped objects. - **Possible values**: - HealthcarePractitionerFacility - HealthcareProvider ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the care provider. ### SourceField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field that is copied to the target object. ### TargetField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field to copy the data to. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareProviderSearchConfigChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # CareProviderSearchConfig Represents fields that can appear in provider search results. Use this object to specify fields in arbitrary objects (source) that are made available in the search object (target). This object is available in API version 48.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareProviderSearchConfig type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this configuration is active. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the CareProviderSearchConfig. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### MappedObject - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the mapped objects where searches for providers are run. - **Default value**: HealthcareProvider - **Possible values**: - HealthcarePractitionerFacility - HealthcareProvider ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label that identifies the CareProviderSearchConfig throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareProviderSearchConfig’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### SourceField - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The API name of the field that is copied to the target object. ### TargetField - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The API name of the field in the target object where data copied from SourceField is pasted. # CareRegisteredDevice Represents a device or device registration information for a patient or a care program enrollee. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for CareRegisteredDevice in Other Objects In addition to creating a record using these fields, you can add more details to your CareRegisteredDevice record by creating records in certain other objects, and referencing your CareRegisteredDevice record as the parent record. Here’s the list of objects you can associate to CareRegisteredDevice in this way, the type of information they add, and the field they use to reference CareRegisteredDevice. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the CareRegisteredDevice record. This identifier is not the same as the device’s UID. | ParentRecordId | # CareRequestConfiguration Represents the details for a record type such as service request, drug request, or admission request. One or more record types can be associated with a care request. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### CareRequestRecordType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The record type for the care request. ### CareRequestRecords - **Type**: multipicklist - **Properties**: Filter, Nillable - **Description**: The list of available objects used to configure the care request. The possible values are: - **Possible values**: - CareDiagnosis - CareRequestDrug - CareRequestExtension - CareRequestItem ### CareRequestType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Type of care request. For example, an appeal, a service request, or an admission. - **Possible values**: - Admission - Appeal - Complaint - Concurrent Review - Drug Request - Grievance - Referral - Service Request ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareRequestConfiguration type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this configuration is active. - **Default value**: false ### IsDefaultRecordType - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this is the default record type. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the CareRequestConfiguration. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label that identifies the CareRequestConfiguration throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareRequestConfiguration’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. # CareService Represents a healthcare treatment, service, or procedure offered by a provider, practitioner, or facility. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the healthcare service. ### IsAppointmentRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an appointment is required for access to this service (true) or not required (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the healthcare service offered by the provider. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ReferralMethods - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the referral method for the service. ### ServiceProvision - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the conditions under which the service is provided. . - **Possible values**: - Free - Discount Available - Fees Apply ## 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. [CareServiceHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareServiceOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CareServiceShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CareSiteIstgrSearchableFld Represents information about the clinical trial investigator associated with a site. This object is available in API version 63.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActiveStudyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of active research studies performed by the investigator for a specialty. ### AverageActualPtcpEnrlDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average actual number of days for enrollment of participants at the site. ### AverageOpdPatientCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average count of the patients who visit the OPD at the healthcare facility. ### AvgActualPtcpEnrlCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of participants who enrolled for the research study at the site. ### AvgClnclTrialAgreeDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average time taken to execute the clinical trial agreement. ### AvgInvtglProductReleaseDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the start of the site activation process to the release of the investigational product at the site. ### AvgQualVstToInitVstDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site qualification visit and site initiation visit. ### AvgRgltyDocTrnarndDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average turnaround time for the preparation of the regulatory documents for Institutional Review Board (IRB) or the Ethics Committee (EC) submission. ### AvgSiteActvToFstPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site activation and the first participant visit to the site. ### AvgSiteActvToLastPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site activation and the last participant visit to the site. ### CompletedStudyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of research studies completed by the investigator for a specialty. ### HealthcareFacilityCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the healthcare facility is located. ### HealthcareFacilityClsfn - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The classification of the healthcare facility, such as Previous Partner, Key opinion Leader, and New Member. ### HealthcareFacilityCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the healthcare facility is located. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The healthcare facility associated with the site investigator. This field is a relationship field. - **Relationship Name**: HealthcareFacility - **Refers To**: HealthcareFacility ### HealthcareFacilityName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the healthcare facility associated with the site investigator. ### HealthcareFacilitySpecialty - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The healthcare specialty associated with the healthcare facility. ### HealthcareFacilityState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state where the healthcare facility is located. ### HealthcareFacilityType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the healthcare facility associated with the site investigator, such as Government. ### HlthcrFacilRsrchStudyExprc - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total years of experience of the healthcare facility in conducting research studies. ### InvestigatorClassification - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The classification of the investigator, such as Previous Partner, Key Opinion Leader, and New Member. ### InvestigatorId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The investigator who conducts the research study at the healthcare facility. This field is a relationship field. - **Relationship Name**: Investigator - **Refers To**: HealthcareProvider ### InvestigatorName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the investigator who conducts the research study at the healthcare facility. ### InvestigatorTherapeuticArea - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The therapeutic areas that an investigator specializes in, for example, Oncology and Cardiology. ### InvestigatorType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the investigator who conducts the research study at the healthcare facility, such as Investigator or Sub investigator. ### InvtglProdtDestructionCpbl - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The type of investigational product disposal capability. ### InvtglProdtPreparationCpbl - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Specifies the list of handling equipment available at the facility for the investigational product. ### InvtglProductStorageCpbl - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The features of the investigational product storage available at the healthcare facility. ### IsAfflWithSiteMgmtOrg - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare facility is affiliated to a site management organization (true) or not (false). - **Default value**: false ### IsHealthcareFacilAcrdtAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare facility is accredited to a healthcare accreditation body (true) or not (false). - **Default value**: false ### IsIstgrLicenseAvailable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the investigator has a license to conduct clinical trials (true) or not (false). - **Default value**: false ### IsIstgrPublicationAvailable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the investigator has published articles related to the research study (true) or not (false). - **Default value**: false ### IsSatelliteSiteAssociated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether satellite sites are associated with the healthcare facility (true) or not (false). - **Default value**: false ### LaboratoryCapability - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The imaging and the non-imaging laboratory capabilities in the healthcare facility, such as X-ray and blood tests. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the care site investigator searchable field. ### OverallFacilityScore - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The overall score for the healthcare facility based on criteria such as facility experience and licenses. ### OverallInvestigatorScore - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The overall score of the investigator based on criteria, such as experience and licenses. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the care site investigator searchable field record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PatientAgeRange - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The age range of the patients at the healthcare facility. ### SuppInvtglProductType - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The type of investigational product supported at the healthcare facility. ### SupportedStudyPhase - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The phases of the research study that are supported at the healthcare facility. ### SupportedStudyType - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The type of research study supported at the healthcare facility. # CareSpecialty Represents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Typestring** - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the specialty. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this specialty is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this specialty is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup Sort, Update - **Description**: Name of the specialty master record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### SpecialtyCode - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Code for the specialty. ### SpecialtyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of care specialty. ### SpecialtyUsage - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether this specialty is related to the practitioner, the organization, or both. ## 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. [CareSpecialtyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 59.0) Change events are available for the object. [CareSpecialtyFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [CareSpecialtyHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [CareSpecialtyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [CareSpecialtyShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # CareSpecialtyTaxonomy The junction object between CareSpecialty and CareTaxonomy. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareSpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care specialty associated with a care specialty taxonomy. This is a relationship field. - **Relationship Name**: CareSpecialty - **Relationship Type**: Lookup - **Refers To**: CareSpecialty ### CareTaxonomyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care taxonomy associated with a care specialty taxonomy. This is a relationship field. - **Relationship Name**: CareTaxonomy - **Relationship Type**: Lookup - **Refers To**: CareTaxonomy ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ## 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. [CareSpecialtyTaxonomyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareSpecialtyTaxonomyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareSpecialtyTaxonomyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # CareSystemFieldMapping Represents a mapping from source system fields to Salesforce target entities and attributes. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API. ### ExternalIdField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the field in the external system. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Nillable - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The label for this care system field mapping. ### Role - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The role that the entity represents. Picklist values RemoteMonitoringDevice and RemoteMonitoringPatient are available from API version 49.0 and later. - **Possible values**: - Patient—When the role field is set to Patient, the Enrollment API uses the value of externalIdField as the patient ID. This role can be used when targetObject is set to Account. - RemoteMonitoringDevice—Indicates which externalIdField on 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 which externalIdField on the Account object maps to the ObservedSubject field in the Care Observation object. This role is used when targetObject is set to Account. - ServiceProvider—The Enrollment API uses the value of externalIdField as the provider ID. This role is used when targetObject is set to Account. - NotApplicable—This role is used when targetObject is set to CareProgram or Product, which means that there is no applicable role. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### TargetObject - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the parent entity for the external ID. # CareSystemFieldMapping Represents a mapping from fields in external source systems to Salesforce target entities and attributes ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. ### ExternalIdField - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the field in the external system. ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated CareSystemFieldMapping type in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the mapping is active. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of CareSystemFieldMapping. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Label that identifies the CareSystemFieldMapping throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The CareSystemFieldMapping’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### Role - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: The role that the entity represents. Picklist values RemoteMonitoringDevice and RemoteMonitoringPatient are available from API version 49.0 and later. - **Default value**: NotApplicable - **Possible values**: - NotApplicable: This role is used when targetObject is set to CareProgram or Product, which means that there is no applicable role. - Patient: When the role field is set to Patient, the Enrollment API uses the value of externalIdField as the patient ID. This role can be used when targetObject is set to Account. - RemoteMonitoringDevice: Indicates which externalIdField on 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 which externalIdField on the Account object maps to the ObservedSubject field in the Care Observation object. This role is used when targetObject is set to Account. - ServiceProvider: The Enrollment API uses the value of externalIdField as the provider ID. This role is used when targetObject is set to Account. ### SourceSystem - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: System from which the record was sourced. ### TargetObject - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Name of the corresponding object where information from the source system is recorded. # CareTaxonomy Represents a static list of taxonomy codes. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the taxonomy. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this taxonomy is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this taxonomy is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the taxonomy master record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### ParentTaxonomyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent taxonomy associated with a care taxonomy. This is a relationship field. - **Relationship Name**: ParentTaxonomy - **Relationship Type**: Lookup - **Refers To**: CareTaxonomy ### TaxonomyCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the taxonomy. ### TaxonomyType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Type of taxonomy. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareTaxonomyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CareTaxonomyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareTaxonomyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CE - Coded Element The Coded Element (CE) HL7 segment maps to the CodeSet object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for CE map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below. Table 1. CE - Salesforce | CE | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | CE.1 - Identifier | CodeSet.Code | String | N/A | | CE.2 - Text | CodeSet.Name | String | N/A | | CE.2 - Text | CodeSet​Bundle.Name | String | N/A | | CE.3 - Name of Coding System | CodeSet.Source​System | String | N/A | # Clinical Data Model Patient data and healthcare records are important in the healthcare industry. Without accurate information, performing and managing care becomes difficult. These records are readily available if a patient seeks care from the same provider every time. However, in reality, a patient’s healthcare journey takes them to multiple providers and hospitals at different times. Because the patient’s health hinges on the accuracy of their medical records, it’s crucial for the systems used by different providers and hospitals to be interoperable. And to make this interoperability 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.
Available in: Enterprise and Unlimited Editions
Two standards defined by HL7 for this purpose are the Fast Health Interoperability Resources (FHIR) v4.0 and HL7 (the standard) 2.3. The Clinical Data Model is built from the ground up to align with FHIR v4.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 Clinical Data Model** org pref. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Some of these objects are available in your org even before enabling this org pref because they’re part of other data models in Health Cloud and Life Sciences Cloud. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note To use the Clinical Data Model objects on an Experience Cloud site, community users need the FHIR R4 for Experience Cloud Sites permission set. Here’s the list of objects that need the org pref to be enabled versus a list of objects that don’t require the org pref.
Org Pref Required Org Pref Not Required
  • AllergyIntolerance
  • CarePerformer
  • ClinicalAlert
  • ClinicalEncounter
  • ClinicalEncounterDiagnosis
  • ClinicalEncounterFacility
  • ClinicalEncounterIdentifier
  • ClinicalEncounterProvider
  • ClinicalEncounterReason
  • ClinicalEncounterSvcRequest
  • ClinicalServiceRequest
  • ClinicalServiceRequestDetail
  • DiagnosticSummary
  • HealthCondition
  • MedicationRequest
  • MedicationStatement
  • PatientHealthReaction
  • PatientImmunization
  • PatientMedicalProcedure
  • PatientMedicalProcedureDetail
  • PatientMedicationDosage
  • CareObservation
  • CareObservationComponent
  • CareObservationDetail
  • CareProviderFacilitySpecialty
  • CodeSet
  • CodeSetBundle
  • HealthcareFacility
  • HealthcarePractitionerFacility
  • HealthcareProvider
  • HealthPlanFacilityNetwork
  • HealthPlanFormularyItem
  • Identifier
  • Medication
  • Medication Administration
  • Medication Administration Detail
  • OpportunityProductCategory
  • PersonLanguage
  • PersonName
  • Problem Definition Relationship
  • Specimen
And here’s the list of 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 - Account.EndDate - Contact.MaritalStatus - Contact.Gender - Contact.DeceasedDate - Contact.SequenceInMultipleBirth ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - Starting with the Spring ’23 release, new customers won’t be able to create records in the packaged EHR objects that have counterpart standard objects in the FHIR R4-aligned data model. - All future development will be built on the FHIR R4-aligned data model. The packaged objects in the EHR data model won’t be used for future development. # Clinical Engagement These objects are available for Life Sciences Cloud for Clinical Engagement. - **[Adverse Events](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_adverse_event.htm)** Adverse Events data model helps you in managing and documenting any unfavorable or unintended signs, symptoms, or diseases that occur in participants during the research study. These adverse events can include a wide range of physical or psychological effects that varies from mild discomfort to serious health complications. - **[Participant Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_participant_management_data_model.htm)** Participant Management data model helps you to streamline the recruitment and enrollment processes in clinical trials with advanced digital solutions. With this data model, you can store clinical trial data representing care programs and research studies. It’s USCDI and FHIR R4-aligned, which helps with your system's interoperability and compliance while managing participant data efficiently. - **[Site Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_site_management_data_model.htm)** The Site Management data model helps life sciences organizations identify suitable sites for conducting research studies. Study managers can search for the sites and investigators using the Criteria-Based Search and Filter, and send them assessments. From the assessment responses, study managers can assign scores to the sites, investigators, and their responses. They can also tag the sites and investigators for future site selection efforts. # 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for Clinical Alert in Other Objects In addition to creating a record using these fields, you can add more details to your clinical alert record by creating records in certain other objects, and referencing your ClinicalAlert record as the parent record. Here’s the list of objects you can associate to ClinicalAlert in this way, the type of information they add, and the field they use to reference ClinicalAlert. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the clinical alert. | ParentRecordId | ## Fields ### Categories - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the category that the alert belongs to. - **Possible values**: - Clinical - Diet - Drug - Lab - Subject Contact ### CodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the alert. ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents the alert. - **Referenced Objects**: - CodeSetBundle ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the alert was deactivated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical alert record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user that this record belongs to. ### RaisedById - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or facility that raised the alert. - **Referenced Objects**: - HealthcareProvider - HealthcarePractitionerFacility - CareRegisteredDevice ### RelatedEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter that this alert is related to. - **Referenced Objects**: - ClincialEncounter ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the alert was activated. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the clinical alert. - **Possible values**: - Active - Entered-In-Error - Inactive ### SubjectId - **Type**: polymorphic reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The 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 - HealthcareProvider - Medication - PatientMedicalProcedure - Account ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalAlertFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalAlertHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalAlertShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. [ClinicalAlertChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalDetectedIssue Represents information about a detected issue resulting from a clinical activity. This object is available in API version 55.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the category associated with the issue. This field is a polymorphic relationship field. - **Relationship Name**: CategoryCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the issue. ### IdentificationEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the issue identification was complete. ### IdentificationStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the issue was identified. ### IdentifiedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account, healthcare provider, user, or device that detected the issue. This field is a polymorphic relationship field. - **Relationship Name**: IdentifiedBy - **Relationship Type**: Lookup - **Refers To**: Account, CareRegisteredDevice, HealthcareProvider, User ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MedicationTherapyReviewId ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical detected issue record. ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient associated with the issue. This field is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Lookup - **Refers To**: Account ### ReferenceUri - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The medical references available on the issue. ### SeverityLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the impact level of the issue. - **Possible values**: - High - Low - Moderate ### SourceSysModifiedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the record in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the issue. - **Possible values**: - Amended - Cancelled - Corrected - Entered in Error - Final - Preliminary - Registered - Unknown ## Usage Indicates 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 CodeSet objects. ## 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. [ClinicalDetectedIssueFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalDetectedIssueHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalDetectedIssueChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalDetectedIssueDetail Represents additional information about a clinical detected issue. This object is available in API version 55.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ClinicalDetectedIssueId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent clinical detected issue associated with the issue detail. This field is a relationship field. - **Relationship Name**: ClinicalDetectedIssue - **Relationship Type**: Lookup - **Refers To**: ClinicalDetectedIssue ### DetailCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code associated with the Clinical Detected Issue Detail record. This field is a polymorphic relationship field. - **Relationship Name**: DetailCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference to a record that adds information to a Clinical Detected Issue record. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Relationship Type**: Lookup - **Refers To**: Account, ClinicalEncounterDiagnosis, DiagnosticSummary, HealthcareProvider ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the relation between the Clinical Detected Issue record and the detail record. - **Possible values**: - Evidence - Implicated - Mitigation ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MitigationAuthorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The owner who is responsible for creating and executing the mitigation plan. This field is a polymorphic relationship field. - **Relationship Name**: MitigationAuthor - **Relationship Type**: Lookup - **Refers To**: HealthcarePractitionerFacility, HealthcareProvider, User ### MitigationAuthoringDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time of authoring the mitigation details. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical detected issue detail record. ## Usage - Use the ClinicalDetectedIssueId field to reference the parent ClinicalDetectedIssue record that the additional information is being associated to. - Use the DetailRecordId field to reference the record with the associated information. This field looks up to the following objects: - Account - ClinicalEncounterDiagnosis - DiagnosticSummary - HealthcareProvider - 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. ## 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. [ClinicalDetectedIssueDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalDetectedIssueDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalDetectedIssueDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalEncounter Represents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of a patient’s healthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. 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() ## Additional Information for ClinicalEncounter in Other Objects In addition to creating a record using these fields, you can add more details to your ClinicalEncounter record by creating records in certain other objects, and referencing your ClinicalEncounter record as the parent record. Here’s the list of objects you can associate to ClinicalEncounter in this way, the type of information they add, and the field they use to reference ClinicalEncounter. | Object | Type of Information | Reference Field | | --- | --- | --- | | ClinicalEncounterDiagnosis | Specifies the different diagnoses from an encounter, and other diagnosis-related information. | ClinicalEncounterId | | ClinicalEncounterFacility | Specifies the different healthcare facilities involved in an encounter, and other details relevant to the facility and the encounter. | ClinicalEncounterId | | ClinicalEncounterIdentifier | Specifies identifiers for the encounter. The object is very similar to the standard Identifier object, but is exclusive to ClinicalEncounter. | ClinicalEncounterId | | ClinicalEncounterProvider | Specifies the different providers involved in an encounter and the details of their involvement. | ClinicalEncounterId | | ClinicalEncounterReason | Specifies the reasons for why the encounter happened or was required. | ClinicalEncounterId | | ClinicalEncounterSvcRequest | Specifies service requests that the encounter was based on. | ClinicalEncounterId | ## Fields ### AdmissionSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the source of the admission. - **Possible values**: - Another Hospital - Emergency Department - General Practitioner Referral - In-Hospital Birth - Nursing Home - Other - Other Medical Practitioner Referral - Outpatient Department - Psychiatric Hospital - Rehabilitation Facility ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the clinical encounter of a patient with a care provider. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the classification of the encounter. - **Possible values**: - Ambulatory - Emergency - Home Health - Inpatient Encounter ### DestinationFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility to which the patient is transferred. - **Referenced Objects**: - HealthcareFacility ### DestinationOrganizationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The organization to which the patient is transferred. - **Referenced Objects**: - Account ### DietPreference - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The diet preferences of the patient. - **Possible values**: - Dairy-Free - Gluten-Free - Halal - Kosher - Nut-Free - Vegan - Vegetarian ### DischargeDispositionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the patient at discharge. - **Referenced Objects**: - CodeSetBundle ### Duration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The duration of the patient encounter, in the given unit of measure. ### DurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measurement for the encounter duration. - **Referenced Objects**: - UnitOfMeasure ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the encounter ended. ### FacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility where the encounter took place. - **Referenced Objects**: - HealthcareFacility ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical encouter record. ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient receiving the treatment. - **Referenced Objects**: - Account ### PreAdmissionIdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the encounter pre-admission. - **Referenced Objects**: - ClinicalEncounterIdentified ### PreviousFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The patient's location before the admission. - **Referenced Objects**: - HealthcareFacility ### PreviousOrganizationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the organization where the patient was previously located. - **Referenced Objects**: - Account ### PriorityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the priority associated with the urgency of the encounter. - **Referenced Objects**: - CodeSetBundle ### ReadmissionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code for the readmission. - **Referenced Objects**: - CodeSetBundle ### RelatedClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies an encounter that is related to this encounter. - **Referenced Objects**: - ClinicalEncounter ### ServiceAppointment - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The appointment associated with this clinical encounter. - **Referenced Objects**: - ServiceAppointment ### ServiceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the classification of the type of service. - **Possible values**: - Homoeopathy - Meditation - Naturopathy - Reflexology ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of this record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### SpecialCourtesy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies a class of courtesy extended to the patient. - **Possible values**: - Extended - Normal - Professional - Staff - Unknown - VIP ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date on which the encounter began. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the patient encounter. - **Possible values**: - Arrived - Cancelled - Finished - In Progress - Planned - Triaged ### TypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the encounter. - **Referenced Objects**: - CodeSetBundle ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [ClinicalEncounterFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ClinicalEncounterDiagnosis Represents a diagnosis related to a clinical encounter. This object is a child object of ClinicalEncounter. 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 ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent clinical encounter record the diagnosis belongs to. - **Referenced Objects**: - ClinicalEncounter ### DiagnosisId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References the condition or procedure relevant to the encounter. - **Referenced Objects**: - HealthCondition - PatientMedicalProcedure ### DiagnosisRank - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the rank of a particular diagnosis among multiple diagnoses for an encounter. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time whenthe record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time when the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: A system-generated name for the ClinicalEncounterDiagnosis record. ### UsageTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the role the diagnosis plays in context of the encounter. - **Referenced Objects**: - CodeSetBundle ## Usage Once the diagnosis-related information is recorded in the ClinicalEncounterDiagnosis record, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterDiagnosisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [ClinicalEncounterDiagnosisFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterDiagnosisHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ClinicalEncounterFacility Represents 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 create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent clinical encounter that the clinical encounter facility record is related to, - **Referenced Objects**: - ClinicalEncounter ### Duration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The duration of time that the patient was present at the facility. ### DurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of time for the Duration field. - **Referenced Objects**: - UnitOfMeasure ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the patient’s time at the facility during the encounter. ### FacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The healthcare facility where the encounter occurred. - **Referenced Objects**: - HealthcareFacility ### FacilityTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the facility, in the context of its physical structure. - **Referenced Objects**: - CodeSetBundle ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time when the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the ClinicalEncounterFacility record. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the patient’s time at the facility during the encounter. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the patient’s presence at the facility in the context of the patient’s encounter. - **Possible values**: - Active - Completed - Planned - Reserved ## Usage Once the facility-related information is recorded in the ClinicalEncounterFacility record, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterFacilityFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterFacilityHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalEncounterFacilityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalEncounterIdentifier Represents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. 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 ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent clinical encounter that this identifier belongs to. - **Referenced Objects**: - ClinicalEncounter ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from when the identifier is in effect. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from when the identifier is no longer in effect. ### IdTypeId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the identifier. - **Referenced Objects**: - CodeSet - CodeSetBundle ### IdUsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of use of the identifier. - **Possible values**: - Official - Old - Secondary - Temp - Usual ### IdValue - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique value of the identifier. No two ClinicalEncounterIdentifier records in an org can share the same IdValue. ### IssuingAuthorityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authority or organization that issued the identifier. - **Referenced Objects**: - Account ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the ClinicalEncounterIdentifier record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system that the identifier belongs to. ## Usage Once the identifier-related information is recorded in the ClinicalEncounterIdentifier record, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterIdentifierFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterIdentifierHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalEncounterIdentifierChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalEncounterProvider Represents the providers involved in an encounter. This object is a child object of ClinicalEncounter. 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 ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent clinical encounter that the ClinicalEncounterProvider record belongs to. - **Referenced Objects**: - ClinicalEncounter. ### Duration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The duration of the performer's participation in the encounter. ### DurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measurement for the duration field. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the provider’s participation in the encounter ended. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the ClinicalEncounterProvider record. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person who is performing care in the encounter. - **Referenced Objects**: - HealthcareProvider ### PractitionerTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the role of the practitioner in the encounter. For example, admitter, attender discharger, or escort. - **Referenced Objects**: - CodeSetBundle ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The 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 is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterProviderFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterProviderHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalEncounterProviderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalEncounterReason Represents the reasons for why the encounter was required. This object is a child object of ClinicalEncounter. 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 ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent ClinicalEncounter record that this ClinicalEncounterReason record belongs to. - **Referenced Objects**: - ClinicalEncounter ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of this encounter reason. ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that indicates the reason why the encounter took place. - **Referenced Objects**: - CodeSetBundle ### ReasonReferenceId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the encounter. - **Referenced Objects**: - HealthCondition - CareObservation - PatientMedicalProcedure ## Usage Once the reasons for the encounter is recorded in the ClinicalEncounterReason record using the ReasonCodeId and ReasonReferenceId fields, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterReasonFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterReasonHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalEncounterReasonChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalEncounterSvcRequest Represents the service requests related to a clinical encounter. This object is a child object of ClinicalEncounter. 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 ### ClinicalEncounterId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent ClinicalEnounter record that this ClinicalEncounterSvcRequest record belongs to. - **Referenced Objects**: - ClinicalEncouter ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The service request that the encounter is based on. - **Referenced Objects**: - ClinicalServiceRequest ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical encounter service request record. ## Usage Once the service request-related information is recorded in the ClinicalEncounterSvcRequest record, the parent ClinicalEncounter record is referenced using the ClinicalEncounterId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalEncounterSvcRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalEncounterSvcRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalEncounterSvcRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalServiceRequest Represents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’s healthcare. 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() ## Additional Information for ClinicalServiceRequest in Other Objects In addition to creating a record using these fields, you can add more details to your ClinicalServiceRequest record by creating records in certain other objects, and referencing your ClinicalServiceRequest record as the parent record. Here’s the list of objects you can associate to ClinicalServiceRequest in this way, the type of information they add, and the field they use to reference ClinicalServiceRequest. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the service request. | ParentRecordId | | ClinicalServiceRequestDetail | Associates the service request with various other records and defines the nature of the association. For instance, if the service request is based on an associated record. | ClinicalServiceRequestId | ## Fields ### BodySiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents site of the body associated with the service request. - **Referenced Objects**: - CodeSetBundle ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the case associated with the clinical service request record. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### CategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the category of the service request. - **Referenced Objects**: - CodeSetBundle ### ConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The condition that justifies the service request. - **Referenced Objects**: - HealthCondition ### DateSigned - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date the service request was signed. ### DiagnosticReportId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The diagnosis that justifies the service request. - **Referenced Objects**: - ClinicalEncounterDiagnosis ### EncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter related to the service request. - **Referenced Objects**: - ClinicalEncounter ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time for the service request. ### FacilityCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-generated code for the facility where the service request is to be performed. - **Referenced Objects**: - CodeSetBundle ### FacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility where the service request is to be performed. - **Referenced Objects**: - HealthcareFacility ### HasPrerequisites - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether there are any prerequisites for the service request. If the value of this field is true, then you can’t select a PrerequisiteCodeId. ### IsAccepted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the clinical service request is accepted (true) or not (false). The default value is false. ### IsIgnored - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the request should be ignored. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical service request. ### ObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observation that justifies the service request. - **Referenced Objects**: - ClinicalObservation ### OrchestrationInstanceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the flow orchestrator instance. This field is a relationship field. - **Relationship Name**: OrchestrationInstance - **Refers To**: FlowOrchestrationInstance ### OriginalRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the original service request the service request replaces. - **Referenced Objects**: - ClinicalServiceRequest ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the clinical service request record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note To enable queues for the Clinical Service Request object, change the sharing settings for the object from Controlled By Parent to Private. ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient associated with the service request. - **Referenced Objects**: - Account ### PatientInstruction - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Instructions for the patient. ### PerformerId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or device that performs the service request. - **Referenced Objects**: - Account - Asset - HealthcareProvider - CareRegisteredDevice ### PerformerTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type or role of the person performing the service request. - **Referenced Objects**: - CodeSetBundle ### PrerequisiteCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-generated code that represents the prerequisites for the service request. You can’t select a record for this field if the HasPrerequisites field is set to true. - **Referenced Objects**: - CodeSetBundle ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the priority of the service request. - **Possible values**: - ASAP - Routine - Stat - Urgent ### QuantityDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator value of the quantity associated with the service request. ### QuantityNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator value of the quantity associated with the service request. ### QuantityNumeratorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the numerator value of the quantity associated with the service request. - **Referenced Objects**: - UnitOfMeasure ### QuantityType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the type of quantity related to the service request. - **Possible values**: - Range - Ratio ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the justification for the service request. - **Referenced Objects**: - CodeSetBundle ### ReferralScore - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The predictive score used to prioritize the request. ### RequestCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the service request. - **Referenced Objects**: - CodeSetBundle ### RequesterId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or device raising a service request. - **Referenced Objects**: - Account - Asset - HealthcareProvider - CareRegisteredDevice ### ServiceRequestGroupIdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier that ties the service request to its batch of requests. - **Referenced Objects**: - Identifier ### SourceChannel - **Type**: picklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The source channel of the clinical service request. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time for the service request. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The status of the service request. - **Possible values**: - Active - Completed - Draft - Entered-in-Error - On-Hold - Revoked - Unknown ### StatusReason - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The reason for the current clinical service request status. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of the service request. - **Possible values**: - Directive - Filler-Order - Instance-Order - Option - Order - Original-Order - Plan - Proposal - Reflex-Order ## 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. [ClinicalServiceRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalServiceRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalServiceRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [ClinicalServiceRequestShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. [ClinicalServiceRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # ClinicalServiceRequestDetail Associates records from different objects to a clinical service request record to add more information to it. This is a multi-object junction object. 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 ### ClinicalServiceRequestId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent service request record. - **Referenced Objects**: - ClinicalServiceRequest ### DetailCodeId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a code set or code set bundle that adds information to a clinical service request record. - **Referenced Objects**: - CodeSet - CodeSetBundle ### DetailRecordId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a record that adds information to a clinical service request record. - **Referenced Objects**: - ClinicalServiceRequest - MedicationRequest - HealthcareFacility - CareObservation - HealthCondition - DiagnosticSummary - Specimen ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the relation between the service request and the detail record. - **Possible values**: - Based On - Body Site - Reason Reference - Request Facility - Specimen ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the clinical service request detail record. ## Usage ClinicalServiceRequestDetail records add additional information to ClinicalServiceRequest records. This information may be of the following 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, and then the type of information is specified using the DetailType field. This information is then connected to the clinical service request record 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 instances are required in the parent clinical service request record, multiple records of ClinicalServiceRequestDetail are required. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ClinicalServiceRequestDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ClinicalServiceRequestDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ClinicalServiceRequestDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # Clone Activity Plan And Territories Action Clones Activity Plan records and associates them with specified territories. This action is available in API version 67.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/cloneActvtyPlanTerritories Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
activityPlanToTerritories List<Apex> Required

A collection of Apex crtActvtyPlan.ActivityPlanToTerritories records, where each pair contains a source Activity Plan ID and its associated territory IDs.
timePeriodId String Required

The ID of the time period to assign to each newly created Activity Plan record.
activityPlanPrefix String Required

The base name prefix for the new Activity Plan records. The territory name is appended to this prefix to form the final Activity Plan name.
## Outputs | Output | Type | Description | | --- | --- | --- | | clonedActivityPlanIds | List | A list of IDs for the Activity Plan records created during the clone operation. | ## Example Sample Request { "inputs": \[ { "activityPlanToTerritories": \[ { "activityPlanId": "1APxx0000004C92GAE", "territoryIds": \[ "0TTxx0000001A23GBF", "0TTxx0000001A24GBF" \] } \], "timePeriodId": "0TPxx0000003B11GAE", "activityPlanPrefix": "FY26\_Territory\_Plan" } \] } Sample Response \[ { "actionResult": { "outputValues": { "clonedActivityPlanIds": \[ "1APxx0000004C95GAE", "1APxx0000004C96GAE" \] }, "isSuccess": true, "errors": \[\] } } \] # Codeable​Concept The Codeable​Concept FHIR resource maps to the CodeSet​BundleBundle object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Codeable​Concept](https://www.hl7.org/fhir/datatypes.html#CodeableConcept) map to the fields in Salesforce. Table 1. Codeable​Concept - Salesforce | Codeable Concept Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | coding | CodeSet​Bundle.CodeSet1Id, CodeSet​Bundle.CodeSet2Id, CodeSet​Bundle.CodeSet3Id,… and CodeSet​Bundle.CodeSet15Id | Lookup: CodeSet | 0.1 | FHIR defines Codeable​​Concept.coding as a zero-to-many reference. However, the Salesforce implementation has flattened this into fifteen zero-to-one references to CodeSet | | text | CodeSet​Bundle.Name | String | 0.1 | N/A | #### See Also - [CodeSetBundle](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_CodeSetBundle.htm "Represents a group of code sets across multiple systems and versions. All of these code sets refer to the same conceptual entity. This object is available in API version 50.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 all sorts of digital records. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that’s represented by this code set. ### CodeDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information associated with the code set. ### CodeSetKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Represents a unique key that identifies the concept represented by code sets across different systems and versions. This key isn’t case-sensitive. ### CodeSetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the code set. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the code set’s effective period. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is an active code set. ### IsCustomCode - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is defined by a specific organization, as opposed to recognized across the industry. ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the code set is the primary code set for the concept. That is, it was selected manually by a user instead of being selected by an automated process. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The textual representation of the meaning of the code. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: A reference to the person who owns the code set record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system that sets the context for the code and defines its meaning. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the code set’s effective period. ### SystemVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the source system the code belongs to. ## Usage Code sets are used across multiple features and objects to represent coded, system-defined information about various entities. These codes are usually industry recognized codes from systems like LOINC or SNOMED. ## 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. [CodeSetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # CodeSetBundle Represents a group of code sets across multiple systems and versions. All of these code sets refer to the same conceptual entity. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CodeSet10Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet11Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet12Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet13Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet14Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet15Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet1Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet3Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet4Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet5Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet6Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet7Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet8Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSet9Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A code set that represents the conceptual entity represented by the code set bundle. ### CodeSetBundleKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key that represents the concept referenced by the bundled code sets. This value is unique, but not case sensitive. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of a conceptual entity referenced by the different code sets grouped together in the bundle. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: References the user who owns the code set bundle record. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the code set bundle. This field can be used to group together code set bundles of similar types. Add values to this picklist as needed for your business functions. ## Usage The different code sets that represent the same conceptual entity are referenced using the different CodeSetId fields, and then given a unique CodeSetBundleKey. This object can’t have more than one record referencing the same group of code sets. Though the industry defines code set bundles as supporting infinite references to code sets, the Salesforce implementation supports a maximum of fifteen code set references in a bundle. ## 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. [CodeSetBundleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # Coding The Coding FHIR resource maps to the CodeSet object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Coding](https://www.hl7.org/fhir/datatypes.html#Coding) map to the fields in Salesforce. Table 1. Coding - Salesforce | Coding Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | system | CodeSet​.Source​System | String | 0.1 | FHIR defines coding​.system as a URI. However, the Salesforce implementation of CodeSet​.Source​System is a string because Salesforce doesn’t support the URI data type. | | version | CodeSet​.System​Version | String | 0.1 | N/A | | code | CodeSet​.Code | String | 0.1 | FHIR defines coding​.code as a code data type. However, the Salesforce implementation of CodeSet​.Code is a string because Salesforce doesn’t support the Code data type. | | display | CodeSet​.Name | String | 0.1 | N/A | | user​Selected | CodeSet​.IsPrimary | Boolean | 0.1 | N/A | #### See Also - [CodeSet](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_CodeSet.htm "Represents various industry defined codes in the context of their systems and versions of those systems. These codes are used in all sorts of digital records. This object is available in API version 50.0 and later.") # Commercial Configuration The Life Sciences Commercial Configuration objects store settings and configurations for many Customer Engagement features. In some cases, you can control a feature’s behavior by assigning configurations to specific profiles or users. Other configurations apply to all the users in an org. ![Life Sciences Commercial Engagement Configuration entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_commercial_configuration_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/commercial-configuration.html "HTML (New Window)"). ## Commercial Configuration Objects in Life Sciences Customer Engagement - [Life Science Metadata Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadataassignment.htm) - [Life Science Metadata Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatacategory.htm) - [Life Science Metadata Field Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatafieldvalue.htm) - [Life Science Metadata Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatarecord.htm) - [Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_profile.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # CommSubConsentCmplSnpsht Represents the snapshot of compliance information that’s captured at the time of consent of the communication subscription. This object is available in API version 65.0 and later. ## Supported Calls create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountRestrictedProdtList - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The list of restricted products associated with the consent giver at the time of consent. ### AccountTerrRstrcProdtList - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The list of territory restricted products associated with the consent giver at the time of consent. ### ConsentDocumentReference - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The reference ID of an external document, such as a paper consent form, used to record this consent capture. ### ConsentGiverId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The ID of the person who gave consent to the communication subscription. This field is a polymorphic relationship field. - **Relationship Name**: ConsentGiver - **Refers To**: Account, Contact, Individual, User ### DisclaimerText - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The disclaimer information agreed upon by the consent giver. ### IsVerbalConsent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether verbal consent was used as the proof for this consent capture. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ReceiptRequestStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the request raised by the consent giver requesting for the receipt with the consent and compliance information. - **Default value**: NotRequested - **Possible values**: - NotRequested - ReceiptSent - Requested ### SourceRequestRecordId Reserved for future use. ### TermsAndConditionsText - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The terms and conditions information agreed upon by the consent giver. ## 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. [CommSubConsentCmplSnpshtChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CommSubConsentCmplSnpshtFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CommSubConsentCmplSnpshtHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CommSubConsentCmplSnpshtShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CommSubscription Standard and custom fields extend the standard Communication Subscription object to represent a customer’s subscription preferences for a specific communication. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: CommSubscription](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_commsubscription.htm) ## Fields ### FilterAttributeList - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The attributes used as a criteria for filtering communication subscriptions. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ## 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. [CommSubscriptionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [CommSubscriptionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CommSubscriptionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CommSubscriptionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CommSubscriptionConsent Standard and custom fields extend the standard Communication Subscription Consent object to represent a customer’s consent to a communication subscription. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: CommSubscriptionConsent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionconsent.htm) ## Fields ### CommSubConsentCmplSnpshtId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the communication subscription consent compliance snapshot record associated with the communication subscription consent. This field is a relationship field. - **Relationship Name**: CommSubConsentCmplSnpsht - **Refers To**: CommSubConsentCmplSnpsht ### ContactPointId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the contact point, such as an Individual or person account, associated with the communication subscription consent. This field is a polymorphic relationship field. - **Relationship Name**: ContactPoint - **Refers To**: ContactPointAddress, ContactPointEmail, ContactPointPhone, ContactPointSocial ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. # CommunicationRequest The CommunicationRequest FHIR resource maps to the TrackedCommunication and TrackedCommunicationDetail objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [CommunicationRequest](https://build.fhir.org/communicationrequest-definitions.html) map to the fields in Salesforce. Table 1. CommunicationRequest - Salesforce | communicationrequest Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0.M | The identifier information for a communication request is represented as Identifier records that reference the TrackedCommunication record using their Identifier​.Parent​RecordId field. | | basedOn | N/A | N/A | N/A | Not supported | | status | TrackedCommunication.Status | Picklist | 1.1 | While FHIR defines CommunicationRequest.status as a code set, the Salesforce implementation of TrackedCommunication.Status is a picklist. | | statusReason | TrackedCommunication.StatusReason | Picklist | 0.1 | While FHIR defines CommunicationRequest​.statusReason as a code set bundle, the Salesforce implementation of TrackedCommunication.StatusReason is a picklist. | | groupIdentifier | N/A | N/A | N/A | Not supported | | intent | N/A | N/A | N/A | Not supported | | priority | TrackedCommunication.Priority | Picklist | 0.1 | While FHIR defines CommunicationRequest​.priority as a code set, the Salesforce implementation of TrackedCommunication.Priority is a picklist. | | subject | TrackedCommunication​.Subject | Look​up: Account, Contact, User | 0.1 | N/A | | occurrence | TrackedCommunication.​OccurrenceStartDateTime | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, CommunicationRequest.​occurrence is flattened into a set of occurrence start date time and occurrence end date time fields. | | occurrence | TrackedCommunication.​OccurrenceEndDateTime | Date​/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, CommunicationRequest.​occurrence is flattened into a set of occurrence start date time and occurrence end date time fields. | | authoredOn | TrackedCommunication​.CreatedDate | Date/Time | 0.1 | N/A | | doNotPerform | N/A | N/A | N/A | Not supported | | encounter | N/A | N/A | N/A | Not supported | | requester | TrackedCommunication​.RequesterReferenceId | Lookup: Account, Contact, User | 0.1 | N/A | | informationProvider | TrackedCommunication​.CommunicatorReferenceId | Lookup: Account, Contact, User | 0.M | N/A | | replaces | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Replaced Item as the picklist value in DetailType. | | category | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Category as the picklist value in DetailType. | | medium | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Medium as the picklist value in DetailType. | | about | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select About as the picklist value in DetailType. | | recipient | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Recipient as the picklist value in DetailType. | | reason | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Reason Code as the picklist value in DetailType. | | note | TrackedCommunication​Detail.DetailType | Picklist | 0.M | Select Note as the picklist value in DetailType. | | payload.content | TrackedCommunication​Detail.DetailType | Picklist | 1.1 | Select Payload as the picklist value in DetailType. | # ComplianceStatementDef Used to ensure adherence to regulatory requirements during health care provider engagements. Stores essential compliance information that's displayed across multiple use cases, including visits and consent capture. Compliance statements can be configured to require acknowledgement, have an optional acknowledgement, or be purely informational. Their intended audience can vary from the accounts that are being engaged with to the end user themselves. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Display order of statements when there are multiple for a given context. ### FilterAttributeValues - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Attributes to filter compliance statements such as target audience location or language. ### JurisdictionCountries - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Represents the jurisdiction countries to which the compliance statement is applicable. ### JurisdictionType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the jurisdiction type to which the compliance statement is applicable. - **Possible values**: - City - Country - State ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### ModuleType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the module for which the expense type is available. - **Possible values**: - Consent - MedicalInquiry - ProviderVisit - RemoteEngagement ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of compliance statement record. Auto-number is populated. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### StatementRequirementLevel - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Requirement level for the compliance agreements. - **Default value**: None - **Possible values**: - None - Optional - Required ### StatementText - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Compliance statement text. ### StatementType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of compliance statements. - **Default value**: ComplianceNote - **Possible values**: - ComplianceAgreement - ComplianceNote - Disclaimer - TermsAndConditions ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Represents the cloud using the object. This is a read-only field and you can't specify or update its value. - **Possible values**: - LifeSciences # Condition The Condition FHIR resource maps to the Health​Condition object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Condition](https://www.hl7.org/fhir/condition.html) map to the fields in Salesforce. Table 1. Condition - Salesforce | Condition Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0.M | The identifier information for a health condition is represented as Identifier records that reference the health condition record using their Identifier​.Parent​RecordId field. | | clinical​Status | Health​Condition​.Condition​Status | Picklist | 0.1 | While FHIR defines Condition​.clinical​Status as a code set bundle, the Salesforce implementation of Health​Condition​.Condition​Status is picklist. | | verification​Status | Health​Condition​.Diagnostic​Status | Picklist | 0.1 | While FHIR defines condition​.verification​Status as a code set bundle, the Salesforce implementation of Health​Condition​.Diagnostic​Status is picklist. | | category | Health​Condition​.Type | Picklist | 0.1 | While FHIR defines Condition​.category as a zero-to-many code set bundle, the Salesforce implementation of Health​Condition​.Categories is a zero-to-one picklist. | | severity | Health​Condition​.Severity | Picklist | 0.1 | While FHIR defines condition​.severity as a code set bundle, the Salesforce implementation of Health​Condition​.Severity is picklist. | | code | Health​Condition​.Condition​CodeId | Lookup: CodeSet​Bundle | 1.1 | While FHIR defines condition​.code as a zero-to-one resource, the Salesforce implementation is a one-to-one field. | | body​Site | Health​Condition​.SiteId | Lookup: CodeSet​Bundle | 0.1 | Use this field if only one bodySite value is required for the condition. | | body​Site | Health​Condition​Detail | Object | 0.M | Use the child object to specify BodySite values for a condition if multiple bodySite values are reuqired. | | subject | Health​Condition​.PatientId | Master-Detail Reference: Account | 1.1 | The Salesforce implementation of Condition​.subject doesn’t support groups. | | encounter | Health​Condition​.Clinical​EncounterId | Lookup: Encounter | 0.1 | N/A | | onset​.onset​Date​Time | Health​Condition​.Onset​Start​Date​Time | Date​Time | 0.1 | Health​Condition​.Onset​Start​Date​Time is used as both the equivalent of condition​.onset​.onset​Date​Time and the start date of condition​.onset​.onset​Period | | onset​.onset​Age | N/A | N/A | N/A | Not supported | | onset​.onset​Period | Health​Condition​.Onset​Start​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, condition​.onset​.onset​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of condition​.onset​.onset​Date​Time | | onset​.onset​Period | Health​Condition​.Onset​End​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, condition​.onset​.onset​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of condition​.onset​.onset​Date​Time | | onset​.onset​Range | N/A | N/A | N/A | Not supported | | onset​.onset​String | N/A | N/A | N/A | Not supported | | abatement​.abatement​Date​Time | Health​Condition​.Abatement​Start​Date​Time | Date​Time | 0.1 | Health​Condition​.Abatement​Start​Date​Time is used as both the equivalent of condition​.abatement​.abatement​Date​Time and the start date of condition​.abatement​.abatement​Period | | abatement​.abatement​Age | N/A | N/A | N/A | Not supported | | abatement​.abatement​Period | Health​Condition​.Abatement​Start​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, condition​.abatement​.abatement​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of condition​.abatement​.abatement​Date​Time | | abatement​.abatement​Period | Health​Condition​.Abatement​End​Date​Time | Date​Time | 0.1 | Since Salesforce doesn’t natively support the period data type, condition​.abatement​.abatement​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of condition​.abatement​.abatement​Date​Time | | abatement​.abatement​Range | N/A | N/A | N/A | Not supported | | abatement​.abatement​String | N/A | N/A | N/A | Not supported | | recorded​Date | Health​Condition​.Record​Creation​Date​Time | Date​Time | 0.1 | N/A | | recorder | Health​Condition​.Record​CreatorId | Polymorphic Lookup: Account, Healthcare Provider | 0.1 | N/A | | asserter | Health​Condition​.Assertion​SourceId | Polymorphic Lookup: Account, Healthcare Provider | 0.1 | N/A | | stage | Health​Condition​.StageId | Lookup: CodeSet​Bundle | 0.1 | The child resources of condition​.stage is combined into a single code set bundle reference field. While FHIR defines condition​.stage as a zero-to-many resource, the Salesforce implementation is a zero-to-one field. | | evidence | N/A | N/A | N/A | Not supported | | note | Author​Note | Object | 0.M | The notes for a health condition is represented as Author​Note records that reference the health condition record using their Author​Note​.Parent​RecordId field. | #### See Also - [HealthCondition](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_HealthCondition.htm "Represents a clinical condition, problem, or any clinically relevant occurrence that is a matter of concern. This object is available in API version 51.0 and later.") # ConnectApi Enums Enums specific to the ConnectApi namespace. ConnectApi enums inherit all properties and methods of Apex enums. Enums are not versioned. Enum values are returned in all API versions. Clients should handle values they don't understand gracefully.
Enum Description
ConnectApi.ContentType Type of content for a presentation.
  • ProviderVisit
  • ManagedEvent
ConnectApi.PlayerGesture Player gesture for a presentation.
  • TapTop
  • TapBottom
  • SwipeUp
  • SwipeDown
ConnectApi.SenderType Sender type for an email template.
  • SalesRep
  • PredefinedEmail
ConnectApi.ReplyToType Reply-to type for an email template.
  • SalesRep
  • PredefinedEmail
ConnectApi.AutomatedEmailContextType Context type for an automated email.
  • ProviderVisit
ConnectApi.AutomatedEmailActionType Action type for an automated email.
  • Create
  • Update
  • Cancel
# ConnectApi Namespace The ConnectApi namespace (also called Connect in Apex) provides classes for accessing the same data available in Connect REST API. Use Connect in Apex to create custom experiences in Salesforce. For information about working with the ConnectApi classes, see [Connect in Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/connectAPI_overview.htm). - **[LifeSciEmailTemplate Methods](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_LifeSciEmailTemplate_methods.htm)** These are the LifeSciEmailTemplate methods for Life Sciences Cloud. - **[LifeSciPresentation Methods](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_LifeSciPresentation_methods.htm)** These are the LifeSciPresentation methods for Life Sciences Cloud. - **[LifeSciPresPageProductGuidance Methods](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_LifeSciPresPageProductGuidance_methods.htm)** These are the LifeSciPresPageProductGuidance methods for Life Sciences Cloud. - **[Input Classes](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_apex_connect_api_input_classes.htm)** These are the Apex input classes for Life Sciences Cloud. - **[Output Classes](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_apex_connect_api_output_classes.htm)** These are the Apex output classes for Life Sciences Cloud. - **[ConnectApi Enums](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connectAPI_enums.htm)** Enums specific to the ConnectApi namespace. # ConnectApi.EmailTemplateInputRepresentation Input representation for creating or updating an email template. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | activatedDate | [Date](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_date.htm) | Activation date for the email template. | 65.0 | | attachmentObjectTypes | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | String representing the attachment object types. | 65.0 | | automatedEmailActionType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Action type for the automated email. | 65.0 | | automatedEmailContextType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Context type for the automated email. | 65.0 | | bccEmailIdList | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | List of BCC email IDs. | 65.0 | | communicationSubscriptionId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the communication subscription associated with the email template. | 65.0 | | contentDocumentId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the Content Document of the email template. | 65.0 | | customFields | [Object](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_class_System_Object.htm) | Custom fields for the email template. | 65.0 | | deactivatedDate | [Date](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_date.htm) | Deactivation date for the email template. | 65.0 | | description | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Description of the email template. | 65.0 | | emailSubject | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Subject of the email template. | 65.0 | | id | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the email template. | 65.0 | | isActive | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) | Indicates if the email template is active. | 65.0 | | isDefaultAutoEmailTemplate | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) | Indicates if the email template is a default automated email template. | 65.0 | | isSubjectLineEditable | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) | Indicates whether the subject line is editable. | 65.0 | | languages | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) | List of languages for the email template. | 65.0 | | name | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Name of the email template. | 65.0 | | productId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the product associated with the email template. | 65.0 | | replyToEmailAddress | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Reply-to email address. | 65.0 | | replyToType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Reply-to type for the email template. | 65.0 | | senderEmailFieldAPIName | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | API name of the sender's email field. | 65.0 | | senderType | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Sender type for the email template. | 65.0 | | shouldIgnoreEmailConsent | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) | Indicates whether email consent should be ignored. | 65.0 | | surveyId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the survey associated with the email template. | 65.0 | | topics | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) | List of topics associated with the email template. | 65.0 | # ConnectApi.GenericResponseOutputRepresentation Output representation for a generic response from a Connect API call. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | isSuccess | [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) | Indicates if the API call was successful. | 65.0 | | errors | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) | List of errors encountered during the API call. | 65.0 | | jobId | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | ID of the asynchronous processing job, if applicable. | 65.0 | | message | [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) | Message describing the result of the API call. | 65.0 | # ConnectApi.PageProductInputRepresentation Input representation for creating or deleting product guidance associations on a presentation page. | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | pageProducts | [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) | List of presentation pages and their product and guidance associations. | 65.0 | # ConnectApi.PresentationContentInputRepresentation Input representation for creating or updating presentation content.
Property Name Type Description Available Version
contentType String Type of content, such as:
  • PRESENTATION_PDF
  • PRESENTATION_ZIP
  • PRESENTATION_PAGE
65.0
pages List<ConnectApi.PageRepresentation> List of presentation pages and their associated metadata. 65.0
presentation ConnectApi.PresentationRepresentation Representation of the presentation, including its name, ID, and other properties. 65.0
# Consent Management Consent Management captures and honors healthcare provider consent and communication preferences across subscriptions and channels. Increase engagement and improve relationships by personalizing healthcare provider communications while ensuring privacy and compliance. ![Consent Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_consent_mgmt_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/life-sciences-consent-management.html "HTML (New Window)"). ## Consent Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Communication Subscription](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscription.htm) - [Communication Subscription Channel Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionchanneltype.htm) - [Communication Subscription Consent](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscriptionconsent.htm) - [Communication Subscription Consent Compliance Snapshot](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_commsubconsentcmplsnpsht.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Contact Point Social](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointsocial.htm) - [Data Use Purpose](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_datausepurpose.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Engagement Channel Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_engagementchanneltype.htm) - [Individual](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_individual.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Considerations for Integration The Salesforce implementation of FHIR resources differs from the FHIR specification. Built on the core Salesforce platform, the FHIR-aligned clinical data model comes with field mappings that help you integrate with the FHIR R4 specification.
Available in: Enterprise and Unlimited Editions.
A middleware integration solution is required to convert messages from HL7 and FHIR-based systems to the fields and objects in Salesforce. But before you integrate, here are a few things to 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 first name. FullName stores the combination of the patient’s first and last name. The ParentRecordId field relates this name to 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​.IdUsage​Type field of the Identifier 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, which is 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​.Source​System field and the CodeSet​.Source​System field. The FHIR identifier​.system resource, which is a URI, maps to the Identifier​.Source​System field of the Identifier object, which is a string in Salesforce. Similarly, the FHIR coding​.system resource, which is a URI, maps to the CodeSet​.Source​System field of the CodeSet object, which is also a string in Salesforce. - According to FHIR, Codeable​Concept has a zero-to-many coding resource. Because Salesforce doesn’t support zero-to-many references, Code Set ​Bundle flattens this zero-to-many reference to 15 zero-to-one Code Set references. The Code Set references are 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 flattened to 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, allergy​Intolerance​.onset​.onset​Period in the FHIR specification maps to the Allergy​Intolerance​.Onset​Start​Date​Time and Allergy​Intolerance​.Onset​End​Date​Time 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, medication​​Request​.dispense​​Request​.initial​Fill​.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 the UnitofMeasure object. For example, procedure​.performed​.performed​Range in the FHIR specification maps to the Patient​Medical​​Procedure​.PerformedAt​AgeLower​Limit, Patient​Medical​​Procedure​.PerformedAt​​AgeUpper​Limit, and Patient​Medical​​Procedure​.Performed​AgeRange​Unit 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, service​Request​.quantity​.quantity​Ratio in the FHIR specification maps to the Clinical​Service​Request​.Quantity​Numerator, Clinical​Service​Request​.Quantity​Denominator, and Clinical​Service​Request​.Quantity​Numerator​Unit​Id fields in Salesforce. # Contact Encounter (POST) Load 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. - To update an existing encounter with details of new encounter participants, pass the referenceID of the encounter in the payload. - 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 set to lead, the participant’s first name and last name are mandatory. ## Resource /services/data/vXX.X/contact-tracing ## Available Version 49.0 and later ## Authentication Replace TOKEN with the OAuth access token. Authorization: Bearer **TOKEN** ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note The Lightning Platform REST API supports OAuth 2.0 (an open protocol to allow secure API authorization). See [Authorize Apps with OAuth](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") in Salesforce Help for more details. ## HTTP Methods POST ## 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" : "lee.lo@mail.com", "address":{ "city":"Seattle", "state":"Washington", "country":"US", "postalCode":"11404", "street":"Richmond St" } }, { "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**
Name Type Description
contactTracingEncounters.​referenceId String The ID of an existing contact encounter record in the Salesforce system.
contactTracingEncounters.​name String Required. The name for the encounter.
contactTracingEncounters.​estimatedParticipantCount Integer The estimated number of participants in the encounter.
contactTracingEncounters.​startDateTime DateTime Required. The start date and time of the encounter. Must be in YYYY-MM-DDT HH:MM:SS format. For example, 2020-05-18T09:15:00.
contactTracingEncounters.​duration Integer Required. The duration of the encounter in minutes.
contactTracingEncounters.​description String The description for the encounter.
contactTracingEncounters.​participants List The list of participants for the contact encounter. Each element in the list represents ContactEncounterParticipant. Valid values are:
  • lead
  • employee
  • patient

Note: Only one value is allowed.
contactTracingEncounters.​participants.participantType String Required. The encounter participant type. Valid values are:
  • Lead— A new lead is created with the specified participant record type. If the record type does not exist in the org, an error message is returned. If the record type is not provided n the payload, the default record type (triage) is used.
  • Employee— The system performs a lookup to the person account and the record type is ignored. This lookup can be done in the following ways:
    • Using the referenceId that corresponds to the Salesforce record ID.
    • Using sourceSystemId. For an employee, this ID is typically the employee ID or employee number. If a match is found, the contact encounter participant record is created with the contact field lookup pointing to the matched person account. If a match is not found, this record is rejected and an error message is provided in the response.
  • Patient—The system performs a lookup to the person account and the record type is ignored. This lookup can be done in the following ways:
    • Using the referenceId that corresponds to the Salesforce record ID.
    • Using sourceSystemId. For a patient, this ID is the patient ID from an external source system. If a match is found, the contact encounter participant record is created with the contact_id lookup pointing to the matched person account. If a match is not found, this record is rejected and an error message is provided in the response.

Note: Only one value is allowed.
contactTracingEncounters.​participants.referenceId String The ID of an existing patient or employee record in the Salesforce system. If a payload has both the referenceID and the sourceSystemID, the referenceID is used for the patient or the employee lookup.
contactTracingEncounters.​participants.sourceSystemId String For a patient, the patient ID from an external source system at participant level. For an employee, the employee number representing the employee record in the Salesforce or the external system. If a payload has both the referenceID and the sourceSystemID, the referenceID is used for the patient or employee lookup.
contactTracingEncounters.​participants.recordTypeName String The name for the record type. The value for this field must be exactly the same as the label of the record type in the user interface. This field is used only when contactTracingEncounters.​participants.participantType is set to lead.
contactTracingEncounters.​participants.startTime DateTime The time when the encounter started.
contactTracingEncounters.​participants.duration Integer Required. The duration of the encounter in minutes.
contactTracingEncounters.​participants.firstName String Required. The first name of the participant. This field is used only when contactTracingEncounters.​participants.participantType is set to lead.

Note: If participants.referenceId is provided, this field is optional.

contactTracingEncounters.​participants.lastName String Required. The last name of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType is set to lead.

Note: If participants.referenceId is provided, this field is optional.

contactTracingEncounters.​participants.age Integer The age of the encounter participant.
contactTracingEncounters.​participants.phoneNumber String The phone number of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType is set to lead.
contactTracingEncounters.​participants.emailAddress String The email address of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType​ is set to lead.
contactTracingEncounters.​participants.address String The address of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​participants.address.city String The city of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​participants.address.state String The state of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​participants.address.country String The country of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​participants.address.postalCode String The postal code of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​participants.address.street String The street of the encounter participant. This field is used only when contactTracingEncounters.​participants.participantType ​is set to lead.
contactTracingEncounters.​location Object (reference to location) Identifies the location of the encounter.
contactTracingEncounters.​location.name String Required. The name of the location where the encounter took place. If the encounter location name already exists in the system, the existing location record is used and the following 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
contactTracingEncounters.​location.description String The description of the location where the encounter took place.
contactTracingEncounters.​location.latitude String The latitude coordinate of the location where the encounter took place.
contactTracingEncounters.​location.longitude String The longitude coordinate of the location where the encounter took place.
contactTracingEncounters.​location.encounteraddress.city String The city where the encounter took place.
contactTracingEncounters.​location.encounteraddress.state String The state where the encounter took place.
contactTracingEncounters.​location.encounteraddress.country String The country where the encounter took place.
contactTracingEncounters.​location.encounteraddress.postalCode String The postal code of the location where the encounter took place.
contactTracingEncounters.​location.encounteraddress.street String The street where the encounter took place.
## 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, "employee" : null, "errors" : null, "id" : "0hbxx00000000GBAAY", "lead" : null, "patient" : { "created" : false, "id" : "001xx000003GZ6tAAG" } } \] } \], "errors" : null, "status" : null, "success" : true } # ContactPoint The ContactPoint FHIR resource maps to the Contact​Point​Phone​ object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [ContactPoint](https://www.hl7.org/fhir/datatypes.html#ContactPoint) map to the fields in Salesforce. Table 1. ContactPoint - Salesforce | Contact Point Resource | Salesforce Field | ​Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | system | Contact​Point​Phone​.Phone​Type | Picklist | 0.1 | While FHIR defines contact​Point​​.system as a reference to a code set bundle, the Salesforce implementation is a picklist. | | value | Contact​Point​Phone​.Telephone​Number | Phone | 0.1 | While FHIR defines contact​Point​​.value as a string, Contact​Point​Phone​.Telephone​Number is a phone data type. | | value | Contact​Point​Phone​.Area​Code | String | 0.1 | N/A | | value | Contact​Point​Phone​.Extension​Number | String | 0.1 | N/A | | value | Contact.​Email | ​Email | 0.1 | While FHIR defines contact​Point​​.value as a string, Contact.​Email is an email data type. | | use | Contact​Point​Phone​.Usage​Type | Picklist | 0.1 | While FHIR defines contact​Point​​.use as a code, the Salesforce implementation is a picklist. | | use | Contact​Point​Email​.Usage​Type | Picklist | 0.1 | While FHIR defines contact​Point​​.use as a code, the Salesforce implementation is a picklist. | | rank | Contact​Point​Phone​.Preference​Rank | Double | 0.1 | N/A | | rank | Contact​Point​Email​.Preference​Rank | Double | 0.1 | N/A | | period | Contact​Point​Phone​.Active​From​Date​ | ​Date​ | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation of contact​Point​​.period is flattened to a set of from and to dates. | | period | Contact​Point​Phone​.Active​To​​Date​ | ​Date​ | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation of contact​Point​​.period is flattened to a set of from and to dates. | | period | Contact​Point​Email​.Active​From​Date​ | ​Date​ | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation of contact​Point​​.period is flattened to a set of from and to dates. | | period | Contact​Point​Email​.Active​To​​Date​ | ​Date​ | 0.1 | Because Salesforce doesn’t support a native period data type, the Salesforce implementation of contact​Point​​.period is flattened to a set of from and to dates. | # ContactPointBestContactTime Represents the optimal time to visit associated contact point addresses. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the account associated with the contact point address. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ContactPointReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the contact point address linked to the best contact times associated with the account. This field is a polymorphic relationship field. - **Relationship Name**: ContactPointReference - **Refers To**: ContactPointAddress ### DayOfWeek - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The day of the week associated with the best contact time record. - **Possible values**: - Friday - Monday - Saturday - Sunday - Thursday - Tuesday - Wednesday ### FromTime - **Type**: time - **Properties**: Create, Filter, Sort, Update - **Description**: The best from time to reach the account. ### FromTimeHours - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The best from time hours to reach the account. This field is a calculated field. ### FromTimeInHours - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The best from time in hours to reach the account. This field is a calculated field. ### FromTimeMinutes - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The best from time minutes to reach the account. This field is a calculated field. ### IndividualId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the individual associated with the contact point address. This field is a relationship field. - **Relationship Name**: Individual - **Refers To**: Individual ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the contact point best contact time record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID the territory associated with the best time record. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ### ToTime - **Type**: time - **Properties**: Create, Filter, Sort, Update - **Description**: The best to time to reach the account. ### ToTimeHours - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The best to time hours to reach the account. This field is a calculated field. ### ToTimeMinutes - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The best to time minutes to reach the account. This field is a calculated field. ### BestTimeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the best time record. Possible values are: - Appointment Required - Best Time - Closed - My Best Time - Open ## 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. [ContactPointBestContactTimeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointBestContactTimeFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ContactPointBestContactTimeHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ContactPointBestContactTimeShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ContactPointConsent Standard and custom fields extend the standard Contact Point Consent object to represent information about a customer's consent to be contacted via a specific contact point. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ContactPointConsent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointconsent.htm) ## Fields ### ContactPointId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the contact point record through which the customer consents to be contacted. This field is a polymorphic relationship field. - **Relationship Name**: ContactPoint - **Refers To**: ContactPointAddress, ContactPointEmail, ContactPointPhone, ContactPointSocial # ContactPointSocial Represents social media identifiers or contact points for an individual or account. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the contact point social record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the account or contact's parent record. This field is a polymorphic relationship field. - **Relationship Name**: ParentReferenceRecord - **Refers To**: Account, Individual ### ProfilePictureUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link or URL to the contact or account's profile picture on a social platform. ### SocialHandleIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID associated with the contact or account's profile on a social platform. ### SocialHandleName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the contact or account's profile on the social platform. ### SocialPlatformProvider - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the social platform the profile is from. - **Possible values**: - WeChat - X - Facebook - WhatsApp ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [ContactPointSocialChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointSocialFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ContactPointSocialHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ContactPointSocialShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Content Document Input Input representation for documents linked to the care request record. ## Root XML tag ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | category | String | The category that the supporting content belongs to. This is unavailable for PATCH requests. | Required | 63.0 | | id | String | ID of the clinical document present in the ContentDocument object. | Required | 55.0 | | reason | String | The code representing the reason why the supporting content is required. This is unavailable for PATCH requests. | Optional | 63.0 | | sequence | String | The sequence number of the content when multiple contents are available. This is unavailable for PATCH requests. | Optional | 63.0 | # Content Document Output Content document output representation. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | id | String | The ID of the content document. | Big, 57.0 | 57.0 | # Content Management Use these resources to manage customer content. - **[Bulk Presentation (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_bulk_presentation.htm)** Create a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associated metadata. The JSON payload includes metadata for both the presentation and each page within the presentation. This metadata can include details such as the presentation name, activation date, and page-level information. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). - **[Bulk Presentation (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_bulk_presentation_patch.htm)** Update a presentation and its associated content in bulk. You can upload presentation files as PDF or ZIP and associating metadata. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). - **[Email Template (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_bulk_email_template.htm)** Create an email template. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). - **[Email Template (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_bulk_email_template_patch.htm)** Update an email template.The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). - **[Presentation Page Product (POST, PATCH)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_page_products.htm)** Create or update (delete) product and guidance associations for a presentation page. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). # Content Management Output Represents the information about the job status and any associated messages returned for Content Management APIs. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isSuccess | Boolean | Indicates whether the request was successfully accepted or processed. | Small, 65.0 | 65.0 | | message | String | Message that provides details about the request outcome. | Small, 65.0 | 65.0 | | errors | List | List of errors that occurred during the request validation. | Small, 65.0 | 65.0 | | jobId | String | Job ID of the asynchronous processing of the request. | Small, 65.0 | 65.0 | ## Example { "isSuccess": true, "message": "Create Presentation Request Accepted for processing", "errors": \[\], "jobId": "20V\*\*\*\*\*\*\*\*\*\*" } # CoverageBenefit Represents the benefits provided to a covered member by a purchaser’s plan. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### BenefitNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the benefits available to the member under this plan’s coverage. ### BenefitPeriodEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Last day of the coverage benefit period. ### BenefitPeriodStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First day of the coverage benefit period. ### CareBenefitVerifyRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care benefit verify request associated with the coverage benefit. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: CareBenefitVerifyRequest - **Relationship Type**: Lookup - **Refers To**: CareBenefitVerifyRequest ### CoinsuranceNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the contribution the member makes towards treatment. ### CopayNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information on the copayment amounts members contributes. ### CoverageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: General category of service covered. - **Possible values**: - Dental - Medical - Vision - Home Health - This picklist value is available for the Home Health feature in API version 59.0 and later. - Pharmacy - This picklist value is available for the Pharmacy Benefits Verification feature in API version 63.0 and later. See [Activate Picklist Value for Coverage Benefit](https://help.salesforce.com/s/articleView?id=ind.lsc_admin_pharmacy_benefits_verification_configure_picklist_field.htm&type=5&language=en_US) to activate this value. ### DeductibleNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the member’s deductibles under this plan. ### Disclaimer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Overall plan benefit disclaimers. ### EmergencyDepartmentCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards emergency treatment. ### FamilyInNetworkDeductibleApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has paid for health care provided by the health plan’s preferred providers for all family members. ### FamilyInNetworkDeductibleLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member is required to pay for health care provided by the health plan’s preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. ### FamilyInNetworkDeductibleRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining amount the member still has to pay for health care provided by the health plan’s preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. ### FamilyInNetworkOutofPocketApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of the member has paid in this coverage year for health care provided by the health plan’s preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FamilyInNetworkOutofPocketLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most the member pays during the coverage year for health care provided by the health plan’s preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FamilyInNetworkOutofPocketRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining amount for the member to pay during this coverage year for care provided by the plan’s preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FamilyOutofNetworkDeductibleApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has paid for health care provided by non-preferred providers for all family members. ### FamilyOutofNetworkDeductibleLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount the member has to pay for health care provided by non-preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. ### FamilyOutofNetworkDeductibleRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member still has to pay for health care provided by non-preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. ### FamilyOutofNetworkOutofPocketApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of the member has paid in this coverage year for health care provided by non-preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FamilyOutofNetworkOutofPocketLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most the member pays during the coverage year for health care provided by non-preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FamilyOutofNetworkOutofPocketRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining amount for the member to pay during this coverage period for health care provided by non-preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### FinalCoverageStatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code that's determined after considering the restrictions and other status types that apply to the coverage benefit. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: FinalCoverageStatusCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### FrequencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency type of the coverage benefit associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. - **Possible values**: - Daily - Fortnightly - Monthly - Quarterly - Weekly - Yearly ### IndividualInNetworkDeductibleApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has paid for health care provided by the health plan’s preferred providers to the most costly family member. ### IndividualInNetworkDeductibleLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has to pay for health care provided by the plan’s preferred providers for any family member. When this amount is reached, the plan starts to contribute towards treatment. ### IndividualInNetworkDeductibleRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining amount the member has to pay for care during the coverage year provided by the plan’s preferred providers for any family member. When this amount is reached, the plan starts to contribute towards treatment. ### IndividualInNetworkOutofPocketApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of the member has paid in this coverage year for health care provided by the plan’s preferred providers to any one family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualInNetworkOutofPocketLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most the member pays during the coverage year for health care provided by the health plan’s preferred providers for any family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualInNetworkOutofPocketRemaining - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount remaining for the member to pay during the coverage year for care provided by the plan’s preferred providers for any family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualOutofNetworkDeductibleApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has paid for health care provided by non-preferred providers to the most costly family member. ### IndividualOutofNetworkDeductibleLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has to pay for health care provided by non-preferred providers to any one family member. When this amount is reached, the plan starts to contribute towards treatment. ### IndividualOutofNetworkDeductibleRemain - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining amount the member has to pay for health care during the coverage year provided by non-preferred providers to any family member. When this amount is reached, the plan starts to contribute towards treatment. ### IndividualOutofNetworkOutofPocketApplied - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of the member has paid in this coverage period for health care provided by non-preferred providers to any family members. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualOutofNetworkOutofPocketLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most the member pays during the coverage year for health care provided by non-preferred providers to any family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualOutofNetworkOutofPocketRemain - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount remaining for the member to pay during the coverage year for health care provided by non-preferred providers to any family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### InNetworkCoinsuranceAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards treatment undertaken by the health plan’s preferred providers. ### InNetworkCoinsurancePercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of treatment cost the member pays for treatment undertaken by the health plan’s preferred providers. ### InNetworkLifetimeMaximum - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has to pay during lifetime coverage under this plan after which the provider covers all costs for treatment provided by its preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the coverage benefit is currently in force. - **Default value**: false ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LifetimeMaximumNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information on the lifetime maximum payments the member Will be expected to make. ### MemberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the member receiving these benefits. ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the member plan receiving these benefits. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of these coverage benefits. ### OutcomeStatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The outcome code set associated with the coverage benefit. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: OutcomeStatusCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### OutofNetworkCoinsuranceAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards treatment undertaken by non-preferred providers. ### OutofNetworkCoinsurancPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of treatment cost the member pays for treatment undertaken by non-preferred providers. ### OutofNetworkLifetimeMaximum - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member has to pay during lifetime coverage under this plan after which the plan provider covers all costs for treatment provided by its non-preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### OutofPocketNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the out-of-pocket payment the member makes. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PharmaCopayAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards the pharma products. This field is available in API version 62.0 and later with the Manage Financial Assistance Program permission set. ### PrimaryCareCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards primary care treatment. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this benefits record was obtained from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this benefits record on its source system. ### SourceSystemModified - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which these benefits were last changed on their source system. ### SpecialistCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards specialist consultations. ### StatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status code set associated with the coverage benefit. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Pharmacy Benefits Verification permission set. - **Relationship Name**: StatusCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### TotalBenefitAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of the coverage benefit associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. ### UrgentCareCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount the member contributes towards urgent care. ### VerificationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date on which the benefit was verified. ## Associated Objects This object has these 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. [CoverageBenefitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [CoverageBenefitFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CoverageBenefitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CoverageBenefitOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CoverageBenefitShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CoverageBenefitItem Specific service covered by the insurance plan. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BenefitCategory - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the category this benefit is in. ### CodeSetServiceTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of a Code Set Service Type in the Code Set object. This is a relationship field. - **Relationship Name**: CodeSetServiceType - **Relationship Type**: Lookup - **Refers To**: CodeSet ### CoverageBenefitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the covered benefit this item belongs to. This is a relationship field. - **Relationship Name**: CoverageBenefit - **Relationship Type**: Lookup - **Refers To**: CoverageBenefit ### CoverageLevel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the level of coverage provided by this item. ### DoesDeductibleApply - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the benefit item requires a prior expenditure by the patient. - **Default value**: false ### FrequencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency type of the coverage benefit item associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. - **Possible values**: - Daily - Fortnightly - Monthly - Quarterly - Weekly - Yearly ### InNetworkCoverage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the in network coverage provided by this item. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the benefit item is currently available. - **Default value**: false ### IsInPlanNetwork - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the benefit is available only in-network (true) or both in-network and out-of-network (false). - **Default value**: false ### IsPreauthorizationRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the service must be approved before use. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MemberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the member receiving this benefit item. This is a relationship field. - **Relationship Name**: Member - **Relationship Type**: Lookup - **Refers To**: Account ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of this coverage benefit item. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about this coverage benefit item. ### OutofNetworkCoverage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the coverage for non-preferred providers. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ServiceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of service this plan benefit item provides. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp indicating when the current user last viewed a related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### ServiceTypeCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code for the type of service this plan benefit item provides. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this coverage benefits item record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the CoverageBenefitItem in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The ID of this coverage benefits item record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this coverage benefits item was last changed on the source system. ### TimePeriod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the period this plan benefit item covers. ## 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. [CoverageBenefitItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # CoverageBenefitItemLimit Allows 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AllowedLimit - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Maximum amount that will be paid for the service. ### AllowedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum quantity allowed of the coverage benefit item. This field is available in API Version 62.0 and later. ### AllowedQuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the allowed quantity of the coverage benefit item. This field is a relationship field. This field is available in API Version 62.0 and later. - **Relationship Name**: AllowedQuantityUnit - **Refers To**: UnitOfMeasure ### AppliedLimit - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the benefit has been claimed. ### AppliedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of the coverage benefit item already used by the member. This field is available in API Version 62.0 and later. ### AppliedQuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the applied quantity of the coverage benefit item. This field is a relationship field. This field is available in API Version 62.0 and later. - **Relationship Name**: AppliedQuantityUnit - **Refers To**: UnitOfMeasure ### CareLimitTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the limit is a required payment or excluded service. This is a relationship field. - **Relationship Name**: CareLimitType - **Relationship Type**: Lookup - **Refers To**: CareLimitType ### CoverageBenefitItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specific service covered by the insurance plan. This is a relationship field. - **Relationship Name**: CoverageBenefitItem - **Relationship Type**: Lookup - **Refers To**: CoverageBenefitItem ### CoverageLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the persons eligible for the benefit item. - **Possible values**: - EmployeeSpouse—Employee & Spouse - Family - Individual ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### LimitNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General information about the limit. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the coverage benefit item limit. ### NetworkType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the benefit refers to in-network providers or out-of-network providers. If the related CoverageBenefitItem record has an IsInPlanNetwork value of true, NetworkType is typically In. If the related record has an IsInPlanNetwork value of false, NetworkType can be any value. - **Possible values**: - In—In-network providers - NA—Not applicable - Out—Out-of-network providers ### PriorityOrder - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: This limit's position in the sequence for calculating limits. ### TermType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of time period during which the benefit item is available. - **Possible values**: - Calendar Year - Day - Month - Year to Date ## 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. [CoverageBenefitItemLimitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CoverageBenefitItemLimitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Create or Update Care Authorization Request Result Response to create or update care services review request. ## JSON example { "code": "SUCCESS", "isSuccess": true, "result": \[ { "created": true, "id": "0Umxx0000004FA9CAM", "objectType": "CareRequest", "relatedRecords": \[ { "created": true, "id": "0VDxx0000004DwLGAU", "objectType": "CareRequestDrug" }, { "created": true, "id": "0VKxx0000004DwMGAU", "objectType": "CareRequestItem" }, { "created": true, "id": "0VKxx0000004DwNGAU", "objectType": "CareRequestItem" }, { "created": true, "id": "0VCxx0000004DwMGAU", "objectType": "CareDiagnosis" }, { "created": true, "id": "0VCxx0000004DwNGAU", "objectType": "CareDiagnosis" }, { "created": true, "id": "06Hxx0000004DWbEAM", "objectType": "CareRequestReviewer" }, { "created": true, "id": "06Hxx0000004DWcEAM", "objectType": "CareRequestReviewer" }, { "created": true, "id": "06Hxx0000004DWdEAM", "objectType": "CareRequestReviewer" }, { "created": true, "id": "06Hxx0000004DWeEAM", "objectType": "CareRequestReviewer" }, { "created": true, "id": "06Hxx0000004DWfEAM", "objectType": "CareRequestReviewer" } \] } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Care Authorization returned code | Small, 46.0 | 46.0 | | isSuccess | Boolean | Flag to indicate if the request was successful. | Small, 46.0 | 46.0 | | message | String | If there is any error, this property contains the error message. | Small, 46.0 | 46.0 | | outputResults | [Care Authorization Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_request_output.htm "Output of create or update request for care services review.")\[\] | Care Authorization Request results output | Small, 46.0 | 46.0 | | result | [Care Authorization Request Result](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_authorization_request_resul.htm "Result of POST or PATCH request.")\[\] | Care Authorization Request result | Small, 46.0 | 46.0 | # Create Provider This API creates healthcare provider records along with the corresponding Account records (for facilities) or Contact records (for practitioners). You can also use it to manage information about practitioner credentials. - **[Use Cases](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_use_cases)** The Create Provider API is mainly intended to support the operations of payer employees who handle provider records, such as credentialing specialists. - **[Prerequisites](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_api)** Notes about lookups - **[Supported Fields](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_fields)** The Create provider API supports all standard and custom fields. - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_resource)** Details and JSON samples - **[Code Samples](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_samples)** Here are some JSON samples that you can use as a starting point to build request bodies and interpret responses. - **[Error Handling](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api_errors)** This API supports bulk transactions, but Healthcare Provider records are committed one at a time. An input request can succeed in full or in part. Each provider included in the request succeeds or fails on its own. ## Use Cases The Create Provider API is mainly intended to support the operations of payer employees who handle provider records, such as credentialing specialists. ### Credentialing Specialist Goals: - Create provider records. - Collect and store credential-related data. Activities: - When the provider has gone through the lead process, add maximum credential information to it so supervisor can make an approval decision. - When a new provider is added to the Health Plan Network, add its contact to the system so call center agent can direct patients to that new provider. - When new information is received about a provider, edit its contact info so the provider information is up to date. Success Measures: - Account, Contact, and HealthCareProvider records are created. - Records in related entities (optionally, for example in License, Person Education, Operating Hours, Specialty records) can be created if customer provides values in the JSON. - Data created can be viewed and edited according to user’s access permission. ## Prerequisites Notes about lookups To ensure uniqueness, when you create a HealthcareProviderSpecialty record with a SpecialtyId lookup field, a CareSpecialty record must exist with the CareSpecialty.SpecialtyCode field populated. When you create a HealthcareProviderTaxonomy record, a CareTaxonomy.TaxonomyCode field must exist. When you create a HealthcareFacilityNetworkSame record, a HealthcarePayerNetwork.Code field must exist. You can look up to Operating Hours records if they exist, or create Operating Hours records via API. For all other lookups, information should be provided in this format: "AccountId":{ "value":"101", "referenceField":"HCGA\_\_SourceSystemId\_\_c" } In this example, - AccountId is the API name of the lookup field you want to populate. - referenceField is the field on the lookup object to establish the relationship. You can choose any reference field for these lookups as long as the values are unique. - value is the value of the referenceField. When a single request includes multiple lookups to an object, use the same reference field for all those lookups. For example, suppose you have created custom lookup fields to the Account object in HealthcareProviderSpecialty and healthcareTaxonomy. The lookup fields are called C\_Account1 and C\_Account2. Account1 record has its sourceSystem field set to A1, and Account2 record has the sourceSystem field set to A2. You want C\_Account1 to be populated with the Account1 record and C\_Account2 to be populated with Account2. The reference field to find the account record is SourceSystem. If sourceSystem is A1, you get the Account1 record, and if sourceSystem is A2 you get the Account2 record. HealthcareFacilityNetwork has lookups to Account, Practitioner and HealthcarePractitionerFacility. You can create a HealthcareFacilityNetwork record in an input request in any of these ways: - Create a record with an account lookup for the facility you are creating. - Create a record with a practitioner lookup for the practitioner you are creating. - Create a record with a lookup to HealthcarePractitionerFacility for a practitioner at a given facility. Apex is not directly supported. However, you can call this API using the [HttpRequest Apex](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_restful_http_httprequest.htm) class. ## Supported Fields The Create provider API supports all standard and custom fields. Any field that is required in the object specification is required in JSON request bodies for this API. All fields specified in your JSON request body must be writable. The user must have read-write access. If no user input is provided, the Name field is populated automatically using this format: HealthcareProviderSpecialty entity: Jimmy James Specialty - 10\-20\-20 11:22:33 ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - Users can edit the Name field after it has been auto-populated. - When a user enters data from the UI, the Name field is not auto-populated. If person accounts are enabled, use the recordType parameter in your input to identify a person account. If you are updating a practitioner record that has already been created, you only need practitioner ID, not Account or Contact. ## Resources Details and JSON samples ### Resource /connect/health/providers ### Available Version 49.0 and later ### Authentication Replace {token} with the OAuth access token. Authorization: Bearer **{token}** ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note The Lightning Platform REST API supports OAuth 2.0 (an open protocol to allow secure API authorization). See [Authorize Apps with OAuth](https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm&language=en_US "HTML (New Window)") in Salesforce Help for more details. ### HTTP Methods POST ### Supported Objects | Object | Required | Auto-filled Name field | Required Fields | Input/Output JSON key name | | --- | --- | --- | --- | --- | | Account (for facility) or Contact (for practitioner) | No | NA | | account/contact | | AccountContactRelationship | No | Yes | | providerAffliations | | Accreditation | No | Yes | Name | accreditations | | Award | No | Yes | Name | awards | | BoardCertification | No | Yes | Name | boardCertifications | | BusinessLicense | No | Yes | Name | businessLicenses | | CareProviderAdverseAction | No | Yes | Name | careProviderAdverseActions | | CareProviderFacilitySpecialty | No | Yes | Name | facilitySpecialties | | ContactProfile | No | Yes | | contactProfile | | HealthcareFacilityNetwork | No | Yes | Name | facilityNetworks | | HealthcarePractitionerFacility | No | Yes | Name | practitionerFacilities | | HealthcareProvider | Yes | Yes | Name | healthcareProvider | | HealthcareProviderNpi | No | Yes | Name | npi | | HealthcareProviderSpecialty | No | Yes | Name | specialties | | HealthcareProviderTaxonomy | No | Yes | Name | taxonomies | | HealthcareProviderService | No | Yes | | providerServices | | HlthCareProvTreatedCondition | No | Yes | | treatedConditions | | Identifier | No | | | | | OperatingHours | No | Yes | Name, TimeZone | operatingHours | | PersonEducation (Practioner only) | | Yes | Name | personEducations | | PersonEmployment (Practitioner only) | | Yes | Name, RelatedPerson (Account/Contact) | personEmployments | | TimeSlots | No | No | OperatingHours, StartTime, EndTime, DayOfWeek | TimeSlots | ## Code Samples Here are some JSON samples that you can use as a starting point to build request bodies and interpret responses. - Associate a practitioner with a facility. Each Contact record must have an associated Account record. - Use the API name of the field, such as RecordType, not the label, such as Record Type. - Strings with trailing spaces aren’t supported. - The comments in these samples aren't meant to be valid JSON. ### Sample Input: Create a Practitioner { "providers": \[{ "type": "practitioner", "contact": { "fields": { "FirstName": "Rachel", "LastName": "Green", "Description" : "Rachel is a specialist surgeon." } }, "healthcareProvider": { "fields": { "ProviderType": "Medical Doctor", "ProviderClass": "Solo Practitioner" } } }\] } ### Sample Input - Create a Practitioner from an Existing Contact ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note In the sample input, the reference field can be any unique field. { "providers": \[{ "type": "practitioner", "contact": { "id": { "value": "003RM000007FnBvYAK", "referenceField": "Id" } }, "healthcareProvider": { "fields": { "ProviderType": "Physician", "EffectiveFrom": "2019-01-01 00:00:00" } } }\] } ### Sample Input - Create a Practitioner as a Person Account { "providers": \[ { "type": "practitioner", "account":{ "fields":{ "FirstName":"Jimmy", "LastName":"James", "Email":"jj@newsradio.com", "About": "Jimmy James is a doctor.", "RecordType": "PersonAccount" } }, "healthcareProvider":{ "fields":{ "ProviderType":"Physician", "EffectiveFrom":"2019-01-01", } } \] } ### Sample Input - Create a Practitioner to Be Synced for Provider Search ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note To use the following code sample, ensure that the org has: - A facility Account record (Id 001RM000005J5UTYA0 in the code sample) - CareSpecialty records (SpecialtyCode 15 and 22 in the code sample) { "providers": \[{ "type": "practitioner", "contact": { "fields": { "FirstName": "Will", "LastName": "Doc", "Email": "WillDoc@gmail.com", "Description": "Will is a doctor." } }, "healthcareProvider": { "fields": { "ProviderType": "Medical Doctor", "ProviderClass": "Solo Practitioner" } }, "npis": \[{ "fields": { "Npi": "WD-14", "NpiType": "Individual", "IsActive": true } }\], "specialties": \[{ "fields": { "SpecialtyId": { "value": "15", "referenceField": "SpecialtyCode" }, "SpecialtyRole": "Specialist", "IsActive": true } }, { "fields": { "SpecialtyId": { "value": "22", "referenceField": "SpecialtyCode" }, "SpecialtyRole": "Dual", "IsActive": true } } \], "practitionerFacilities": \[{ "fields": { "AccountId": { "value": "001RM000005J5UTYA0", "referenceField": "Id" }, "IsActive": true }, "facilityNetworks": \[{ "fields": { "PayerNetworkId": { "value": "PPO", "referenceField": "Code" }, "IsActive": true, "LowestValidAge": 0, "PanelStatus": "Panel open", "PanelLimit": 100 } }, { "fields": { "PayerNetworkId": { "value": "HMO", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Female", "LowestValidAge": 0, "PanelStatus": "Panel open", "PanelLimit": 100 } } \], "facilitySpecialties": \[{ "fields": { "SpecialtyId": { "value": "15", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Specialist", "IsActive": true } }\] } \] } \] } ### Sample Input - Create a Facility { "providers": \[{ "type": "facility", "account": { "fields": { "Name": "Geller Clinic", "Description": "Geller Clinic is an eye clinic.", "Website": "gellerclinic.com" }, "operatingHours": { "fields": { "Name": "GellerClinicHours", "Description": "MWTF8-5" }, "timeSlots": \[{ "fields": { "DayOfWeek": "Monday", "StartTime": "09:00:00", "EndTime": "17:30:00" } }\] } }, "healthcareProvider": { "fields": { "ProviderType": "MedicalDoctor", "EffectiveFrom": "2019-01-01" } } }\] } ### Sample Input - Create a Facility from an Existing Account { "providers": \[{ "type": "facility", "account": { "id": { "value": "Geller Clinic", "referenceField": "Name" } }, "healthcareProvider": { "fields": { "ProviderType": "MedicalDoctor", "EffectiveFrom": "2019-01-01" } } }\] } ### Sample Input - Create a Facility to Be Synced for Provider Search ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note To use the following code sample, ensure that the org has a Specialty record (SpecialtyCode 15 in the code sample). { "providers": \[{ "type": "facility", "account": { "fields": { "Name": "UCSF Hospital", "Description": "Test UCSF hospital", "Website": "UCSFHospital21@test.com" }, "operatingHours": { "fields": { "Name": "UCSF Hospital Hours", "Description": "MWTF8-5" }, "timeSlots": \[{ "fields": { "DayOfWeek": "Monday", "StartTime": "09:00:00", "EndTime": "17:30:00" } }\] } }, "healthcareProvider": { "fields": { "ProviderType": "Hospital", "Status": "Active", "EffectiveFrom": "2019-01-01" } }, "npis": \[{ "fields": { "Npi": "UCSFH21", "NpiType": "Organization", "IsActive": true } }\], "specialties": \[{ "fields": { "SpecialtyId": { "value": "15", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Specialist", "EffectiveFrom": "2019-01-01", "EffectiveTo": "2036-01-01", "IsActive": true } }\], "boardCertifications": \[{ "fields": { "CertificationType": "Dermatology", "ExpirationDate": "2030-11-12", "Status": "Certified" } }\] }\] } ### Sample Input - Create a Practitioner with All Possible Related Objects ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Before you use the code sample, create existing lookup records in your org for the following objects: - Care Specialty - Care Taxonomy - Operating Hours - Healthcare Payer Network - Account for Healthcare Practitioner Facility \[ { "providers": \[ { "type": "practitioner", "contact": { "fields": { "FirstName": "Jimmy", "LastName": "James", "Email": "jj@newsradio.com", "Description": "Jimmy James is a doctor.", "AccountId": "001xx000003GbOJAA0" } }, "contactProfile": { "fields": { "Ethnicity": "Asian.", "Race": "Asian" } }, "healthcareProvider": { "fields": { "ProviderType": "Physician", "EffectiveFrom": "2019-01-01", "ProviderPhotoId": "069xx0000004CDsAAM" } }, "providerAffiliations": \[ { "fields": { "AccountId": { "value": "001xx000003GbPvAAK", "referenceField": "Id" } } } \], "treatedConditions": \[ { "fields": { "ConditionId": { "value": "118xx000000MbKkAAK", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "providerServices": \[ { "fields": { "HealthcareServiceId": { "value": "13xxx0000004C92AAE", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "npis": \[ { "fields": { "Npi": "12345123", "NpiType": "Individual", "IsActive": true } } \], "specialties": \[ { "fields": { "SpecialtyId": { "value": "20", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Specialist", "EffectiveFrom": "2019-01-01", "EffectiveTo": "2020-01-01", "IsActive": true } }, { "fields": { "SpecialtyId": { "value": "24", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": false, "SpecialtyRole": "Dual", "EffectiveFrom": "2019-01-01", "EffectiveTo": "2020-01-01", "IsActive": true } } \], "taxonomies": \[ { "fields": { "TaxonomyId": { "value": "207X00000X", "referenceField": "TaxonomyCode" }, "IsPrimaryTaxonomy": true, "SourceSystemIdentifier": "", "EffectiveFrom": "2019-01-01", "EffectiveTo": "2020-01-01", "IsActive": true } }, { "fields": { "TaxonomyId": { "value": "208200000X", "referenceField": "TaxonomyCode" }, "IsPrimaryTaxonomy": false, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2020-01-01", "IsActive": true } } \], "facilityNetworks": \[ { "fields": { "IsActive": true, "GenderRestriction": "None", "HighestValidAge": 99, "LowestValidAge": 10, "PanelStatus": "Panel open", "PanelLimit": 10 } } \], "facilityServices": \[ { "fields": { "HealthcareServiceId": { "value": "13xxx0000004C92AAE", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "practitionerFacilities": \[ { "fields": { "AccountId": { "value": "001xx000003GdxzAAC", "referenceField": "Id" }, "LowestValidAge": 12, "OperatingHoursId": { "value": "123", "referenceField": "phone\_\_c" } }, "providerFacilityServices": \[ { "fields": { "HealthcareServiceId": { "value": "13xxx0000004C92AAE", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "facilityNetworks": \[ { "fields": { "PayerNetworkId": { "value": "EB0012397", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Male", "HighestValidAge": 99, "LowestValidAge": 5, "PanelStatus": "Panel open", "PanelLimit": 10 } }, { "fields": { "PayerNetworkId": { "value": "UH23029", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Female", "HighestValidAge": 99, "LowestValidAge": 5, "PanelStatus": "Panel open", "PanelLimit": 10 } } \], "facilitySpecialties": \[ { "fields": { "SpecialtyId": { "value": "20", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Specialist" } } \] }, { "fields": { "AccountId": { "value": "001xx000003GdxzAAC", "referenceField": "Id" }, "InitialStartDate": "2018-05-12" }, "facilityNetworks": \[ { "fields": { "PayerNetworkId": { "value": "UH23029", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Male", "HighestValidAge": 99, "LowestValidAge": 5, "PanelStatus": "Panel open", "PanelLimit": 10 } }, { "fields": { "PayerNetworkId": { "value": "UH23039", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Male", "HighestValidAge": 99, "LowestValidAge": 5, "PanelStatus": "Panel open", "PanelLimit": 10 } } \], "facilitySpecialties": \[ { "fields": { "SpecialtyId": { "value": "28", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Dual" } } \] } \], "boardCertifications": \[ { "fields": { "CertificationType": "Dermatology", "Status": "Certified" } } \], "awards": \[ { "fields": { "AwardDate": "2019-08-15 17:30:00", "AwardedBy": "Barack Obama" } } \], "businessLicenses": \[ { "fields": { "Name": "Pediatric lab technician", "Status": "Draft" } } \], "accreditations": \[ { "fields": { "Type": "Hospital", "SubType": "Children's", "AccreditingBody": "Joint Commission", "Status": "Accreditated", "SourceSystem": "Aetna-SF", "SourceSystemIdentifier": "abcd1234" } }, { "fields": { "Type": "Clinic", "SubType": "Children's", "AccreditingBody": "Joint Commission", "Status": "Verifying" } } \], "personEducations": \[ { "fields": { "Name": "MedicalDegree", "EducationLevel": "Masters", "IsActive": true } } \], "personEmployments": \[ { "fields": { "AnnualIncome": "400000", "EmployerPhone": "4148767000" } } \], "careProviderAdverseActions": \[ { "fields": { "AccreditationId": { "value": "123", "referenceField": "SourceSystemIdentifier" }, "ActionType": "Disciplinary", "Status": "Verified" } }, { "fields": { "AccreditationId": { "value": "123", "referenceField": "SourceSystemIdentifier" }, "ActionType": "Disciplinary", "Status": "Verified" } } \] } \] }, { "providers": \[ { "type": "practitioner", "contact": { "fields": { "FirstName": "Rachel", "LastName": "Green", "Description": "Rachel is a specialist surgeon." } }, "contactProfile": { "fields": { "Ethnicity": "Asian.", "Race": "Asian" } }, "healthcareProvider": { "fields": { "ProviderType": "Medical Doctor", "ProviderClass": "Solo Practitioner", "ProviderPhotoId": "069xx0000004CDsAAM" } }, "providerAffiliations": \[ { "fields": { "AccountId": { "value": "001xx000003GbPvAAK", "referenceField": "Id" } } } \], "treatedConditions": \[ { "fields": { "ConditionId": { "value": "118xx000000MbKkAAK", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "providerServices": \[ { "fields": { "HealthcareServiceId": { "value": "13xxx0000004C92AAE", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "practitionerFacilities": \[ { "fields": { "AccountId": { "value": "001xx000003GYikAAG", "referenceField": "Id" }, "IsActive": true }, "facilityNetworks": \[ { "fields": { "PayerNetworkId": { "value": "PPO", "referenceField": "Code" }, "IsActive": true, "LowestValidAge": 0, "PanelStatus": "Panel open", "PanelLimit": 100 } }, { "fields": { "PayerNetworkId": { "value": "HMO", "referenceField": "Code" }, "IsActive": true, "GenderRestriction": "Female", "LowestValidAge": 0, "PanelStatus": "Panel open", "PanelLimit": 100 } } \], "providerFacilityServices": \[ { "fields": { "HealthcareServiceId": { "value": "13xxx0000004C92AAE", "referenceField": "Id" }, "EffectiveFrom": "2019-01-01", "EffectiveTo": "2029-01-01", "IsActive": true } } \], "facilitySpecialties": \[ { "fields": { "SpecialtyId": { "value": "15", "referenceField": "SpecialtyCode" }, "IsPrimarySpecialty": true, "SpecialtyRole": "Specialist", "IsActive": true } } \] } \] } \] } \] ### Sample Output Response for Creating a Practitioner with All Possible Related Objects { "providers": \[ { "code": "201", "isSuccess": true, "message": "1 successfully processed - 0 failed", "providers": \[ { "accreditations": \[ { "fields": {}, "id": "0Vlxx0000004CSOCA2" }, { "fields": {}, "id": "0Vlxx0000004CSPCA2" } \], "awards": \[ { "fields": {}, "id": "0cFxx00000000XtEAI" } \], "boardCertifications": \[ { "fields": {}, "id": "0YSxx00000000b7GAA" } \], "businessLicenses": \[ { "fields": {}, "id": "0cExx00000000BJEAY" } \], "careProviderAdverseActions": \[ { "fields": {}, "id": "0etxx00000000HlAAI" }, { "fields": {}, "id": "0etxx00000000HmAAI" } \], "code": "201", "contact": { "fields": {}, "id": "003xx000004WmIiAAK" }, "contactProfile": { "fields": {}, "id": "11Axx0000004bCTEAY" }, "facilityNetworks": \[ { "fields": {}, "id": "0bYxx00000000srEAA" } \], "healthcareProvider": { "fields": {}, "id": "0cmxx00000003HFAAY" }, "message": "SUCCESS", "npis": \[ { "fields": {}, "id": "0bNxx00000000rFEAQ" } \], "personEducations": \[ { "fields": {}, "id": "0Srxx0000004CIiCAM" } \], "personEmployments": \[ { "fields": {}, "id": "0Stxx0000004CPACA2" } \], "practitionerFacilities": \[ { "facilityNetworks": \[ { "fields": {}, "id": "0bYxx00000000ssEAA" }, { "fields": {}, "id": "0bYxx00000000stEAA" } \], "facilitySpecialties": \[ { "fields": {}, "id": "0bXxx00000000ZVEAY" } \], "fields": {}, "id": "0bSxx00000000srEAA", "identifiers": \[\], "providerFacilityServices": \[ { "fields": {}, "id": "15Mxx0000004CgvEAE" } \] }, { "facilityNetworks": \[ { "fields": {}, "id": "0bYxx00000000suEAA" }, { "fields": {}, "id": "0bYxx00000000svEAA" } \], "facilitySpecialties": \[ { "fields": {}, "id": "0bXxx00000000ZWEAY" } \], "fields": {}, "id": "0bSxx00000000ssEAA", "identifiers": \[\], "providerFacilityServices": \[\] } \], "providerAffiliations": \[ { "fields": {}, "id": "07kxx0000004D0HAAU" } \], "providerServices": \[ { "fields": {}, "id": "15Mxx0000004CguEAE" } \], "specialties": \[ { "fields": {}, "id": "0bOxx00000000WHEAY" }, { "fields": {}, "id": "0bOxx00000000WIEAY" } \], "taxonomies": \[ { "fields": {}, "id": "0bPxx00000000WHEAY" }, { "fields": {}, "id": "0bPxx00000000WIEAY" } \], "treatedConditions": \[ { "fields": {}, "id": "1K4xx0000004D3UCAU" } \], "type": "practitioner" } \] }, { "code": "201", "isSuccess": true, "message": "1 successfully processed - 0 failed", "providers": \[ { "accreditations": \[\], "awards": \[\], "boardCertifications": \[\], "businessLicenses": \[\], "careProviderAdverseActions": \[\], "code": "201", "contact": { "fields": {}, "id": "003xx000004Wj6KAAS" }, "contactProfile": { "fields": {}, "id": "11Axx0000004aebEAA" }, "facilityNetworks": \[\], "healthcareProvider": { "fields": {}, "id": "0cmxx0000000149AAA", "providerServices": \[ { "fields": {}, "id": "15Mxx0000004CLwEAM" } \], "treatedConditions": \[ { "fields": {}, "id": "1K4xx0000004ClkCAE" } \] }, "message": "SUCCESS", "npis": \[\], "personEducations": \[\], "personEmployments": \[\], "practitionerFacilities": \[ { "facilityNetworks": \[ { "fields": {}, "id": "0bYxx00000000CvEAI" }, { "fields": {}, "id": "0bYxx00000000CwEAI" } \], "facilitySpecialties": \[ { "fields": {}, "id": "0bXxx00000000BJEAY" } \], "fields": {}, "id": "0bSxx00000000CvEAI", "identifiers": \[\], "providerFacilityServices": \[ { "fields": {}, "id": "15Mxx0000004CLxEAM" } \] } \], "specialties": \[\], "taxonomies": \[\], "type": "practitioner" } \] } \] } ### Sample Output Response - Partial Success { "code": "207", "message": "all good", "success": true, "providers": \[ { "type": "facility", "code" : "", "message" : "Specialty Code "409" not found" "success" : false, "healthcareProvider" : { "fields":{ "ProviderType":"Physician", "EffectiveFrom":"2019-01-01" } } }, { "type": "practitioner", "code": "200", "message": "all good", "success": true, "Contact":{ "id": "" }, "healthcareProvider":{ "id": "provider id" "fields":{ "ProviderType":"Physician", "EffectiveFrom":"2019-01-01", "Hc4a\_\_language\_\_c" : "Spanish", "Hc4a\_\_emergencyContactId\_\_c" : { "value" : "SF21083209", "referenceField" : "id" } } }, "npis":\[{ "id": "npi id" }\], "specialties":\[ { "id": "specialty id" } \], "taxonomies":\[ { "id": "taxonomy id" } \], "practitionerFacilities":\[ { "id": "pract. fac. id", "facilityNetworks": \[ { "id": "payer. network id" }, { "id": "payer. network id" } \], "facilitySpecialties": \[ { "id": "fac. spec. id" } \] } \], "boardCertifications" : \[ { "id": "board certification id" } \], "awards" : \[ { "id": "award id" } \] } \] } ## Error Handling This API supports bulk transactions, but Healthcare Provider records are committed one at a time. An input request can succeed in full or in part. Each provider included in the request succeeds or fails on its own. For each record requested, HealthcareProvider creation is rolled back, along with any Account or Contact records created, at the first error for the request. If one related object fails, the remaining related objects are not attempted. For example, if an input request contains 50 provider records and 10 of those records fail, the remaining 40 records are created. You only need to resubmit the failed providers, not the whole request. ### Response Codes | Error Code | Http Status Code | Error Message | | --- | --- | --- | | Bad Request | 400 | Your request contains invalid data types. Correct the value in section
, field . | | INSUFFICIENT\_ACCESS | 403 | You don't have permission to perform this action on records. Contact your Salesforce admin for help. | | "ResourceApiException CANNOT\_INSERT\_UPDATE\_ACTIVATE\_ENTITY" | | Account: bad field names on insert/update call: Namea | | "ResourceApiException CANNOT\_INSERT\_UPDATE\_ACTIVATE\_ENTITY" | | sObject type 'HealthcareProvider' is not supported. If you are attempting to use a custom object, be sure to append the '\_\_c' after the entity | | "ResourceApiException CANNOT\_INSERT\_UPDATE\_ACTIVATE\_ENTITY" | | Required fields are missing: \[Name\] | | Exception | | Invalid format of the given date-time object | | Bad Request | 400 | There is no input in the request body. Resubmit the request with valid input in the request body. | | Bad Request | 400 | We couldn't parse the JSON input. Restructure the JSON and try again. | | Too Many Requests | 429 | Your request contains records. Reduce the number of records to fewer than and try again. | | Wrong Record Type | | An Account record is required for a facility. Resubmit the request with an Account record. | | Too Many Record Types | | Resubmit the request with an Account record or a Contact record but not both. | | Specify Provider Type | | Provider type is not specified. Resubmit the request indicating provider type as facility or practitioner. | | Bad Request | 400 | "Out of Array of allowed Values(picklist) - for static picklist" | | | | PersonAccount isnt enabled in the org, if input request is for a PA | | | | Lookup not found, Specialty Code for eg | | Bad Request | 400 | Missing required fields on standard objects | # Create Visit Output Output representation of the create visit request. ## JSON Example { "code": "201", "errorCode": "", "errorMessage": "", "status": "Success", "visitId": "" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Code returned by the create visit request. | Small, 55.0 | 55.0 | | errorCode | String | Error code with information about the error. | Small, 55.0 | 55.0 | | errorMessage | String | Message stating the reason for error, if any. | Small, 55.0 | 55.0 | | status | String | Status of the create visit request. | Small, 55.0 | 55.0 | | visitId | String | ID of the visit record that is created. | Small, 55.0 | 55.0 | # Create Visit Request Input Input representation of the create visit request. ## Root XML tag ## JSON Example { "visitType": "08qSG00000017VhYAI", "place": "131SG0000006yazYAA", "plannedVisitStartTime": "2023-12-28T09:07:21.205-07:00", "status": "Planned", "account": "001SG00000Cq7T8YAJ", "visitor": \[ { "user": "005SG000003Z0p9YAC", "primary": true } \], "productRequired": \[ { "productId": "01tSG000000KOxRYAW", "quantity": 1 } \] } ## Properties
Name Type Description Required or Optional Available Version
account String ID of the account that is associated with a visit. Required 55.0
actionPlanTemplate Action Plan Template Input Represents the details of an action plan template. Action plan templates define the sets of tasks that your sales reps perform during visits. Optional 55.0
context String Purpose of the visit, such as claim or work type. Optional 55.0
place String Indicates the place that sales representatives visit. Required 55.0
plannedVisitEndTime String Date and time when the visit is expected to end. Optional 55.0
plannedVisitStartTime String Date and time when the visit is expected to start. Required 55.0
productRequired Product Required Attributes Input[] Represents the products required for the visit. Required 55.0
status String Indicates the status of the visit.
Valid values are:
  • Abondoned
  • Completed
  • InProgress
  • Planned
 Optional 55.0
statusRemarks String Additional remarks or comments provided by the sales representatives. Optional 55.0
visitPriority String Priority of the visit.
Valid values are:
  • High
  • Low
  • Medium
 Optional 55.0
visitType String ID of the visit type. This field is a lookup to the Worktype object. Optional 55.0
visitedParty Visited Party Attributes Input[] Represents the contacts from the customer organization who are being visited. Optional 55.0
visitor Visitor Attributes Input[] Represents the service resources from the organization who are executing the visit. Required 55.0
# createEmailTemplate(emailTemplateInput) Create an email template with the provided metadata. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.GenericResponseOutputRepresentation createEmailTemplate(ConnectApi.EmailTemplateInputRepresentation emailTemplateInput) ## Parameters emailTemplateInput Type: [ConnectApi.EmailTemplateInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_email_template_input.htm "Input representation for creating or updating an email template.") Input representation that contains the metadata for the email template. The fileId field is not accepted in this Apex representation. ## Return Value Type: [ConnectApi.GenericResponseOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_output_generic_response_output.htm "Output representation for a generic response from a Connect API call.") ## Example ConnectApi.EmailTemplateInput input = new ConnectApi.EmailTemplateInput(); input.name = 'Sample Email Template'; input.id = 'email-template-id'; input.emailSubject = 'Email Subject'; input.description = 'Email template description'; input.contentDocumentId = '069SB0000047U0mYAE'; input.activatedDate = Date.today(); input.deactivatedDate = Date.today().addDays(365); input.senderType = 'SalesRep'; input.senderEmailFieldAPIName = 'noreply@company.com'; input.replyToType = 'SalesRep'; input.replyToEmailAddress = 'support@company.com'; input.bccEmailIdList = 'admin@company.com'; input.isActive = true; input.isDefaultAutoEmailTemplate = false; input.isSubjectLineEditable = true; input.shouldIgnoreEmailConsent = false; input.surveyId = '0KdYH0000000VyH0AU'; input.productId = '1KeYH0000001j2m0AA'; input.communicationSubscriptionId = 'comm-sub-source-system-id'; input.automatedEmailContextType = 'ProviderVisit'; input.automatedEmailActionType = 'Create'; input.languages = new List(); input.languages.add('es\_AD'); input.languages.add('es'); input.topics = new List(); input.topics.add('Onboarding'); input.topics.add('User Engagement'); input.customFields = new List(); ConnectApi.CustomFieldRepresentation customField1 = new ConnectApi.CustomFieldRepresentation(); customField1.fieldName = 'Email\_Template\_Category\_\_c'; customField1.fieldValue = 'Product Information'; input.customFields.add(customField1); ConnectApi.CustomFieldRepresentation customField2 = new ConnectApi.CustomFieldRepresentation(); customField2.fieldName = 'Priority\_\_c'; customField2.fieldValue = 'High'; input.customFields.add(customField2); System.debug(ConnectApi.LifeSciEmailTemplate.createEmailTemplate(input)); # createPresentationContent(presentationContentInput) Create new presentation content with the provided metadata. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.GenericResponseOutputRepresentation createPresentationContent(ConnectApi.PresentationContentInputRepresentation presentationContentInput) ## Parameters presentationContentInput Type: [ConnectApi.PresentationContentInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_presentation_content_input.htm "Input representation for creating or updating presentation content.") Input representation that contains the metadata for the presentation content. The fileId field is not accepted in this Apex representation. ## Return Value Type: [ConnectApi.GenericResponseOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_output_generic_response_output.htm "Output representation for a generic response from a Connect API call.") ## Example ConnectApi.PresentationContentInputRepresentation input = new ConnectApi.PresentationContentInputRepresentation(); input.contentType = 'PRESENTATION\_PDF'; ConnectApi.PresentationInput presentation = new ConnectApi.PresentationInput(); presentation.name = 'PDF Presentation Name'; presentation.id = 'pdf-presentation-id'; presentation.enableDoubleTapZoom = true; presentation.enablePinchZoom = true; presentation.playerGesture = 'SWIPEUP'; presentation.activationDate = Date.today(); presentation.deactivationDate = Date.today().addDays(365); input.presentation = presentation; input.pages = new List(); ConnectApi.PresentationPageInput page1 = new ConnectApi.PresentationPageInput(); page1.pageNumber = 1; page1.name = 'PDF Page 1 Name'; page1.id = 'pdf-page-name-1'; page1.mandatory = true; page1.contentDocumentId = '069SB0000048cPDYAY'; page1.activationDate = Date.today(); page1.deactivationDate = Date.today().addDays(365); ConnectApi.ProductGuidanceRepresentation product1 = new ConnectApi.ProductGuidanceRepresentation(); product1.productId = '1KeYH0000001j2m0AA'; product1.guidanceIds = new List(); product1.guidanceIds.add('guidance-id-1'); product1.guidanceIds.add('guidance-id-2'); page1.products = new List(); page1.products.add(product1); input.pages.add(page1); ConnectApi.PresentationPageInput page2 = new ConnectApi.PresentationPageInput(); page2.pageNumber = 2; page2.name = 'PDF Page 2 Name'; page2.id = 'pdf-page-name-2'; page2.mandatory = true; page2.activationDate = Date.today(); page2.deactivationDate = Date.today().addDays(365); input.pages.add(page2); System.debug(ConnectApi.LifeSciPresentation.createPresentationContent(input)); # createPresPageProductGuidance(pageProductInput) Create a new association between products and guidance with a presentation page. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.GenericResponseOutputRepresentation createPresPageProductGuidance(ConnectApi.PageProductInputRepresentation pageProductInput) ## Parameters pageProductInput Type: [ConnectApi.PageProductInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_page_product_input.htm "Input representation for creating or deleting product guidance associations on a presentation page.") Input representation that contains the presentation page ID and a list of associated products and guidances. ## Return Value Type: [ConnectApi.GenericResponseOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_output_generic_response_output.htm "Output representation for a generic response from a Connect API call.") ## Example ConnectApi.ProductContentInputRepresentation input = new ConnectApi.ProductContentInputRepresentation(); input.pageProducts = new List(); ConnectApi.PresentationPageProductRepresentation pageProduct = new ConnectApi.PresentationPageProductRepresentation(); pageProduct.id = 'pdf-page-name-1'; pageProduct.products = new List(); ConnectApi.ProductGuidanceRepresentation product = new ConnectApi.ProductGuidanceRepresentation(); product.productId = '1KeYH0000001j2m0AA'; product.guidanceIds = new List(); product.guidanceIds.add('guidance-id-1'); product.guidanceIds.add('guidance-id-2'); pageProduct.products.add(product); input.pageProducts.add(pageProduct); System.debug(ConnectApi.LifeSciPresPageProductGuidance.createPresPageProductGuidance(input)); # CustodyChainEntry Represents information about an entry or event in the chain of custody. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentTaskId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The assessment task for which a custody chain entry is created. This field is a relationship field. - **Relationship Name**: AssessmentTask - **Relationship Type**: Lookup - **Refers To**: AssessmentTask ### CustodianId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user, organization, or location that has custody of the item. This field is a polymorphic relationship field. - **Relationship Name**: Custodian - **Relationship Type**: Lookup - **Refers To**: Account, Contact, ServiceTerritory, User ### CustodyItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent custody item that's associated with the custody chain entry record. This field is a relationship field. - **Relationship Name**: CustodyItem - **Relationship Type**: Master-Detail - **Refers To**: CustodyItem ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the custody chain entry record of the item. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of custody chain entry the item. ### EnrolleeWorkOrderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The care program enrollee work order for which a custody chain entry is created. This field is a relationship field. - **Relationship Name**: EnrolleeWorkOrder - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWorkOrder ### EnrolleeWorkOrderStepId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The care program enrollee work order step for which a custody chain entry is created. This field is a relationship field. - **Relationship Name**: EnrolleeWorkOrderStep - **Relationship Type**: Lookup - **Refers To**: CarePgmEnrolleeWkOrdStep ### ItemCustodySiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place where the item is held in custody. This field is a polymorphic relationship field. - **Relationship Name**: ItemCustodySite - **Relationship Type**: Lookup - **Refers To**: Address, Location, ServiceTerritory ### ItemVerificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of verification for the item. - **Possible values**: - DualSignature - FiveSignatures - FourSignatures - NoSignature - NotApplicable - SingleSignature - ThreeSignatures ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the custody chain entry record. ### RecordUpdateInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores information about the update in the custody chain entry for which the record was created. ### ReferenceObjectApiName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The API name of the reference object storing the stage, step, or task, or the custom object record for which the custody chain entry is created. For internal use only. - **Possible values**: - AssessmentTask—Assessment Task - CarePgmEnrolleeWkOrdStep—Care Program Enrollee Work Order Step - CarePgmEnrolleeWorkOrder—Care Program Enrollee Work Order - ForecastingItem\_\_hd—Forecasting Item (Historical) ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The stage, step, task, or any custom object for which the custody entry is created. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: AssessmentTask, CarePgmEnrolleeWkOrdStep, CarePgmEnrolleeWorkOrder ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of custody chain entry for the item. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the custody entry record. - **Possible values**: - Completed - New - Rejected ### StatusCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category of the custody entry record's status. - **Possible values**: - Completed - New - Rejected ### VerificationProcessType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of process in which a verification is performed. - **Possible values**: - Parallel - Sequential ## 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. [CustodyChainEntryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CustodyChainEntryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CustodyChainEntryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # CustodyItem Represents information about an item in the custody chain. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of the item that's in custody. ### CollectionDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the custody item was collected. ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the item that's in custody. ### ExternalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The external identifier for the custody item or the custody chain. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the item that's in custody. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ReferenceItemObjectApiName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The API name of the reference object that stores the record of the item that's in custody. For internal use only. - **Possible values**: - CareProgramEnrollee - The API name of any custom object created in the org. ### ReferenceItemRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the reference object that stores the record of the item that's in custody. This field is a relationship field. - **Relationship Name**: ReferenceItemRecord - **Relationship Type**: Lookup - **Refers To**: CareProgramEnrollee ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the item that's in custody. ### SubjectId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The subject for which a custody item is collected. This field is a polymorphic relationship field. - **Relationship Name**: Subject - **Relationship Type**: Lookup - **Refers To**: CareProgramEnrollee ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The usage of the custody item in an application or cloud. For internal use only. - **Possible values**: - Healthcare - RequestForProposal ## 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. [CustodyItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CustodyItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CustodyItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CustodyItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CustodyItemShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # CustodyVerfcTypeOverride Represents information about the verification of an entry in the chain of custody. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country for which the custody event is configured. This field is a relationship field. - **Relationship Name**: Country - **Relationship Type**: Lookup - **Refers To**: GeoCountry ### CustodyVerificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of verification required for a custody event. - **Possible values**: - DualSignature - FiveSignatures - FourSignatures - NoSignature - NotApplicable - SingleSignature - ThreeSignatures ### DigitalVerificationSetupId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The digital verification setup associated with the override. This field is a relationship field. - **Relationship Name**: DigitalVerificationSetup - **Relationship Type**: Lookup - **Refers To**: DigitalVerificationSetup ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the custody verification override record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the custody verification override record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Priority - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The priority number assigned to the conditions that apply to the custody verification. ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory for which custody is being configured. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### TaskName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The task for which the custody event is being configured. ### WorkProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work procedure for which custody is being configured. This field is a relationship field. - **Relationship Name**: WorkProcedure - **Relationship Type**: Lookup - **Refers To**: WorkProcedure ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type for which custody is being configured. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### WorkTypeStepId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type step for which custody is being configured. This field is a relationship field. - **Relationship Name**: WorkTypeStep - **Relationship Type**: Lookup - **Refers To**: WorkTypeStep ## 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. [CustodyVerfcTypeOverrideChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [CustodyVerfcTypeOverrideFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CustodyVerfcTypeOverrideHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CustodyVerfcTypeOverrideOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [CustodyVerfcTypeOverrideShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Custom Field Value The output representation of the custom field values.
Property Name Type Description Filter Group and Version Available Version
dataType String Specifies the primitive data type of a field.
Possible values are:
  • Boolean
  • DateOnly
  • DateTime
  • Number
  • String
  • TimeOnly
 Small, 53.0 53.0
fieldName String The name of the custom field. Small, 53.0 53.0
fieldValue Object The value of the custom field. Small, 53.0 53.0
message String A message with any errors that can encounter while processing the request. Small, 53.0 53.0
# Custom Field Value Input Adds additional information to any fields not mapped by the medication statement API. ## Root XML tag ## JSON example { "CustomFieldValue": \[ { "fieldName": "Laterality\_\_c", "dataType": "picklist", "fieldValue": "Bilateral", } \] } ## Properties
Name Type Description Required or Optional Available Version
dataType String Specifies the primitive data type of a field.
Possible values are:
  • Boolean
  • DateOnly
  • DateTime
  • Number
  • String
  • TimeOnly
 Required 53.0
fieldName String The name of the field. Required 53.0
fieldValue Object The value of the field. Required 53.0
# Customer Account Merge Output Output representation of the response for a successful account merge operation. ## JSON example { "code": "", "success": true, "message": "", "mergedAccountIds": \[ { "accountId": "001xx000002kl8xxFV" }, { "accountId": "001xx000003mn9xxGW" } \] } ## Properties | Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Code that represents the status of the operation. | Small, 65.0 | 65.0 | | merged​AccountIds | String\[\] | List of the Consolidated Account IDs that were successfully merged. | Small, 65.0 | 65.0 | | message | String | Message related to the status of the operation. | Small, 65.0 | 65.0 | | success | Boolean | Indicates whether the entire merge operation was successful. | Small, 65.0 | 65.0 | # Customer Engagement These objects are available for Life Sciences Customer Engagement. - [Account Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Business License](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_businesslicense.htm) - [Business License Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_businesslicenseproduct.htm) - [Care Specialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_carespecialty.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Best Contact Time](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointbestcontacttime.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Contact Point Social](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointsocial.htm) - [Formulary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_formulary.htm) - [Formulary Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_formularyitem.htm) - [Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) - [Group Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_groupmember.htm) - [Healthcare Provider](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovider.htm) - [Healthcare Provider NPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovidernpi.htm) - [Healthcare Provider Specialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareproviderspecialty.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Object Territory Association](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_objectterritory2association.htm) - [Party Publication](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_partypublication.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Account Product Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctproductinfo.htm) - [Provider Account Territory Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctterritoryinfo.htm) - [Provider Account Territory Summary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdaccountterritorysummary.htm) - [Provider Account User Group Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdaccountusergroupinfo.htm) - [Provider Affiliation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideraffiliation.htm) - [Provider Affiliation Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideraffiliationproduct.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Additional Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_useradditionalinfo.htm) - [User Territory Association](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_userterritory2association.htm) - [Activity Plans](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_activity_plans.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Activity Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplan.htm) - [Activity Plan Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplanterritory.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Activity Goal](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoal.htm) - [Provider Activity Goal Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoalmeasure.htm) - [Provider Activity Goal Measure Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdactvtygoalmeasureprodt.htm) - [Provider Activity Measure Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitymeasuretype.htm) - [Provider Activity Plan Adjustment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractvtyplanadjusment.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) - [App Alerts](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_app_alerts.htm) - [App Alert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalert.htm) - [App Alert Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalertterritory.htm) - [App Alert User Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_appalertuserresponse.htm) - [Record Alert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_recordalert.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Commercial Configuration](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_commercial_configuration.htm) - [Life Science Metadata Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadataassignment.htm) - [Life Science Metadata Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatacategory.htm) - [Life Science Metadata Field Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatafieldvalue.htm) - [Life Science Metadata Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimetadatarecord.htm) - [Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_profile.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Consent Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_consent_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Communication Subscription](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscription.htm) - [Communication Subscription Channel Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_commsubscriptionchanneltype.htm) - [Communication Subscription Consent](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscriptionconsent.htm) - [Communication Subscription Consent Compliance Snapshot](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_commsubconsentcmplsnpsht.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Contact Point Social](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_contactpointsocial.htm) - [Data Use Purpose](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_datausepurpose.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Engagement Channel Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_engagementchanneltype.htm) - [Individual](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_individual.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Event Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_event_management.htm) - [Activity Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplan.htm) - [Estimated Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_estimatedexpense.htm) - [Event Management Participant Role](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtparticipantrole.htm) - [Event Management Participant Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtparticipanttype.htm) - [Event Management Participant Type Role Mapping](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtptcptyperolemap.htm) - [Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_expense.htm) - [Expense Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expenseparticipant.htm) - [Expense Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expensetype.htm) - [Expert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expert.htm) - [Expert Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expertsubject.htm) - [Managed Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngevent.htm) - [Managed Event Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventparticipant.htm) - [Managed Event Participant Discrepancy](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventparticipantdiscrepancy.htm) - [Managed Event Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventproduct.htm) - [Managed Event Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventresource.htm) - [Managed Event Resource Preference](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventresourcepreference.htm) - [Managed Event Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventterritory.htm) - [Managed Event Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventtype.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Forum](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationforum.htm) - [Provider Activity Goal](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoal.htm) - [Provider Activity Goal Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoallimit.htm) - [Provider Activity Goal Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoalmeasure.htm) - [Provider Activity Measure Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitymeasuretype.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [Subject Material Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectmaterialtemplate.htm) - [Subject Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectproduct.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) - [Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budget.htm) - [Budget Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetcategory.htm) - [Budget Category Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetcategoryvalue.htm) - [Budget Managed Event Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetmngeventtype.htm) - [Budget Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetperiod.htm) - [Budget Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetproduct.htm) - [Budget Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetterritory.htm) - [Estimated Expense Participant Allocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_estimatedexpenseptcpalloc.htm) - [Event Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplan.htm) - [Event Plan Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanbudget.htm) - [Event Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanitem.htm) - [Event Plan Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanparticipant.htm) - [Event Plan Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanproduct.htm) - [Event Plan Service Specialization](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplansvcspclzn.htm) - [Event Plan Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplansubject.htm) - [Event Plan Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanterritory.htm) - [Geo Country](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_geocountry.htm) - [Managed Event Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventbudget.htm) - [Restricted Party](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_restrictedparty.htm) - [Field Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_field_email.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Communication Subscription](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscription.htm) - [Communication Subscription Consent](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscriptionconsent.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Document Link](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemail.htm) - [Life Science Email Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemailfragment.htm) - [Life Science Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtemplate.htm) - [Life Science Email Template Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplfragment.htm) - [Life Science Email Template Related Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplrelafrgmt.htm) - [Life Science Email Template Snapshot](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplsnapshot.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Party Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpartyaccess.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Survey](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_survey.htm) - [Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_task.htm) - [Territory Content Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territorycontenttmplasgnt.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [General Events](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_general_events.htm) - [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_event.htm) - [Event Relation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_eventattendee.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Intelligent Content](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_intelligent_content.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Document Link](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtemplate.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Click Stream Entry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationclickstrmentry.htm) - [Presentation Forum](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationforum.htm) - [Presentation Linked Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationlinkedpage.htm) - [Presentation Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpage.htm) - [Presentation Page Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpageproduct.htm) - [Presentation Party Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpartyaccess.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisit.htm) - [Provider Visit Detailing Product Message](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitdtlproductmsg.htm) - [Provider Visit Product Detailing](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitproddetailing.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Key Account Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_key_account_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Account Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_accountplan.htm) - [Account Plan Objective](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_accountplanobjective.htm) - [Account Plan Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanparticipant.htm) - [Account Plan Participant Stakeholder](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_acctplanptcpstakeholder.htm) - [Account Plan Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanproduct.htm) - [Account Plan Related Object Analysis](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanrelaobjanalysis.htm) - [Account Plan Relationship](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanrelationship.htm) - [Account Plan Stakeholder](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstakeholder.htm) - [Account Plan Stakeholder Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstkhldraction.htm) - [Account Plan Stakeholder Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstkhldrproduct.htm) - [Action Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplan.htm) - [Action Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplanitem_kam.htm) - [Action Plan Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplate.htm) - [Action Plan Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplateassignment.htm) - [Action Plan Template Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitem.htm) - [Action Plan Template Item Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitemvalue_kam.htm) - [Action Plan Template Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateversion_kam.htm) - [Assessment Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_assessmenttask.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Goal Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goalassignment.htm) - [Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinition.htm) - [Goal Definition Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinitionproduct.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Account Product Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctproductinfo.htm) - [Sprint](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_sprint.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory.htm) - [Territory Business Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territorybusinessplan.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Lists and Filters](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_lists_and_filters.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Life Science Account List](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceaccountlist.htm) - [Life Science Account List Column](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciaccountlistcolumn.htm) - [Life Science Account List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctlistfiltercrit.htm) - [Life Science Account List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciaccountlistmember.htm) - [Life Science Account List Object](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceaccountlistobject.htm) - [Medical Inquiries](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_medical_inquiries.htm) - [Case](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_case.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Inquiry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiry.htm) - [Inquiry Question](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiryquestion.htm) - [Inquiry Question Answer](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiryquestionanswer.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Medical Insights](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_medical_insights.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Goal Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goalassignment.htm) - [Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinition.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Medical Insight](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsight.htm) - [Medical Insight Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightaccount.htm) - [Medical Insight Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightgoaldef.htm) - [Medical Insight Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Reaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_userreaction.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Mobile Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_mobile_metadata.htm) - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Mobile Metadata Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimobilemetadatarecord.htm) - [Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_profile.htm) - [Mobile Sync](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_mobile_sync.htm) - [Device Sync Summary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesyncsummary.htm) - [Device Sync Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransaction.htm) - [Device Sync Transaction Log](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransactionlog.htm) - [Device Sync Transaction Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransactionrecord.htm) - [Next Best](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_next_best.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Life Science Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemail.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Managed Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngevent.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Territory Account Product Message Score](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryacctprodmsgscore.htm) - [Territory Account Recommended Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryacctrcmdaction.htm) - [Territory Account Score](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryaccountscore.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Order Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_order_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Action Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplan.htm) - [Action Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplanitem_kam.htm) - [Action Plan Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_actionplantemplate_custom_fields.htm) - [Action Plan Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplateassignment.htm) - [Action Plan Template Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_actionplantemplateitem_custom_fields.htm) - [Action Plan Template Item Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitemvalue.htm) - [Action Plan Template Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateversion_pec.htm) - [Actionable List](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionablelist.htm) - [Actionable List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelistfiltercriteria.htm) - [Actionable List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionablelistmember.htm) - [Assessment Indicator Defined Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmentindicatordefinedvalue.htm) - [Assessment Indicator Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assessmentindicatordefinition_custom_fields.htm) - [Assessment Indicator Definition Extension](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_asmtinddefext.htm) - [Assessment Indicator Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmentindicatorvalue.htm) - [Assessment Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_assessmenttask.htm) - [Assessment Task Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmenttaskdefinition.htm) - [Assessment Task Indicator Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmenttaskindicatordefinition.htm) - [Assortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortment_custom_fields.htm) - [Assortment Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortmentproduct_custom_fields.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Distribution Channel](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_distributionchannel.htm) - [Document Recipient](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_documentrecipient.htm) - [Life Science Account Group Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctgrpassignment.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Life Science Product Account Restriction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciproductacctrstrc.htm) - [Payment Term](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_paymentterm.htm) - [Price Adjustment Schedule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentschedule.htm) - [Price Adjustment Tier](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_priceadjustmenttier.htm) - [Pricebook](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_pricebook2.htm) - [Pricebook Entry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_pricebookentry.htm) - [Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Product Catalog](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcatalog.htm) - [Product Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcategory.htm) - [Product Category Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcategoryproduct.htm) - [Product Selling Model](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productsellingmodel.htm) - [Product Selling Model Option](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productsellingmodeloption.htm) - [Product Territory Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterritoryavailability.htm) - [Product Territory Detailed Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterrdtlavailability.htm) - [Provider Account Territory Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctterritoryinfo.htm) - [Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quote_custom_fields.htm) - [Quote Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_quotedocument.htm) - [Quote Document Creation Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_quotedocumentcreationevent.htm) - [Quote Line Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quotelineitem_custom_fields.htm) - [Retail Store KPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailstorekpi_custom_fields.htm) - [Retail Visit KPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailvisitkpi_custom_fields.htm) - [Sales Transaction Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_salestransactiontype.htm) - [Store Assortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_storeassortment_custom_fields.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Unit Of Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_unitofmeasure.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Product Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_product_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Life Science Product Account Restriction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciproductacctrstrc.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product Territory Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterritoryavailability.htm) - [Product Territory Detailed Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterrdtlavailability.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Visit Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_provider_visit_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Action Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplan.htm) - [Assessment Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_assessmenttask.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_expense.htm) - [Expense Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expenseparticipant.htm) - [Expense Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expensetype.htm) - [Inquiry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiry.htm) - [Life Science Account List](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceaccountlist.htm) - [Life Science Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemail.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Medical Insight](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsight.htm) - [Presentation Click Stream Entry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationclickstrmentry.htm) - [Presentation Forum](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationforum.htm) - [Product Disbursement](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productdisbursement.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Provider Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisit.htm) - [Provider Visit Detailing Product Message](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitdtlproductmsg.htm) - [Provider Visit Marketing Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitmarketingitem.htm) - [Provider Visit Product Detailing](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitproddetailing.htm) - [Provider Visit Product Discussion](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitproddiscussion.htm) - [Provider Visit Requested Sample](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitrqstsample.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Video Call](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocall.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Visitor](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visitor.htm) - [Remote Engagement](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_remote_engagement.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Video Call](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocall.htm) - [Video Call Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocallparticipant.htm) - [Video Call Participant Request](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_videocallptcprequest.htm) - [Video Call Participant Session](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_videocallptcpsession.htm) - [Video Call Recording](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocallrecording.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Samples Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_samples_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_address.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Inventory Count Assessment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventorycountassessment.htm) - [Inventory Count Product Batch Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventorycntprodtbatchitem.htm) - [Inventory Operation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventoryoperation.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Location](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_lsclocation.htm) - [Product Disbursement](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productdisbursement.htm) - [Product Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_productitem.htm) - [Product Item Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_productitemtransaction.htm) - [Product Request](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_productrequest_custom_fields.htm) - [Product Request Line Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_productrequestlineitem_fields.htm) - [Product Transfer](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_product_transfer_custom_fields.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Production Batch](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productionbatch.htm) - [Provider Sample Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimit.htm) - [Provider Sample Limit Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimittemplate.htm) - [Provider Sample Limit Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersmpllmttmplassignment.htm) - [Provider Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisit.htm) - [Provider Visit Requested Sample](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitrqstsample.htm) - [Provider Visit Sample Limit Discrepancy](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdvstsmpllmtdiscrepancy.htm) - [Provider Visit Sample Limit Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdvstsmpllmttransaction.htm) - [Territory Product Quantity Allocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryprodtqtyallocation.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) - [Segmentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_segmentation.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Actionable List](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelist.htm) - [Actionable List Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_meta_actionablelistdefinition.htm) - [Actionable List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelistfiltercriteria.htm) - [Actionable List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_objects_actionablelistmember.htm) - [Healthcare Provider](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovider.htm) - [Life Science Account Group Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctgrpassignment.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Sample Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimit.htm) - [Provider Sample Limit Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimittemplate.htm) - [Subject Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_subject_management.htm) - [Inquiry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiry.htm) - [Medical Insight](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsight.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [Surveys](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_surveys.htm) - [Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm) - [Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_participant.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Survey](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_survey.htm) - [Survey Engagement Context](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyengagementcontext.htm) - [Survey Invitation](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyinvitation.htm) - [Survey Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveypage.htm) - [Survey Question](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyquestion.htm) - [Survey Question Choice](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyquestionchoice.htm) - [Survey Question Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyquestionresponse.htm) - [Survey Question Score](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyquestionscore.htm) - [Survey Response](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyresponse.htm) - [Survey Response Offline](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_surveyresponseoffline.htm) - [Survey Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveysubject.htm) - [Survey Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyversion.htm) - [Survey Version Additional Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_surveyversionaddinfo.htm) - [Survey Question Response Offline](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_surveyqstnresponseoffline.htm) - [System Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_system_objects.htm) - [Integration Job Run](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_integrationjobrun.htm) - [Life Science Mobile App](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciencemobileapp.htm) - [Life Science Trigger Handler](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciencetriggerhandler.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Additional Info](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_useradditionalinfo.htm) - [User Device](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_userdevice.htm) - [User Territory2 Association](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_userterritory2association.htm) - [Territory Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_territory_management.htm) - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Care Specialty](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_carespecialty.htm) - [Life Science Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtemplate.htm) - [Provider Account Territory Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctterritoryinfo.htm) - [Territory Geo Assignment Rule](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_terrgeoassignmentrule.htm) - [Territory Content Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territorycontenttmplasgnt.htm) - [Territory User Downtime](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryuserdowntime.htm) - [Territory Provider Affiliation Alignment Rule](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_terrprovaffilassignrule.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Workflow Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_workflow_management.htm) - [Life Science Custom Script](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciencecustomscript.htm) - [Life Science Stage Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistageaction.htm) - [Life Science Stage Object](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistageobject.htm) - [Life Science Stage Operation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistageoperation.htm) - [Life Science Stage Operation Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistageoperationaction.htm) - [Life Science Stage Operation Condition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistageoperationcondn.htm) - [Life Science Stage Path](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistagepath.htm) - [Life Science Stage Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescistagevalue.htm) # Customer Engagement Metadata Type Metadata API enables you to access some types and feature settings for Customer Engagement for Life Sciences Cloud that you can customize in the user interface. - **[ActionableListDefinition](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_meta_actionablelistdefinition.htm)** Represents the data source definition details associated with an actionable list. # Customer Engagement Tooling API Objects These Tooling API objects are available for Customer Engagement for Life Sciences Cloud. - **[LifeSciConfigAssignment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/tooling_api_objects_lifesciconfigassignment.htm)** Represents the assignments for a Life Sciences configuration record. This object is a child of LifeSciConfigRecord. - **[LifeSciConfigCategory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/tooling_api_objects_lifesciconfigcategory.htm)** Represents the category that Life Sciences configuration records are organized into. This object is available in API version 65.0 and later. - **[LifeSciConfigFieldValue](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/tooling_api_objects_lifesciconfigfieldvalue.htm)** Represents a field value for a Life Sciences configuration record. This object is a child of LifeSciConfigRecord. - **[LifeSciConfigRecord](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/tooling_api_objects_lifesciconfigrecord.htm)** Represents a configuration record for Life Sciences. This object is a child of LifeScienceConfigCategory. - **[ProviderSampleLimitTemplate](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/tooling_api_objects_providersamplelimittemplate.htm)** Contains definition and rules of sample limits templates. # CustomObjectParticipant Standard and custom fields extend the standard CustomObjectParticipant object to represent information about the individual collaborating on or who needs to be informed of the Medical Insight. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### Comments - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The additional information about the participant. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the participant is an active user in the system (true) or not (false). - **Default value**: false ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The user or group associated with this participant. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Refers To**: Group, User ### ParticipantRoleId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The role associated with the participant. This field is a relationship field. - **Relationship Name**: ParticipantRole - **Refers To**: ParticipantRole ### ReferenceObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The parent custom object record that's related to this participant record. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceObject - **Refers To**: AccountExtension\_\_c, BenefitManagementRecertification\_\_c, CustomTest\_\_c, Custom\_Test\_detail\_\_c, MetadataTestObject\_\_c, RelatedListValidation\_\_c, TestCustomField\_\_c, lsc4ce\_\_Foo\_\_c, omnistudio\_\_CardFrameworkConfiguration\_\_c, omnistudio\_\_DRBatchQueue\_\_c, omnistudio\_\_DRBulkData\_\_c, omnistudio\_\_DREncryption\_\_c, omnistudio\_\_DRWorker\_\_c, omnistudio\_\_Interface\_DRGeneric\_\_c, omnistudio\_\_TestResult\_\_c, omnistudio\_\_TriggerSetup\_\_c, omnistudio\_\_UISettings\_\_c, omnistudio\_\_VlocityDataPack\_\_c, omnistudio\_\_VlocityDocuSignTemplate\_\_c, omnistudio\_\_VlocityErrorLogEntry\_\_c, omnistudio\_\_VlocityScheduledJob\_\_c, omnistudio\_\_VlocityTrackingEntry\_\_c # CX - Extended Composite ID With Check Digit The Extended Composite ID With Check Digit (CX) HL7 segment maps to the Identifier object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for CX map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below. Table 1. CX - Salesforce | CX | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | CX.1 - ID | Identifier.IdValue | String | N/A | | CX.4 - Assigning Authority | Identifier.IssuingAuthority | Lookup: Account | N/A | | CX.5 - Identifier Type Code | Identifier.IdType | Lookup: CodeSet, CodeSet​Bundle | N/A | # Data Change Requests With Data Change Requests, organizations can implement configurable data validation processes that are tailored to their specific business needs. Validate data changes by objects and fields and configure data changes by profile and record type. Data Change Requests support controlled data synchronization of externally managed data domains. ![Data Change Requests entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_data_change_requests_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_data_change_requests.htm "HTML (New Window)"). ## Data Change Requests Objects in Life Sciences Customer Engagement - [Life Science Data Change Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescidatachangedef.htm) - [Life Science Data Change Definition Managed Field](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescidatachgdefmngfld.htm) - [Life Science Data Change Definition Record Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescidatachgdefrectype.htm) - [Life Science Data Change Persona Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescidatachgpersonadef.htm) - [Life Science Data Change Request](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescidatachangerequest.htm) - [Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_profile.htm) - [Record Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_recordtype.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # DataUsePurpose Standard and custom fields extend the standard Data Use Purpose object to represent information about the reason for contacting a prospect or customer. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: DataUsePurpose](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_datausepurpose.htm) ## Fields ### PurposeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of an object containing data specific to the data use purpose. This field is a polymorphic relationship field. - **Relationship Name**: Purpose - **Refers To**: Asset, CareProgram, CareRegisteredDevice, LifeSciMarketableProduct, Product2 # deletePresPageProductGuidance(pageProductInput) Delete the association between a presentation page and products or guidances. ## API Version 65.0 ## Requires Chatter No ## Signature public static ConnectApi.GenericResponseOutputRepresentation deletePresPageProductGuidance(ConnectApi.PageProductInputRepresentation pageProductInput) ## Parameters pageProductInput Type: [ConnectApi.PageProductInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_page_product_input.htm "Input representation for creating or deleting product guidance associations on a presentation page.") Input representation that contains the presentation page ID and a list of products and guidances to delete. ## Return Value Type: [ConnectApi.GenericResponseOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_output_generic_response_output.htm "Output representation for a generic response from a Connect API call.") ## Example ConnectApi.ProductContentInputRepresentation input = new ConnectApi.ProductContentInputRepresentation(); input.pageProducts = new List(); ConnectApi.PresentationPageProductRepresentation pageProduct = new ConnectApi.PresentationPageProductRepresentation(); pageProduct.id = 'pdf-page-name-1'; pageProduct.products = new List(); ConnectApi.ProductGuidanceRepresentation product = new ConnectApi.ProductGuidanceRepresentation(); product.productId = '1KeYH0000001j2m0AA'; product.guidanceIds = new List(); product.guidanceIds.add('guidance-id-1'); product.guidanceIds.add('guidance-id-2'); pageProduct.products.add(product); input.pageProducts.add(pageProduct); System.debug(ConnectApi.LifeSciPresPageProductGuidance.deletePresPageProductGuidance(input)); # Device The Device F​HI​R resource maps to the Asset and ​​Care​Registered​Device​ objects in Salesforce​. ## F​HI​R V4​.0 - ​Clinical ​Data ​Model ​Mapping ​Here’s how the fields defined by F​HI​R for [Device](https://www.hl7.org/fhir/device.html) map to the fields in Salesforce​. Table 1. ​Patient - Salesforce | Device ​Resource | Salesforce Field | ​Type | Salesforce ​Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | ​​​Identifier | Object | 0​.​M | The identifier information for a device is represented as Identifier records that reference the CareRegisteredDevice record using their ​​​Identifier​.​Parent​RecordId field​. | | uidCarrier​.Device​Identifier | ​​Care​Registered​Device​​.Unique​Device​Id1 | External Lookup | 0.3 | While FHIR defines uidCarrier​.Device​Identifier as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.Device​Identifier | ​​Care​Registered​Device​​.Unique​Device​Id2 | External Lookup | 0.3 | While FHIR defines uidCarrier​.Device​Identifier as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.Device​Identifier | ​​Care​Registered​Device​​.Unique​Device​Id3 | External Lookup | 0.3 | While FHIR defines uidCarrier​.Device​Identifier as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.Issuer | ​​Care​Registered​Device​​.Unique​Device​Id1​Issuer | URL | 0.3 | While FHIR defines uidCarrier​.Issuer as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.Issuer | ​​Care​Registered​Device​​.Unique​Device​Id2​Issuer | URL | 0.3 | While FHIR defines uidCarrier​.Issuer as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.Issuer | ​​Care​Registered​Device​​.Unique​Device​Id3​Issuer | URL | 0.3 | While FHIR defines uidCarrier​.Issuer as a zero-to-many value, the Salesforce implementation supports a maximum of three values using three fields. | | uidCarrier​.jurisdiction | N/​A | N/​A | N/​A | Not supported | | uidCarrier​.carrierAIDC | N/​A | N/​A | N/​A | Not supported | | uidCarrier​.arrierHRF | N/​A | N/​A | N/​A | Not supported | | uidCarrier​.entryType | N/​A | N/​A | N/​A | Not supported | | status | ​​Asset.​Status | Picklist | 0​.1 | While F​HI​R defines device.status​ as code, the Salesforce implementation is a picklist​. | | status​Reason | ​​Asset.​Status​Reason | Picklist | 0.1 | While F​HI​R defines device.status​Reason as a zero-to-many codeable concept, the Salesforce implementation is a zero-to-one picklist​. | | distinct​Identifier | ​​Asset.​Uuid | String | 0.1 | N/A | | manufacturer | ​​Asset.​Asset​Provider​By | Lookup: Account | 0.1 | While F​HI​R defines device.manufacturer​ as string, the Salesforce implementation is a lookup to Account (Organization)​. | | manufacture​Date | ​​Asset.​Manufacture​Date | Date | 0.1 | While F​HI​R defines device.manufactureDate as DateTime, the Salesforce implementation is a of the data type Date. | | expiration​Date | ​​Asset.​Usage​End​Date | Date | 0​.1 | While F​HI​R defines device.expirationDate as DateTime, the Salesforce implementation is a of the data type Date. | | lot​Number | N/​A | N/​A | N/​A | Not supported | | serial​Number | ​​Asset.​Serial​Number | String | 0​.1 | N/A | | ​​device​​Name​.name | ​​Care​Registered​Device​.Name | String | 0.1 | While F​HI​R defines device.deviceName as a zero-to-many resource, the Salesforce implementation is zero-to-one​. | | ​​device​​Name​.type | Lookup: ​​Care​Registered​Device​.Name​Type | Multi-Select Picklist | 0.M | While F​HI​R defines device.deviceName as a zero-to-many resource, the Salesforce implementation is zero-to-one​. | | model​Number | ​​Asset​.Product​Code | String | 0​.1 | N/​A | | part​Number | N/​A | N/​A | N/​A | Not supported | | type | ​​Care​Registered​Device​.Device​TypeId | Lookup: Code​Set | 0.1 | While F​HI​R defines device.type as a codeable concept value, the Salesforce implementation is a code set. | | specialization | N/​A | N/​A | N/​A | Not supported | | version | N/​A | N/​A | N/​A | Not supported | | property | N/​A | N/​A | N/​A | Not supported | | patient | ​​Care​Registered​Device​​.PatientId | Lookup: Account | 0.1 | N/A | | owner | ​​Asset.​Asset​Serviced​By | Lookup: Account | 0.1 | N/A | | contact | ​​Care​Registered​Device​.Support​Contact​Detail | String | 0​.1 | While F​HI​R defines device.contact as a contact point value, the Salesforce implementation is a string. | | location | N/​A | N/​A | N/​A | N/​A | | url | ​​Asset.​Product​2Id​.Display​Url | URL | 0​.1 | N/​A | | account | N/​A | N/​A | N/​A | Not supported | | note​. | Author​Note | Object | 0​.M | The notes for a device are represented as AuthorNote records that reference the CareRegisteredDevice record using their ​​​AuthorNote​.​Parent​RecordId field​. | | safety | ​​Care​Registered​Device​​.​Safety​Information | String | 0​.1 | While F​HI​R defines device.safety as a codeable concept, the Salesforce implementation is a string field. | | parent | ​​Asset.​ParentId | Lookup Asset | 0​.1 | N/A | # DeviceSyncSummary Represents a summary of the synchronized data from a mobile device. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AppVersion - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The version of the mobile application with data to sync. ### BundleIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the mobile application bundle. ### DataDownloadDuration - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The duration of a download process in milliseconds. This field is a calculated field. ### DeviceIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the mobile device. ### DownloadCreatedRecords - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of records created based on the downloaded records. ### DownloadEnd - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp when the download ended. ### DownloadFreezeTime - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of time during a download process that the sync is paused while the mobile application runs in the background. ### DownloadStart - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp when the download started. ### DownloadUpdatedRecords - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of records updated based on the downloaded records. ### DownloadedRecords - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of records downloaded. ### ErrorCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The error code. ### ErrorDetail - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The message to display when synchronization fails. ### FileReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the file downloaded from the mobile device. This field is a polymorphic relationship field. - **Relationship Name**: FileReference - **Relationship Type**: Lookup - **Refers To**: PresentationFileReference ### IosVersion - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The version of the mobile device's operating system. ### IsDownloadCompleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the download completed (true) or not (false). - **Default value**: false ### IsUploadCompleted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the upload completed (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastSuccessfulUploadTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp of the most recent successful upload during the synchronization process. ### LastSyncTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp of the most recent synchronization process. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MetadataDownloadDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The duration of a metadata download process in milliseconds. ### MetadataDownloadStart - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp when the metadata download started. ### MetadataUpdated - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp of the most recent metadata update. ### MetadataVersion - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The version of the metadata. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: A system-generated identifier for the device sync summary record. ### Network - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of network used for the synchronization process. ### OfflineCreatedDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The timestamp when the current user created the record from the mobile device. ### OfflineLastModifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp when the current user last modified the record from the mobile device. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### S3Bucket - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Amazon S3 bucket used as a data source. ### SignalStrength - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: A measure of the quality of the connection to a mobile device. ### SyncErrorMessage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The message to display when synchronization with an external system fails. ### SyncStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The status of a synchronization process with an external system. - **Possible values**: - Error - New - Ok - Pending ### SyncSummaryData - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional synchronization data in JSON format. ### SyncTrigger - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The action or condition that triggered the synchronization process. - **Possible values**: - Days Offline Limit - Forced - Idle Background Sync - Initial - InitiatedByAIAgent - Manual - Metadata In Background - Pin - Territory Switch ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of synchronization performed. - **Possible values**: - clm - data ### UploadDuration - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The duration of an upload process in milliseconds. This field is a calculated field. ### UploadEnd - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp when the upload ended. ### UploadFreezeTime - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of time during an upload process that the sync is paused while the mobile application runs in the background. ### UploadRecords - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number or records uploaded during the synchronization process. ### UploadStart - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number or records uploaded during the synchronization process. ### UserLocation - **Type**: location - **Properties**: Nillable - **Description**: The latitude and longitude coordinates of the mobile device during the synchronization process. ## 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. [DeviceSyncSummaryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DeviceSyncSummaryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DeviceSyncSummaryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # DeviceSyncTransaction Represents a set of related data items to synchronize from a mobile device. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualRecordsCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of data items retrieved from the mobile device and ready to sync. ### ApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the business API to use to process the transaction when the transaction type is Business API. For example, Quote, Order, or Contact. Required when Transaction Type is Business API. ### ApiType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the API type to use to process the device sync transaction. API. - **Default value**: sObject - **Possible values**: - BusinessAPI—The sync transaction is processed by using the specified business API type. - sObjectAPI—The sync transaction is processed by using the standard object data API. ### AppVersion - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The version of the mobile application with data to sync. ### CanCancDpndBeRetired - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether a retry operation is available for a dependent child transaction with a status of Canceled (true) or not (false). This field is a calculated field. - **Default value**: false ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the transaction. ### DependentOfflineIdentifiers - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A comma-separated list of IDs that represent dependent transactions from the mobile device. The transactions are processed in the order in which they’re listed. ### DeviceIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the mobile device. ### DevicePlatform - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The operating system of the mobile device. - **Possible values**: - Android - MacOS - Windows - iOS ### DeviceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of mobile device, for example Phone or Tablet. ### ExpectedRecordCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expected number of data items to sync. ### IsBulk - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to sync data items in bulk (true) or not (false). Synchronize data items in bulk only if there are no dependencies between transactions. - **Default value**: false ### IsDebugMode - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the sync runs in debug mode (true) or not (false). - **Default value**: false ### IsOwnerPermissionEnforced - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to respect the user permissions of the transaction record’s owner during the sync (true) or not (false). - **Default value**: false ### IsRealTime - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the transaction is eligible for real-time batch processing (true) or not (false). - **Default value**: false ### IsRetry - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the sync is a retry operation (true) or not (false). This field is a calculated field. - **Default value**: false ### IsSimulatable - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the simulate operation applies to the transaction (true) or not (false). This field is a calculated field. - **Default value**: false ### IsWithSignedItem - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the transaction includes data items with a signature (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastRunDebug - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID associated with the debug log attachment from the most recent sync. ### LastRunLogId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transaction log from the most recent sync. If no errors occurred, the log is empty. This field is a relationship field. - **Relationship Name**: LastRunLog - **Relationship Type**: Lookup - **Refers To**: DeviceSyncTransactionLog ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MetadataVersion - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The metadata version for data from the mobile device. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: A system-generated identifier for the device sync transaction. ### NumberOfFailedAttempts - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of sync failures for the transaction. ### OfflineTimestamp - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The timestamp when the record from the mobile device occurred. ### OfflineUniqueIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. A unique identifier for the record from the mobile device. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Sequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Order position of the transaction in relation to other transactions to sync. Use sequence values to process device sync transactions in a specific order. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The sync status. - **Possible values**: - Canceled - Failed - InProgress - Manual - New - Retry - Success - Waiting ### TotSyncTranRecordCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of data items in the transaction. This field is a calculated field. ### TransactionSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The application that stores the data items to sync. - **Possible values**: - CLM. ### UserDeviceData - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: User data from the mobile device. ### GroupIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A unique identifier shared by all device sync transactions that originated from the same mobile transaction. Populated only when the mobile device splits a large transaction into multiple transactions. ### GroupRecordCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total number of device sync transactions in the group. The server uses this count to confirm that all transactions have arrived before processing. Populated only when the mobile device splits a large transaction into multiple transaction. ## 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. [DeviceSyncTransactionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DeviceSyncTransactionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # DeviceSyncTransactionLog Represents a log with information about the synchronized data from a mobile device. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### DeviceGenRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record associated with the log entry. ### DeviceSyncTransactionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The device sync transaction associated with the log. This field is a relationship field. - **Relationship Name**: DeviceSyncTransaction - **Relationship Type**: Master-detail - **Refers To**: DeviceSyncTransaction (the master object) ### ExceptionCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The error code if the sync process encountered an error. ### ExceptionLocation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The device sync transaction record associated with the log entry. ### ExceptionLog - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The raw log data. ### ExceptionType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of error associated with a log entry. ### FieldName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The field associated with a log entry. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LogType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The type of log. - **Possible values**: - Error ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the device sync transaction log record. ### ObjectName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of object associated with the log. ### SyncStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The sync status. - **Possible values**: - Error - New - Ok - Pending ### Value - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The data item associated with the log entry. ## 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. [DeviceSyncTransactionLogFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DeviceSyncTransactionLogHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # DeviceSyncTransactionRecord Represents a single data item to synchronize from a mobile device. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ApiResponse - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The response data that's returned from calls to the business API to process the device sync transaction. ### DeviceSyncTransactionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The device sync transaction associated with the data item to sync. This field is a relationship field. - **Relationship Name**: DeviceSyncTransaction - **Relationship Type**: Master-detail - **Refers To**: DeviceSyncTransaction (the master object) ### FieldValues - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The content of the data item to sync. If the data item is an attachment or a delete operation, this field is empty. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. A system-generated identifier for the device sync transaction record. ### ObjectName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The type of object associated with the data item to sync. ### OfflineCreatedDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The timestamp when the current user created the record from the mobile device. ### OfflineUniqueIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. A unique identifier for the record from the mobile device. ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The type of sync operation to perform. - **Possible values**: - delete - insert - update ### ProcessedRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the processed record after the synchronization process is complete. ### RecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record with the data item to sync, either a custom identifier for a new record or a standard identifier for an existing record. ### RelatedRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record associated with the device sync transaction record. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Relationship Type**: Lookup - **Refers To**: Account ### Sequence - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Order position of the data item in relation to other data items associated with the same device sync transaction. Use sequence values to preserve the order of data items in the record received from the mobile device. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The sync status. - **Possible values**: - Preparing - Ready ## 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. [DeviceSyncTransactionRecordFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DeviceSyncTransactionRecordHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DeviceSyncTransactionRecordShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # DiagnosticReport The diagnostic​Report FHIR resource maps to the Diagnostic​Summary​ object in Salesforce. ## FHIR V4.0 - Clinical​ Data Model Mapping Here’s how the fields defined by FHIR for [diagnostic​Report](https://www.hl7.org/fhir/diagnosticreport.html) map to the fields in Salesforce.
Table 1. diagnostic​Report - Salesforce
Diagnostic Report Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0.M The identifier information for a diagnostic summary is represented as Identifier records that reference the Diagnostic​Summary​ record using their Identifier​.Parent​RecordId field.
basedOn Diagnostic​Summary​.Based​OnId Polymorphic Lookup: Medication​Statement, Clinical​Service​Request 0.1

While FHIR defines diagnostic​Report​.basedOn as a zero-to-many reference, the Salesforce implementation is a zero-to-one text field.

Only references to medication statement and clinical service request records are supported.
status Diagnostic​Summary​.Status Picklist 1.1 While FHIR defines diagnostic​Report​.status as a reference to code set bundle, the Salesforce implementation is a picklist.
category Diagnostic​Summary​.Category Multi-Select Picklist 0.M While FHIR defines diagnostic​Report​.category as a reference to code set bundle, the Salesforce implementation is a multi-select picklist.
code Diagnostic​Summary​.​CodeId Lookup: ​CodeSet​Bundle 1.1 N/A
subject Diagnostic​Summary​.PatientId Master-Detail: Account 1.1 The Salesforce implementation of diagnostic​Report​.subject supports references to only patients.
encounter Diagnostic​Summary​.Clinical​EncounterId Lookup: Clinical​Encounter 0.1 N/A
effective​.effective​Date​Time Diagnostic​Summary​.Effective​Start​Date​Time Date​Time 0.1 N/A
effective​.effective​Period Diagnostic​Summary​.Effective​Start​Date​Time Date​Time 0.1 Because Salesforce doesn’t support a native period data type, the diagnostic​Report​.effective​.effective​Period field is flattened into a set of start date and end date fields.
effective​.effective​Period Diagnostic​Summary​.Effective​End​Date​Time Date​Time 0.1 Because Salesforce doesn’t support a native period data type, the diagnostic​Report​.effective​.effective​Period field is flattened into a set of start date and end date fields.
issued Diagnostic​Summary​.Issued​Date​Time Date​Time 0.1 Because Salesforce doesn’t support a native instant data type, the diagnostic​Report​.issued FHIR resource is implemented as a date time field in Salesforce.
performer Diagnostic​Summary​.IssuedById Lookup: Care​Performer 0.1 While FHIR defines diagnostic​Report​.performer as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference to Care​Performer.
resultsInterpreter Diagnostic​Summary​.Interpreted​ById Lookup: Care​Performer 0.1 While FHIR defines diagnostic​Report​.results​Interpreter as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference to Care​Performer.
specimen N/A N/A N/A Not supported
result Diagnostic​Summary​.Care​Observation​Id Lookup: Care​Observation 0.1 While FHIR defines diagnostic​Report​.result as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference to Care​Observation.
imaging​Study N/A N/A N/A Not supported
media​.comment Diagnostic​Summary​.ImageComments1 String 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.comment Diagnostic​Summary​.ImageComments2 String The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.comment Diagnostic​Summary​.ImageComments3 String 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.comment Diagnostic​Summary​.ImageComments4 String 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.comment Diagnostic​Summary​.ImageComments5 String 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.link Diagnostic​Summary​.ImageUrl1 URL 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.link Diagnostic​Summary​.ImageUrl2 URL 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.link Diagnostic​Summary​.ImageUrl3 URL 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.link Diagnostic​Summary​.ImageUrl4 URL 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
media​.link Diagnostic​Summary​.ImageUrl5 URL 0.1 The zero-to-many diagnostic​Report​.media resource is flattened to five separate zero-to-one text fields and five separate zero-to-one URL fields in the Salesforce implementation.
conclusion Diagnostic​Summary​.Summary String 0.1 N/A
conclusion​Code Diagnostic​Summary​.Summary​CodeId Lookup: ​CodeSet​Bundle 0.1 While FHIR defines diagnostic​Report​.conclusion​Code as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference.
presented​Form N/A N/A N/A Not supported
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how a daignostic report for the patient Charles Green is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_diagnosticreport.png) #### See Also - [DiagnosticSummary](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_DiagnosticSummary.htm "Represents the findings, interpretations, and summaries of tests performed on patients. This object is available in API version 51.0 and later.") # DiagnosticSummary Represents the findings, interpretations, and summaries of tests performed on patients. 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() ## Additional Information for DiagnosticSummary in Other Objects In addition to creating a record using these fields, you can add more details to your DiagnosticSummary record by creating records in certain other objects, and referencing your DiagnosticSummary record as the parent record. Here’s the list of objects you can associate to DiagnosticSummary in this way, the type of information they add, and the field they use to reference DiagnosticSummary. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the diagnostic summary. | ParentRecordId | | DiagnosticSummaryDetail | Associates document reference-type DiagnosticSummary records with various other records and defines the nature of association. For instance, authors, related documents, and related encounters. | DiagnosticSummaryId | ## Fields ### AttachmentLanguage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Records the language of the attached document. ### AuthenticatorId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or organization that authenticates the validity of the document. - **Referenced Objects**: - Account - Contact - HealthcareProvider - User ### BasedOnId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the care plan, medication request, medication statement, or clinical service request that the diagnostic summary is based on. - **Referenced Objects**: - CarePlan - ClinicalServiceRequest - MedicationRequest - MedicationStatement ### CareObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the care observation that’s a part of the diagnostic summary. - **Referenced Objects**: - CareObservation ### Category - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the category of the department or service that the diagnostic summary is a product of. - **Possible values**: - Community - Inpatient - Outpatient - Patient Specified ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the encounter that the diagnostic summary is about. - **Referenced Objects**: - ClinicalEncounter ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that describes the diagnostic summary. - **Referenced Objects**: - CodeSetBundle ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the diagnostic summary. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The content document associated with diagnostic summary. You can include up to 5 documents in the PDF format. This field is available in API version 62.0 and later. This field is a relationship field. - **Referenced Objects**: - ContentDocument ### CustodianId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person or organization that's responsible for the document's maintenance and access. - **Referenced Objects**: - Account ### DocumentFormatCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the document's encoding, structure, and template. - **Referenced Objects**: - CodeSet ### DocumentSecurityCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the document's security or privacy level. - **Referenced Objects**: - CodeSetBundle ### DocumentStage - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the stage of verification or completion of the document. - **Possible values**: - Preliminary - Final - Amended - Entered-in-Error ### DocumentTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the specific type of the document. - **Referenced Objects**: - CodeSetBundle ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the clinically relevant period of the summary. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the clinically relevant period of the summary. ### ImageComments1 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the first image linked in the report. ### ImageComments2 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the second image linked in the report. ### ImageComments3 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the third image linked in the report. ### ImageComments4 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the fourth image linked in the report. ### ImageComments5 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comments about the fifth image linked in the report. ### ImageUrl1 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl2 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl3 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl4 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### ImageUrl5 - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link to a key image associated with the diagnostic summary. ### InterpretedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the person or organization responsible for interpreting the diagnostic summary and its conclusions. - **Referenced Objects**: - CarePerformer ### IssuedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care performer that issues the diagnostic summary. - **Referenced Objects**: - CarePerformer ### IssuedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the diagnostic summary was issued. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the diagnostic summary record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the diagnostic summary record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the patient who is the subject of the diagnostic summary. - **Referenced Objects**: - Account ### PrimaryProviderId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the primary provider associated with the diagnostic summary. - **Referenced Objects**: - Account - Contact - HealthcareProvider ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the diagnostic summary. - **Possible values**: - Active - Completed - Entered-in-error - Intended - Not-taken - On-hold - Stopped - Unknown ### Summary - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical conclusion of the tests performed in the diagnostic service. ### SummaryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the clinical conclusion of the tests as reported in the diagnostic service. - **Referenced Objects**: - CodeSetBundle ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the information in the record represents a diagnostic summary or a document reference. - **Possible values**: - DiagnosticSummary—Diagnostic Summary - DocumentReference—Document Reference ## Usage DiagnosticSummary is used to store records representing both DiagnosticReport and DocumentReference type information from FHIR-based systems. You can use the UsageType field to specify which records represent diagnostic reports and which records represent document 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. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DiagnosticSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [DiagnosticSummaryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DiagnosticSummaryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DiagnosticSummaryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [DiagnosticSummaryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # DiagnosticSummaryDetail Represents additional information associated with document reference-type DiagnosticSummary records. This additional information may be related documents, authors, or related encounters. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailRecordId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a record that adds information to a DiagnosticSummary record. - **Referenced Objects**: - Account - CareObservation - CarePerformer - CarePlan - CareRegisteredDevice - ClinicalEncounter - ClinicalServiceRequest - DiagnosticSummary - HealthcareProvider - MedicationRequest - MedicationStatement - Specimen ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the relation between the DiagnosticSummary record and the detail record. - **Possible values**: - Author - ClinicalEncounter—Clinical Encounter - RelatedDocument—Related Document - Results - Specimen - IssuedBy—Issued By - InterpretedBy—Interpreted By - BasedOn—Based On - PerformedBy—Performed By ### DiagnosticSummaryId - **Type**: Master-Detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent DiagnosticSummary record that the detail record is associated to. - **Referenced Objets**: DiagnosticSummary ### DocumentRelationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: If the detail type is Related Document, then this field specifies the type of relationship between the two documents. - **Possible values**: - Addition - Conversion - Replacement - Signature ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the DiagnosticSummaryDetail record. ## Associated Objects ### 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](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [DiagnosticSummaryDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DiagnosticSummaryDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # Digital Verification (POST) Perform verification for the digital verification records within advanced therapy management. ## Resource /connect/health/advanced-therapy-management/digital-verification ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v60.0/connect/health/advanced-therapy-management/digital-verification ## Available Version 60.0 ## HTTP Methods POST ## JSON example { "digitalVerificationInputFieldsMap": { "VerificationStatusCategory": "Completed", "Comment": "done successfully", "VerificationSite": "USA" }, "userCredentials": { "loginId": "sanampreet.singh@salesforce.com", "password": "123456" }, "digitalVerificationId": "15Exx0000004CAeEAM", sessionId:12Exz0022004CAfABM } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | digital​Verification​Id | String | ID of the digital verification record for which the digital verification is to be performed. | Required | 60.0 | | sessionId | String | ID that tracks the session established through a connected app or remote system in Salesforce. | Optional | 60.0 | | user​Credentials | [User Credentials Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_user_credentials_input.htm "Input representation of the user credentials to perform digital verification.") | Authentication credentials of the user performing the digital verification. | Required | 60.0 | | digital​Verification​InputFields​Map | [Digital Verification Input Fields Map](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_digital_verification_input_fields_map.htm "Input representation of the key-value pairs containing the fields to be updated for the digital verification.") | Map structure holding key-value pairs of digital verification input fields. | Required | 60.0 | ## Response Body for POST [Digital Verification](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_digital_verification_output.htm "Output Representation for the digital verification API request.") # Digital Verification Input Input representation of the request to perform verification tasks for digital verification records. ## JSON example { "digitalVerificationInputFieldsMap": { "VerificationStatusCategory": "Completed", "Comment": "done successfully", "VerificationSite": "USA" }, "userCredentials": { "loginId": "sanampreet.singh@salesforce.com", "password": "123456" }, "digitalVerificationId": "15Exx0000004CAeEAM", sessionId:12Exz0022004CAfABM } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | digital​Verification​Id | String | ID of the digital verification record for which the digital verification is to be performed. | Required | 60.0 | | sessionId | String | ID that tracks the session established through a connected app or remote system in Salesforce. | Optional | 60.0 | | user​Credentials | [User Credentials Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_user_credentials_input.htm "Input representation of the user credentials to perform digital verification.") | Authentication credentials of the user performing the digital verification. | Required | 60.0 | | digital​Verification​InputFields​Map | [Digital Verification Input Fields Map](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_digital_verification_input_fields_map.htm "Input representation of the key-value pairs containing the fields to be updated for the digital verification.") | Map structure holding key-value pairs of digital verification input fields. | Required | 60.0 | # Digital Verification Input Fields Map Input representation of the key-value pairs containing the fields to be updated for the digital verification. ## JSON example { "digitalVerificationInputFieldsMap": { "VerificationStatusCategory": "Completed", "Comment": "done successfully", "VerificationSite": "USA" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | digital​Verification​InputFields​Map | Map | Specifies the map holding the digital verification record details to be modified. | Required | 60.0 | # Digital Verification Output Output Representation for the digital verification API request. ## Sample Response { "isSuccess": true, "message": "Performed all Steps of Digital Verification Successfully", "code": 200 } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Response code of the Digital Verification API. | Small, 60.0 | 60.0 | | isSuccess | Boolean | Indicates whether the digital verification process was successful (true) or not (false). | Small, 60.0 | 60.0 | | message | String | Feedback message from the digital verification API request. | Small, 60.0 | 60.0 | # DigitalSignature Life Sciences Cloud fields extend the standard DigitalSignature object to represent a signature. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete() #### See Also - [_Object Reference for the Salesforce Platform_: DigitalSignature](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_digitalsignature.htm) ## Fields ### DeviceOs - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The operating system of the device used to capture the digital signature. ### DeviceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The type of device used to capture the digital signature. ### DigitalSignatureRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The request for which the signature was captured. This field is a relationship field. - **Relationship Name**: DigitalSignatureRequest - **Refers To**: DigitalSignatureRequest ### Geolocation - **Type**: location - **Properties**: Nillable - **Description**: Captures the GPS location at the time the signature was captured, providing a record of where the signing occurred. ### GeolocationMissingReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Identifies the reason why GPS data was not collected when the signature was captured. - **Possible values**: - BadData - DeviceRestricted - Offline - UserRestricted ### GeolocationTimestamp - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort - **Description**: Captures the exact time when GPS data was collected, especially in mobile offline cases where the GPS collection time differs from the signature capture time. ### IsSignatureCopyRequested - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the user has requested a copy of the signed document. ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to a related record, such as a visit or inquiry. This field is a polymorphic relationship field. - **Relationship Name**: Parent - **Relationship Type**: Master-detail - **Refers To**: CommSubConsentCmplSnpsht, Inquiry, Visit ### WebBrowser - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The web browser used to capture the digital signature. # DigitalSignatureRequest Reserved for future use. ## Fields ### ChannelType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The channel via which the request was sent. - **Possible values**: - Email ### ContextRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context record associated with this request. This field is a polymorphic relationship field. - **Relationship Name**: ContextRecord - **Refers To**: Inquiry, Visit ### ContextType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of request. - **Possible values**: - Consent - Inquiry - Visit ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the request expires. ### RecipientRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The recipient that the request is sent to. This field is a polymorphic relationship field. - **Relationship Name**: RecipientRecord - **Refers To**: Account, Contact ### RequestInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The details of the request. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the request. - **Possible values**: - Canceled - Declined - Sent - Submitted - Viewed # DigitalVerfSetupDetail Stores contextual details of a digital verification setup, such as the user who does the verification, and the messages that display at the time of verification. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DesignatedVerifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role, user or user group associated with the digital verification setup detail. This field is a polymorphic relationship field. - **Relationship Name**: DesignatedVerifier - **Relationship Type**: Lookup - **Refers To**: Group, ParticipantRole ### DigitalVerificationSetupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent digital verification setup associated with the digital verification setup detail. This field is a relationship field. - **Relationship Name**: DigitalVerificationSetup - **Relationship Type**: Lookup - **Refers To**: DigitalVerificationSetup ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed a record indirectly; for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the digital verification setup detail record. ### PostVerificationMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The message that is displayed after a verification is performed. ### PreVerificationMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The message that is displayed before a verification is performed. ### VerifierRank - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the rank of the verifier that provides the verification. - **Possible values**: - FifthVerifier - FirstVerifier - FourthVerifier - SecondVerifier - ThirdVerifier ## 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. [DigitalVerfSetupDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # DigitalVerification Stores information about the verification of a related record. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores additional comments about the verification. ### DesignatedVerifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user or user group who can provide verification for a parent reference record. This field is a polymorphic relationship field. - **Relationship Name**: DesignatedVerifier - **Relationship Type**: Lookup - **Refers To**: Group, User ### DigitalVerificationSetupDetailId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The details associated with the digital verification setup record. This field is a relationship field. - **Relationship Name**: DigitalVerificationSetupDetail - **Relationship Type**: Lookup - **Refers To**: DigitalVerfSetupDetail ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed a record indirectly; for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the digital verification record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent reference record that is verified. This field is a polymorphic relationship field. - **Relationship Name**: ParentReferenceRecord - **Relationship Type**: Lookup - **Refers To**: ClinicalTrial\_\_c, CustodyChainEntry, DemoObject\_\_c, HC24\_\_AccountAccountRelation\_\_c, HC24\_\_CandidatePatient\_\_c, HC24\_\_CardView\_Dropdown\_\_c, HC24\_\_CarePlanGoal\_\_c, HC24\_\_CarePlanProblem\_\_c, HC24\_\_CarePlanTemplateGoal\_\_c, HC24\_\_CarePlanTemplateProblem\_\_c, HC24\_\_CarePlanTemplateTask\_\_c, HC24\_\_CarePlanTemplate\_\_c, HC24\_\_CareProgramPlanTemplate\_\_c, HC24\_\_Clinical\_Assessment\_Response\_\_c, HC24\_\_CommunityProfileName\_\_c, HC24\_\_ConditionToHCCCodeMapping\_\_c, HC24\_\_ContactContactRelation\_\_c, HC24\_\_CrossObjectRelationship\_\_c, HC24\_\_CustomFieldSets\_\_c, HC24\_\_CustomLabelConfig\_\_c, HC24\_\_EHRProcedurePerformer\_\_c, HC24\_\_EHRProcedureRequest\_\_c, HC24\_\_EHRProcedure\_\_c, HC24\_\_EhrAllergyIntolerance\_\_c, HC24\_\_EhrCarePlanActivity\_\_c, HC24\_\_EhrCarePlanConcern\_\_c, HC24\_\_EhrCarePlanGoal\_\_c, HC24\_\_EhrCarePlanParticipant\_\_c, HC24\_\_EhrCarePlan\_\_c, HC24\_\_EhrConditionRelatedItem\_\_c, HC24\_\_EhrCondition\_\_c, HC24\_\_EhrDevice\_\_c, HC24\_\_EhrDosageInstruction\_\_c, HC24\_\_EhrEncounterAccomodation\_\_c, HC24\_\_EhrEncounterParticipant\_\_c, HC24\_\_EhrEncounter\_\_c, HC24\_\_EhrImmunizationReaction\_\_c, HC24\_\_EhrImmunization\_\_c, HC24\_\_EhrMedicationPrescription\_\_c, HC24\_\_EhrMedicationStatement\_\_c, HC24\_\_EhrObservation\_\_c, HC24\_\_EhrPatientCareProvider\_\_c, HC24\_\_EhrPatientContact\_\_c, HC24\_\_EhrPatient\_\_c, HC24\_\_EhrPractitionerIdentity\_\_c, HC24\_\_EhrPractitionerQualification\_\_c, HC24\_\_EhrPractitionerRole\_\_c, HC24\_\_EhrPractitioner\_\_c, HC24\_\_EhrRelatedObservation\_\_c, HC24\_\_EhrRelatedPerson\_\_c, HC24\_\_EhrVaccinationProtocol\_\_c, HC24\_\_EhrVirtualDeviceChannel\_\_c, HC24\_\_EhrVirtualDevice\_\_c, HC24\_\_FilterColumn\_\_c, HC24\_\_FilterCondition\_\_c, HC24\_\_FilterCriterion\_\_c, HC24\_\_HcFlexibleCarePlanTabs\_\_c, HC24\_\_HealthCloudFeatureToggle\_\_c, HC24\_\_HousingAssessment\_\_c, HC24\_\_IndustriesAppConfig\_\_c, HC24\_\_IndustriesSettings\_\_c, HC24\_\_PatientCardViewConfiguration\_\_c, HC24\_\_ProgramPatientAffiliation\_\_c, HC24\_\_ProgramPatientSummary\_\_c, HC24\_\_Program\_\_c, HC24\_\_Provider\_\_c, HC24\_\_ReciprocalRole\_\_c, HC24\_\_TaskGroups\_\_c, HC24\_\_TimelineViewConfiguration\_\_c, HC24\_\_UsePersonAccount\_\_c, HC24\_\_individualExcludedFields\_\_c, custom\_sk\_\_c, vlocity\_lwc20\_\_CardFrameworkConfiguration\_\_c, vlocity\_lwc20\_\_DRBatchQueue\_\_c, vlocity\_lwc20\_\_DRBulkData\_\_c, vlocity\_lwc20\_\_DREncryption\_\_c, vlocity\_lwc20\_\_DRWorker\_\_c, vlocity\_lwc20\_\_Interface\_DRGeneric\_\_c, vlocity\_lwc20\_\_TestResult\_\_c, vlocity\_lwc20\_\_TriggerSetup\_\_c, vlocity\_lwc20\_\_UISettings\_\_c, vlocity\_lwc20\_\_VlocityDataPack\_\_c, vlocity\_lwc20\_\_VlocityDocuSignTemplate\_\_c, vlocity\_lwc20\_\_VlocityErrorLogEntry\_\_c, vlocity\_lwc20\_\_VlocityScheduledJob\_\_c, vlocity\_lwc20\_\_VlocityTrackingEntry\_\_c ### PostVerificationMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The message that is displayed after a verification is performed. ### PreVerificationMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The message that is displayed before a verification is performed. ### VerificationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the verification of the related record was done. ### VerificationRequestDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the verification was requested. ### VerificationSite - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The place where the verification is done. ### VerificationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of verification for the parent reference record. ### VerificationStatusCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status category of the verification for the parent reference record. - **Possible values**: - Completed - OnHold - ReadyForSigning - RejectedClosed - RejectedOpen ### VerifiedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who performed the verification. This field is a polymorphic relationship field. - **Relationship Name**: VerifiedBy - **Relationship Type**: Lookup - **Refers To**: User ### VerifierOrder - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The order of the verifier who performed the verification. - **Possible values**: - FifthVerifier - FirstVerifier - FourthVerifier - SecondVerifier - ThirdVerifier ## 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. [DigitalVerificationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DigitalVerificationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # DigitalVerificationSetup Stores information about a digital verification setup, such as the number of signatures needed and the record action that's related to the verification. This object is available in API version 60.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed a record indirectly; for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the digital verification setup record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RecordActionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the record action applicable for the digital verification setup, such as Create and Edit. - **Possible values**: - Create - Edit ### ReferenceObjectApiName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The parent object for which the digital verification setup is applicable. - **Possible values**: - CarePgmEnrolleeWorkOrder - CarePgmEnrolleeWkOrdStep - The API name of any custom object created in the org. ### VerificationProcessType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the process type of the verification, such as sequential or parallel. - **Possible values**: - Parallel - Sequential ### VerificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the process type of the digital verification setup. - **Possible values**: - DualSignature - FiveSignatures - FourSignatures - NoSignature - NotApplicable - SingleSignature - ThreeSignatures ## 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. [DigitalVerificationSetupHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [DigitalVerificationSetupOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [DigitalVerificationSetupShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Dispenser Address Pharmacy address. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dispenserCity | String | Dispenser City | Big, 46.0 | 46.0 | | dispenserCountry | String | Dispenser Country | Big, 46.0 | 46.0 | | dispenserPostalCode | String | Dispenser Postal Code | Big, 46.0 | 46.0 | | dispenserState | String | Dispenser State | Big, 46.0 | 46.0 | | dispenserStreet | String | Dispenser Street | Big, 46.0 | 46.0 | # Dispenser Address Input Address of the pharmacy. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | city | String | City of the pharmacy. | No | 46.0 | | country | String | Country of the pharmacy. | No | 46.0 | | postalCode​ | String | Postal code of the pharmacy. | No | 46.0 | | state | String | State of the pharmacy. | No | 46.0 | | street | String | Street of the pharmacy. | No | 46.0 | # DistributionChannel Represents a list of distribution channels, for example direct sales, wholesale, retail, and online, used to specify the fulfillment method for an order or sale. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ChannelSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subtype of the distribution channel determined by whether the distribution is direct or indirect. ### ChannelType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the distribution channel. - **Possible values**: - Direct - Indirect ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A detailed description of the sales distribution channel. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the sales distribution channel. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. - **Relationship Name**: Owner - **Refers To**: Group, User # Document Management Input Input representation for the document split request. ## Root XML tag ## JSON Example { "pageSpecificationList": { "pageSpecifications": \[ { "page":1, "rotation":0, "addToTargetFile":"true" }, { "page":2, "rotation":0, "addToTargetFile":"true" } \] }, "linkedObjectFieldsMap" : { "linkedObjectFields" : {"ReceivedDocumentId" : "0ioxx00000000ODAAY"} }, "isOcrRequested" : true } ## Properties
Name Type Description Required or Optional Available Version
isOcrRequested Boolean Indicates whether OCR is required to process the content document (true) or not (false).

By default, OCR is performed on the first five pages of the content document.

Note: Set this field value to true to perform OCR on all the pages of a content document that contains more than five pages.

 Optional 55.0
linkedObjectFieldsMap Map<String, String> Represents the map that contains the linked object fields. For example, the linked object is the Document Checklist Item for Salesforce. Optional 55.0
pageSpecificationList Page Specification List Input[] The page specifications list representation. Required 55.0
targetFileName String The name of the target file that is created from the split document. Optional 55.0
# Document Management Result Output representation of the document split request. ## JSON Example Example of a success response: { "contentDocumentId": "069xx0000004D1sAAE", "isSuccess": true } Example of an error response: { "error": { "code": "INVALID\_INPUT", "message": "The ReceivedDocument field doesn’t exist in the specified DocumentChecklistItem object." }, "isSuccess": false } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | contentDocumentId | String | The ID of the content document that is created after the request is successful. | Small, 55.0 | 55.0 | | error | [Error Response Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_errors_response.htm "Error response representation.") | Error representation. | Small, 55.0 | 55.0 | | isSuccess | Boolean | Indicates whether the document split request is successful (true) or not (false). | Small, 55.0 | 55.0 | # Document​Reference The Document​Reference F​HI​R resource maps to the Diagnostic​Summary and Diagnostic​SummaryDetail objects in Salesforce​. ## F​HI​R V4​.0 - ​Clinical ​Data ​Model ​Mapping ​Here’s how the fields defined by F​HI​R for [Document​Reference](https://www.hl7.org/fhir/documentreference.html) map to the fields in Salesforce​. Table 1. ​Patient - Salesforce | Document​Reference ​Resource | Salesforce Field | ​Type | Salesforce ​Cardinality | Notes | | --- | --- | --- | --- | --- | | Master​Identifier | N/​A | N/​A | N/​A | Not supported | | identifier | ​​​Identifier | Object | 0​.​M | The identifier information for a documentReference is represented as Identifier records that reference the DiagnosticSummary record using their ​​​Identifier​.​Parent​RecordId field​. | | status | ​​Diagnostic​Summary​.Status | Picklist | 1.1 | While FHIR defines document​Reference.status as a code, the Salesforce implementation is a picklist. | | docStatus | ​​Diagnostic​Summary​.Document​Stage | Picklist | 0.1 | While FHIR defines document​Reference.docStatus as a code, the Salesforce implementation is a picklist. | | type | ​​Diagnostic​Summary​.Document​Type​CodeId | Lookup: CodeSet​Bundle | 0.1 | N/A | | category | ​​Diagnostic​Summary​.Category | Multi-Select Picklist | 0.M | While FHIR defines documentReference.category as a codeable concept, the Salesforce implementation is a picklist. | | subject | ​​Diagnostic​Summary​.PatientId | Maste-Detail: Account | 1.1 | The Salesforce implementation supports only patients as subjects of a document reference. | | date | ​​Diagnostic​Summary​.Issued​Date​Time | DateTime | 0.1 | N/A | | author | ​​Diagnostic​Summary​Detail | Object | 0.M | The author information of a document reference is represented using the DiagnosticSummaryDetail child object. The DetailRecordId field references the author, the DetailTypefield specifies the child record type as Author, and the DiagnosticSummaryId field references the parent DiagnosticSummary record that represents the document reference. | | authenticator | ​​Diagnostic​Summary​.Authenticator​Id | Lookup: Healthcare Provider, Account, Contact, User | 0.1 | The Salesforce implementation doesn’t directly support practitionerRole or HealthcarePractitionerFacility records as authenticators. | | custodian | ​​Diagnostic​Summary​.Custodian​Id | Lookup: Account | 0.1 | N/A | | relatesTo​.code | ​​Diagnostic​Summary​Detail​.Document​Relation​Type | Picklist | 0.M | The related document information of a document reference is represented using the DiagnosticSummaryDetail child object. The DetailRecordId field references the related document, the Document​Relation​Type field specifies the type of relation, the DetailTypefield specifies the child record type as Related Document, and the DiagnosticSummaryId field references the parent DiagnosticSummary record that represents the document reference. | | relatesTo​.target | ​​Diagnostic​Summary​Detail​.Detail​Record | Lookup: Diagnostic​Summary | 0​.M | The related document information of a document reference is represented using the DiagnosticSummaryDetail child object. The DetailRecordId field references the related document, the Document​Relation​Type field specifies the type of relation, the DetailTypefield specifies the child record type as Related Document, and the DiagnosticSummaryId field references the parent DiagnosticSummary record that represents the document reference. | | description | ​​Diagnostic​Summary.​Summary | String | 0.1 | While F​HI​R defines document​Reference.status​Reason as a zero-to-many codeable concept, the Salesforce implementation is a zero-to-one picklist​. | | security​Label | ​​Diagnostic​Summary.​Document​Security​Code | Lookup: CodeSet​Bundle | 0.1 | N/A | | content​.attachment | ​​Diagnostic​Summary​.Report​AttachmentId | Lookup: Attachment | 0.1 | While FHIR defines documentReference.Content as a one-to-many resource, the Salesforce implementation is zero-to-one. | | content​.format | ​​Diagnostic​Summary.​Document​Format​Code | Lookup: CodeSet​ | 0.1 | N/A | | context​.encounter | ​​Diagnostic​Summary​Detail | Object | 0.M | The encounter context information of a document reference is represented using the DiagnosticSummaryDetail child object. The DetailRecordId field references the clincial encounter record, the DetailTypefield specifies the child record type as Clinical Encounter, and the DiagnosticSummaryId field references the parent DiagnosticSummary record that represents the document reference. | | context​.event | N/​A | N/​A | N/​A | Not supported | | context​.period | N/​A | N/​A | N/​A | Not supported | | context​.facility​Type | N/​A | N/​A | N/​A | Not supported | | context​.practice​Setting | N/​A | N/​A | N/​A | Not supported | | context​.source​Patient​Info | N/​A | N/​A | N/​A | Not supported | | context​.related | N/​A | N/​A | N/​A | Not supported | ## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows an example of how a document related to the patient Charles Green is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_documentreference.png) # DocumentTemplate Represents information about dynamic document generation. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the document template is active. - **Default value**: false ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of document template. - **Possible values**: - HTMLArchive - Web - MicrosoftWord - MicrosoftPowerpoint # Dosage The Dosage FHIR resource maps to the Patient​Medication​Dosage​ object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Dosage](https://www.hl7.org/fhir/dosage.html#Dosage) map to the fields in Salesforce. Table 1. Dosage - Salesforce | Dosage Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | sequence | Patient​Medication​Dosage​.Sequence | Double | 0.1 | N/A | | text | Patient​Medication​Dosage​.Comments | String | 0.1 | Both dosage​.text and dosage​.timing are mapped to the Patient​Medication​Dosage​.Comments field in Salesforce. | | additional​Instruction | Patient​Medication​Dosage​.Additional​Instruction | String | 0.1 | While FHIR defines Dosage​.additional​Instruction as a zero-to-many reference to code set bundle, the Salesforce implementation is a zero-to-one text field. | | patient​Instruction | Patient​Medication​Dosage​.Patient​Instruction | String | 0.1 | N/A | | timing | Patient​Medication​Dosage​.Timing​Id | String | 0.1 | N/A | | asNeeded​.asNeeded​Boolean | Patient​Medication​Dosage​.IsAs​Needed | Boolean | 0.1 | N/A | | asNeeded​.asNeeded​Codeable​Concept | N/A | N/A | N/A | Not supported | | site | Patient​Medication​Dosage​.SiteId | Lookup: CodeSet​Bundle | 0.1 | N/A | | route | Patient​Medication​Dosage​.RouteId | Lookup: CodeSet​Bundle | 0.1 | N/A | | method | Patient​Medication​Dosage​.MethodId | Lookup: CodeSet​Bundle | 0.1 | N/A | | dose​And​Rate | N/A | N/A | 0.1 | While FHIR defines dosage​.dose​AndRate as a zero-to-many block of child resources, the Salesforce implementation supports only a zero-to-one set of information per record. | | dose​And​Rate​.type | Patient​Medication​Dosage​.Dosage​Definition​Type | Picklist | 0.1 | While FHIR defines dosage​.dose​AndRate​.type as a code set bundle, the Salesforce implementation is a picklist. | | dose​And​Rate​.dose | Patient​Medication​Dosage​.Dosage​Quantity​Type | Picklist | 0.1 | A Salesforce-original field that determines whether the dosage​.dose​AndRate​.dose value in the record is a dose range or a dose quantity. | | dose​And​Rate​.dose | Patient​Medication​Dosage​.Dosage​Quantity​Numerator | Double | 0.1 | Because Salesforce doesn’t support native quantity or range data types, the dosage​.dose​AndRate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | dose​And​Rate​.dose | Patient​Medication​Dosage​.Dosage​Quantity​Denominator | Double | 0.1 | Because Salesforce doesn’t support native quantity or range data types, the dosage​.dose​AndRate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | dose​And​Rate​.dose | Patient​Medication​Dosage​.Dosage​UnitId | Lookup: UnitOf​Measure | 0.1 | Because Salesforce doesn’t support native quantity or range data types, the dosage​.dose​AndRate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | doseAnd​Rate​.rate | Patient​Medication​Dosage​.Dosage​Rate​Type | Picklist | 0.1 | A Salesforce-original field that determines whether the dosage​.doseAnd​Rate​.rate value in the record is a simple frequency, frequency range, or frequency ratio. | | doseAnd​Rate​.rate | Patient​Medication​Dosage​.Dosage​Rate​Numerator | Double | 0.1 | Because Salesforce doesn’t support native quantity, range, or ratio data types, the dosage​.doseAnd​Rate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | doseAnd​Rate​.rate | Patient​Medication​Dosage​.Dosage​Rate​Denominator | Double | 0.1 | Because Salesforce doesn’t support native quantity, range, or ratio data types, the dosage​.doseAnd​Rate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | doseAnd​Rate​.rate | Patient​Medication​Dosage​.Dosage​Rate​UnitId | Lookup: UnitOf​Measure | 0.1 | Because Salesforce doesn’t support native quantity, range, or ratio data types, the dosage​.doseAnd​Rate​.dose FHIR resource is flattened to a set of numerator, denominator, and unit fields. | | doseAnd​Rate​.maxDose​Per​Period | N/A | N/A | N/A | Not supported | | doseAnd​Rate​.max​DosePer​Administration | N/A | N/A | N/A | Not supported | | doseAnd​Rate​.max​Dose​Per​Lifetime | N/A | N/A | N/A | Not supported | #### See Also - [PatientMedicationDosage](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_PatientMedicationDosage.htm "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.") # Download Provider (POST) Download Health Care provider data from an external system to a Salesforce org after a search is performed. ## Resource /connect/life-sciences/commercial/download-provider ## Available Version 66.0 ## HTTP Methods POST ## Properties | Property Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | country​Code | String | The country code where the search was performed. | Required | 66.0 | | data​source | String | The external data source, such as One Key. | Optional | 66.0 | | entity​Type | String | The type of entity, such as individual or workplace. | Required | 66.0 | | external​Id | String | The unique external ID from the search response. | Required | 66.0 | | in​Contract | Boolean | Indicates whether the record is currently in contract. | Optional | 66.0 | ## Response Body for POST [Download Provider Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_download_provider_output.htm "The response representation containing the status of the provider download request and the resulting data.") # Download Provider Input The request representation to download provider data using an external identifier. ## Properties | Property Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | country​Code | String | The country code where the search was performed. | Required | 66.0 | | data​source | String | The external data source, such as One Key. | Optional | 66.0 | | entity​Type | String | The type of entity, such as individual or workplace. | Required | 66.0 | | external​Id | String | The unique external ID from the search response. | Required | 66.0 | | in​Contract | Boolean | Indicates whether the record is currently in contract. | Optional | 66.0 | # Download Provider Output The response representation containing the status of the provider download request and the resulting data. ## Properties | Property Name | Type | Description | | --- | --- | --- | | code | String | The API response code, such as 200 or 500. | | message | String | In case of a failure, this property provides error details. | | response | Map | The actual response data, which includes information about the created entities such as accounts and contact point addresses. | | success | Boolean | Indicates whether the API request was successful. | # Electronic Signatures Manage electronic signatures by using Digital Verifications. Set up signature trails for records or workflows that require users to verify key updates. Define signature details such as the order of designated verifiers and whether designated verifiers belong to a user group or have a specific participant role. The Digital Verification standard objects are visible to users with the Health Cloud Advanced Therapy Orchestration permission set license and the Health Cloud Advanced Therapy Orchestration permission set. Available in API version 60.0 and later. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Email Template (PATCH) Update an email template.The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). ## Resource /connect/life-sciences/commercial/bulk-email-template ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/bulk-email-template ## Available Version 65.0 ## HTTP Methods PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - File Input Payload Size: - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload. - Rate Limits: - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour. ## Request Body for PATCH { "emailSubject": "Welcome", "contentDocumentId": "069xx0000004CAeAAM", "name": "Welcome Email", "activatedDate": "2025-06-03T15:00:00.000Z", "senderType": "SYSTEM", "senderEmailFieldAPIName": "noreply@company.com", "replyToType": "USER", "replyToEmailAddress": "support@company.com", "id": "email-template-id", "deactivatedDate": "2025-01-01T00:00:00.000Z", "description": "This is a welcome email template used for onboarding new users.", "attachmentObjectTypes": \[ "PDF", "DOCX" \], "customFields": \[ { "fieldName": "user", "fieldValue": "admin" }, { "fieldName": "standard", "fieldValue": "user" } \], "languages": \[ "en", "es" \], "isActive": true, "surveyId": "sample-survey-id", "productId": "sample-product-id", "communicationSubscriptionId": "sample-comm-subscription-id", "topics": \[ "Onboarding", "User Engagement" \], "shouldIgnoreEmailConsent": false, "isSubjectLineEditable": true, "bccEmailIdList": "bcc@example.com", "automatedEmailContextType": "ProviderVisit", "automatedEmailActionType": "Create", "isDefaultAutoEmailTemplate": false } **Properties**
Property Name Type Description Required
activatedDate Date Date when the email template becomes active. Optional
attachmentObjectTypes List<String> List of object types for attachments. Optional
automatedEmailActionType String Action type for automated emails. Possible values are:
  • Create
  • Update
  • Cancel
 Optional
automatedEmailContextType String Context type for automated emails. Possible values are:
  • ProviderVisit
  • Meeting
 Optional
bccEmailIdList String Email ID for BCC. Optional
communicationSubscriptionId String ID of the communication subscription associated with the email temaplate. Optional
contentDocumentId String ID of the content document ZIP containing the email files. You can pass this parameter if you wish to process the existing document record. You cannot provide this parameter when you pass the fileId. Optional
customFields Object Map of custom field names and their values for the email template. Optional
deactivatedDate Datetime Date when the email template becomes inactive. Optional
description String Description of the email template. Optional
emailSubject String Subject line of the email template. Required, only if the file input is provided either as contentDocumentId or fileId.
fileId String The multipart form field key that references the uploaded file for this presentation page. You can pass this parameter if you wish to process a new file that you will include in the request. You cannot provide this parameter when you pass the contentDocumentId as only one of the two are allowed. Optional
id String ID of the email template. Either the SourceSystemIdentifier or Salesforce ID of the LifeSciEmailTemplate record. Required
isActive Boolean Indicates if the email template is active (true) or not (false). Optional
isDefaultAutoEmailTemplate Boolean Indicates if this is a default automated email template (true) or not (false). Optional
isSubjectLineEditable Boolean Indicates if the email subject line is editable (true) or not (false). Optional
languages List<String> List of languages associated with the email template as per the ISO codes such as en_US, fr, es. Optional
name String Name of the email template. Optional
productId String ID of the associated product. Optional
replyToEmailAddress String Reply-to email address. Optional
replyToType String Type of reply-to address. Possible values are:
  • SalesRep
  • PredefinedEmail
 Optional
senderEmailFieldAPIName String API name of the sender's email field. Optional
senderType String Type of sender for the email. Possible values are:
  • SalesRep
  • PredefinedEmail
 Optional
shouldIgnoreEmailConsent Boolean Indicates whether email consent should be ignored (true) or not (false). Optional
surveyId String ID of the associated survey. Optional
topics List<String> List of topics associated with the email template. TopicAssignment for Life Science EmailTemplate must be enabled before using this field. Optional
## Response Body for PATCH [Update Email Template Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_content_management_output.htm "Represents the information about the job status and any associated messages returned for Content Management APIs.") # Email Template (POST) Create an email template. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). ## Resource /connect/life-sciences/commercial/bulk-email-template ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/bulk-email-template ## Available Version 65.0 ## HTTP Methods POST ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note File Input Payload Size: - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload. Rate Limits: - - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour. ## Request Body for POST { "emailSubject": "Welcome", "contentDocumentId": "069xx0000004CAeAAM", "name": "Welcome Email", "activatedDate": "2025-06-03T15:00:00.000Z", "senderType": "SYSTEM", "senderEmailFieldAPIName": "noreply@company.com", "replyToType": "USER", "replyToEmailAddress": "support@company.com", "id": "external-id", "deactivatedDate": "2025-01-01T00:00:00.000Z", "description": "This is a welcome email template used for onboarding new users.", "attachmentObjectTypes": \[ "PDF", "DOCX" \], "customFields": \[ { "fieldName": "user", "fieldValue": "admin" }, { "fieldName": "standard", "fieldValue": "user" } \], "languages": \[ "en", "es" \], "isActive": true, "surveyId": "sample-survey-id", "productId": "sample-product-id", "communicationSubscriptionId": "sample-comm-subscription-id", "topics": \[ "Onboarding", "User Engagement" \], "shouldIgnoreEmailConsent": false, "isSubjectLineEditable": true, "bccEmailIdList": "bcc@example.com", "automatedEmailContextType": "ProviderVisit", "automatedEmailActionType": "Create", "isDefaultAutoEmailTemplate": false } **Properties**
Property Name Type Description Required
activatedDate Date Date when the email template becomes active. Optional
attachmentObjectTypes List<String> List of object types for attachments. Optional
automatedEmailActionType String Action type for automated emails. Possible values are:
  • Create
  • Update
  • Cancel
 Optional
automatedEmailContextType String Context type for automated emails. Possible values are:
  • ProviderVisit
  • Meeting
 Optional
bccEmailIdList String Email ID for BCC. Optional
communicationSubscriptionId String ID of the communication subscription associated with the email temaplate. Optional
contentDocumentId String ID of the content document ZIP containing the email files. You can pass this parameter if you wish to process the existing document record. This parameter cannot be provided when you pass the fileId. Required
customFields Object Map of custom field names and their values for the email template. Optional
deactivatedDate Datetime Date when the email template becomes inactive. Optional
description String Description of the email template. Optional
emailSubject String Subject line of the email template. Required, only if the file input is provided either as contentDocumentId or fileId
fileId String The multipart form field key that references the uploaded file for this presentation page. You can pass this parameter if you wish to process a new file that you will include in the request. You cannot provide this parameter when you pass the contentDocumentId as only one of the two are allowed. Required
id String ID of the email template. Either the SourceSystemIdentifier or Salesforce Id of the LifeSciEmailTemplate record. Optional
isActive Boolean Indicates if the email template is active (true) or not (false). Optional
isDefaultAutoEmailTemplate Boolean Indicates if this is a default automated email template (true) or not (false). Optional
isSubjectLineEditable Boolean Indicates if the email subject line is editable (true) or not (false). Optional
languages List<String> List of languages associated with the email template as per the ISO codes such as en_US, fr, es. Optional
name String Name of the email template. Required
productId String ID of the associated product. Optional
replyToEmailAddress String Reply-to email address. Optional
replyToType String Type of reply-to address. Possible values are:
  • SalesRep
  • PredefinedEmail
 Optional
senderEmailFieldAPIName String API name of the sender's email field. Optional
senderType String Type of sender for the email. Possible values are:
  • SalesRep
  • PredefinedEmail
 Optional
shouldIgnoreEmailConsent Boolean Indicates whether email consent should be ignored (true) or not (false). Optional
surveyId String ID of the associated survey. Optional
topics List<String> List of topics associated with the email template. TopicAssignment for Life Science EmailTemplate must be enabled before using this field. Optional
## Response Body for POST [Create Email Template Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_content_management_output.htm "Represents the information about the job status and any associated messages returned for Content Management APIs.") # embeddedai Namespace The embeddedai namespace provides classes and methods to manage and represent records and data in Apex to support embedded AI features. These are the classes in the embeddedai namespace. - **[ApexMap Class](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_class_embeddedai_ApexMap)** Create, clone, and convert string based key-value pairs to a JSON string format. - **[RecordApexRepresentation Class](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_class_embeddedai_RecordApexRepresentation)** Contains properties and a method to create a serializable representation of a record and its associated data for AI service integration and data processing. # Enablement Coaching Enablement Coaching helps plan coaching activities, evaluate field employees consistently, and document feedback and development plans. Managers, designated peers, and other authorized evaluators can coach employees without associating an event with a visit. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm). # EnablementCoaching Represents an enablement coaching that facilitates the formal evaluation of attendees. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the enablement coaching ended. ### EnablementPlanComments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The actionable goals and next steps captured as an outcome of the enablement coaching. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique identifier of the enablement coaching record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PlannedEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The planned date and time for the completion of the enablement coaching. ### PlannedStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The planned date and time for the commencement of the enablement coaching. ### PreviousEnablementCoachingId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The previous enablement coaching of the attendee. This field is a relationship field. - **Relationship Name**: PreviousEnablementCoaching - **Refers To**: EnablementCoaching ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the enablement coaching. - **Possible values**: - Acknowledged - Cancelled - EmployeeReview—Feedback Review - Finished—Completed - InReview—Evaluation in Progress - Planned - SelfEvaluation—Self-Evaluation # EnablementCoachingAttendee Represents the attendees of an enablement coaching. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AcknowledgedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the enablement coaching was acknowledged by the attendee. ### AttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person attending the enablement coaching. This field is a relationship field. - **Relationship Name**: Attendee - **Refers To**: User ### AttendeeRole - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the attendee's role in the enablement coaching. ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes or remarks provided by the attendee regarding the enablement coaching. ### EnablementCoachingId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The enablement coaching associated with the attendee. This field is a relationship field. - **Relationship Name**: EnablementCoaching - **Relationship Type**: Master-detail - **Refers To**: EnablementCoaching (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The unique identifier of the enablement coaching record. # EnablementCoachingSession Represents the association between an enablement coaching and its operational context, such as a visit or appointment. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EnablementCoachingId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The enablement coaching associated with a related record, such as a visit. This field is a relationship field. - **Relationship Name**: EnablementCoaching - **Relationship Type**: Master-detail - **Refers To**: EnablementCoaching (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The unique identifier of the enablement coaching record. ### RelatedRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related record that provides the operational context for the enablement coaching. This field is a polymorphic relationship field. - **Relationship Name**: RelatedRecord - **Refers To**: Visit # Encounter The Encounter F​HI​R resource maps to the ​​Clinical​Encounter​, ​​Clinical​Encounter​​Diagnosis, ​​Clinical​Encounter​​Facility, ​​Clinical​Encounter​Identifier, ​​Clinical​Encounter​​Provider, ​​Clinical​Encounter​​Reason, and ​​Clinical​Encounter​Svc​Request objects in Salesforce​. ## F​HI​R V4​.0 - ​Clinical ​Data ​Model ​Mapping ​Here’s how the fields defined by F​HI​R for [Encounter](https://www.hl7.org/fhir/encounter.html) map to the fields in Salesforce​. Table 1. ​Patient - Salesforce | Encounter ​Resource | Salesforce Field | ​Type | Salesforce ​Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | ​​Clinical​Encounter​Identifier | Object | 0​.​M | The identifier information for an encounter is represented as ​​Clinical​Encounter​Identifier records that reference the encounter record using their ​​Clinical​Encounter​Identifier​.​Parent​RecordId field​. | | status | ​Clinical​Encounter​.Status | ​Picklist | 1​.1 | While F​HI​R defines encounter​.status as a code, its Salesforce implementation is a picklist​. | | status​History | N/​A | N/​A | N/​A | Not supported | | class | ​​Clinical​Encounter​​.​Category | ​Picklist | 1​.1 | While F​HI​R defines encounter​.class as a code set, its Salesforce implementation is a picklist​. | | class​History | N/​A | N/​A | N/​A | Not supported | | type | ​​Clinical​Encounter​​.​TypeId | Lookup: ​CodeSet​Bundle | 0​.1 | While F​HI​R defines encounter​.type as a zero-to-many resource, the Salesforce implementation is zero-to-one​. | | service​Type | ​​Clinical​Encounter​​.Service​Type | ​Picklist | 0​.1 | While F​HI​R defines encounter​.service​Type as a code set bundle, its Salesforce implementation is a picklist​. | | priority | ​​Clinical​Encounter​​.​PriorityId | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | subject | ​​Clinical​Encounter​​.​PatientId | Lookup: ​Account | 1​.1 | While F​HI​R defines encounter​.subject as a zero-to-one resource, the Salesforce implementation is one-to-one​. | | episodeOf​Care | N/​A | N/​A | N/​A | Not supported | | basedOn | ​​Clinical​Encounter​Svc​Request | Object | 0​.​M | The service request information that an encounter is based on is represented as ​​Clinical​Encounter​Svc​Request records that reference the encounter record using their ​​Clinical​Encounter​Svc​Request​.​​Clinical​Encounter​Id field​. | | participant | ​​Clinical​Encounter​​Provider | Object | 0​.​M | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. | | participant​.type | ​​Clinical​Encounter​​Provider​.​Practitioner​TypeId | Lookup: ​CodeSet​Bundle | 0​.1 | While F​HI​R defines encounter​.participant​.type as a zero-to-many resource, the Salesforce implementation is zero-to-one​. | | participant​.period | ​​Clinical​Encounter​​Provider​.Start​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.participant​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | participant​.period | ​​Clinical​Encounter​​Provider​.End​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.participant​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | participant​.period | ​​Clinical​Encounter​​Provider​.​Duration | ​Double | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.participant​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | participant​.period | ​​Clinical​Encounter​​Provider​.​Duration​UnitId | Lookup: ​UnitOf​Measure | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.participant​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | participant​.individual | ​​Clinical​Encounter​​Provider​.​Practitioner​Id | Lookup: ​Healthcare​Provider | 0​.1 | N/​A | | appointment | N/​A | N/​A | N/​A | Not supported | | period | ​​Clinical​Encounter​​.Start​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.period resource is flattened into a set of start date and end date fields​. | | period | ​​Clinical​Encounter​​.End​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.period resource is flattened into a set of start date and end date fields​. | | length | ​​Clinical​Encounter​​.​Duration | ​Double | 0​.1 | Because Salesforce doesn’t have a native duration data type, the encounter​.length resource is flattened into a set of duration and duration unit fields​. | | length | ​​Clinical​Encounter​​.​Duration​UnitId | Lookup: ​UnitOf​Measure | 0​.1 | Because Salesforce doesn’t have a native duration data type, the encounter​.length resource is flattened into a set of duration and duration unit fields​. | | reason​Code | ​​Clinical​Encounter​​Reason​.​Reason​CodeId | Lookup: ​CodeSet​Bundle | 0​.​M | The reason for an encounter is represented as ​​Clinical​Encounter​​Reason records that reference the encounter record using their ​​Clinical​Encounter​​Reason​.​​Clinical​Encounter​Id field​. | | reason​Reference | ​​Clinical​Encounter​​Reason​.​Reason​Reference​Id | ​Polymorphic Lookup: ​Health​Condition, ​Care​Observation, and ​Patient​Medical​Procedure | 0​.​M | The reason for an encounter is represented as ​​Clinical​Encounter​​Reason records that reference the encounter record using their ​​Clinical​Encounter​​Reason​.​​Clinical​Encounter​Id field​. | | diagnosis | ​​Clinical​Encounter​​Diagnosis | Object | 0​.​M | The diagnosis information for an encounter is represented as ​​Clinical​Encounter​​Diagnosis records that reference the encounter record using their ​​Clinical​Encounter​​Diagnosis​.​​Clinical​Encounter​Id field​. | | diagnosis​.condition | ​​Clinical​Encounter​​Diagnosis​.​DiagnosisId | ​Polymorphic Lookup: ​Health​​Condition, and ​Patient​​Medical​Procedure | 0​.1 | N/​A | | diagnosis​.use | ​​Clinical​Encounter​​Diagnosis​.Usage​TypeId | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | diagnosis​.rank | ​​Clinical​Encounter​​Diagnosis​.​Diagnosis​Rank | ​Double | 0​.1 | N/​A | | account | N/​A | N/​A | N/​A | Not supported | | hospitalization​.pre​Admission​Identifier​. | ​​Clinical​Encounter​​.​Pre​Admission​Identifier​Id | Lookup: ​​Clinical​Encounter​Identifier | 0​.1 | N/​A | | hospitalization​.origin | ​​Clinical​Encounter​​.​Previous​FacilityId | Lookup: ​Healthcare​Facility | 0​.1 | While F​HI​R defines encounter​.hospitalization​.origin as a single resource, the Salesforce implementation flattens it into two fields​. | | hospitalization​.origin | ​​Clinical​Encounter​​.​Previous​Organization​Id | Lookup: ​Account | 0​.1 | While F​HI​R defines encounter​.hospitalization​.origin as a single resource, the Salesforce implementation flattens it into two fields​. | | hospitalization​.admitSource | ​​Clinical​Encounter​​.​Admission​Source | ​Picklist | 0​.1 | While F​HI​R defines encounter​.hospitalization​.admitSource as a code set bundle, its Salesforce implementation is a picklist​. | | hospitalization​.re​Admission | ​​Clinical​Encounter​​.​Readmission​CodeId | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | hospitalization​.diet​Preference | ​​Clinical​Encounter​​.​Diet​Preference | ​Multi-Select ​Picklist | 0​.​M | While F​HI​R defines encounter​.hospitalization​.diet​Preference as a code set bundle, its Salesforce implementation is a picklist​. | | hospitalization​.special​Courtesy | ​​Clinical​Encounter​​.Special​Courtesy | ​Picklist | 0​.1 | While F​HI​R defines encounter​.hospitalization​.special​Courtesy as a zero-to-many code set bundle, its Salesforce implementation is a zero-to-one picklist​. | | hospitalization​.special​Arrangement | N/​A | N/​A | N/​A | Not supported | | hospitalization​.destination | ​​Clinical​Encounter​​.​Destination​FacilityId | Lookup: ​Healthcare​Facility | 0​.1 | While F​HI​R defines encounter​.hospitalization​.destination as a single resource, the Salesforce implementation flattens it into two fields​. | | hospitalization​.destination | ​​Clinical​Encounter​​.​Destination​Organization​Id | Lookup: ​Account | 0​.1 | While F​HI​R defines encounter​.hospitalization​.destination as a single resource, the Salesforce implementation flattens it into two fields​. | | hospitalization​.discharge​Disposition | ​​Clinical​Encounter​​.​Discharge​Disposition​Id | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | location | ​​Clinical​Encounter​​Facility | Object | 0​.​M | The facility information for an encounter is represented as ​​Clinical​Encounter​​Facility records that reference the encounter record using their ​​Clinical​Encounter​​Facility​.​​Clinical​Encounter​Id field​. | | location​.location | ​​Clinical​Encounter​​Facility​.​FacilityId | Lookup: ​Healthcare​Facility | 0​.1 | N/​A | | location​.status | ​​Clinical​Encounter​​Facility​.Status | ​Picklist | 0​.1 | While F​HI​R defines encounter​.location​.status as a code, its Salesforce implementation is a picklist​. | | location​.physical​Type | ​​Clinical​Encounter​​Facility​.​Facility​TypeId | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | location​.period | ​​Clinical​Encounter​​Facility​.Start​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.location​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | location​.period | ​​Clinical​Encounter​​Facility​.End​Date | ​Date​Time | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.location​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | location​.period | ​​Clinical​Encounter​​Facility​.​Duration | ​Double | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.location​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | location​.period | ​​Clinical​Encounter​​Facility​.​Duration​UnitId | Lookup: ​UnitOf​Measure | 0​.1 | Because Salesforce doesn’t have a native period data type, the encounter​.location​.period resource is flattened into a set of start date and end date fields, and set of duration and duration unit fields​. | | service​Provider | ​​Clinical​Encounter​​.​FacilityId | Lookup: ​Healthcare​Facility | 0​.1 | While F​HI​R defines encounter​.service​Provider as referencing an organization, the Salesforce implementation references a facility​. | | partOf | ​​Clinical​Encounter​​.​Related​​Clinical​Encounter​Id | Lookup: ​​Clinical​Encounter​ | 0​.1 | N/​A | ## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that represents an encounter related to the patient Charles Green in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_encounter.png) #### See Also - [ClinicalEncounter](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounter.htm "Represents a healthcare related encounter of a patient with a care provider. This is a broad object that covers multiple phases of a patient’s healthcare service experience, all the way from pre-admission to stay to discharge, and everything in between. This object is available in API version 51.0 and later.") - [ClinicalEncounterDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterDiagnosis.htm "Represents a diagnosis related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.") - [ClinicalEncounterFacility](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterFacility.htm "Represents 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.") - [ClinicalEncounterIdentifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterIdentifier.htm "Represents the identifier information for a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.") - [ClinicalEncounterProvider](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterProvider.htm "Represents the providers involved in an encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.") - [ClinicalEncounterReason](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterReason.htm "Represents the reasons for why the encounter was required. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.") - [ClinicalEncounterSvcRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalEncounterSvcRequest.htm "Represents the service requests related to a clinical encounter. This object is a child object of ClinicalEncounter. This object is available in API version 51.0 and later.") # Enrollee Product Input Data for a single enrollee product. ## Root XML tag ## JSON example { "providerId": "provider3", "productId": "product4" } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the Product2 object as configured in the Care System Field Mapping. | Yes | 46.0 | | providerId | String | ID of the provider’s account as configured in the Care System Field Mapping. | No | 46.0 | # Enrollee Product Result Details about the enrollee’s products. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Message](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_error_output.htm "A generic error message containing error code and the message text.") | Error code and message. | Small, 46.0 | 46.0 | | isSuccess | Boolean | Indicates if the operation was a success. | Small, 46.0 | 46.0 | | productId | String | Id of the care program product. | Small, 46.0 | 46.0 | | providerId | String | Id of the care program provider. | Small, 46.0 | 46.0 | | created | Boolean | Indicate if the record was created. | Big, 46.0 | 46.0 | | id | String | Id for the newly created CareProgramEnrolleeProduct record. | Big, 46.0 | 46.0 | | objectType | String | The type of the object created. In this case, it is CareProgramEnrolleeProduct. | Big, 46.0 | 46.0 | | status | String | Indicates the status of the record creation. | Big, 46.0 | 46.0 | # Enrollment Card Result Details of the enrollment care for a single enrollee. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Message](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_error_output.htm "A generic error message containing error code and the message text.") | Error code and message. | Small, 46.0 | 46.0 | | isSuccess | Boolean | Indicates if the operation was a success. | Small, 46.0 | 46.0 | | created | Boolean | Indicate if the record was created. | Big, 46.0 | 46.0 | | id | String | Id for the newly created CareProgramEnrollmentCard record. | Big, 46.0 | 46.0 | | objectType | String | The type of the object created. In this case, it is CareProgramEnrollmentCard. | Big, 46.0 | 46.0 | | status | String | Indicates the status of the record creation. | Big, 46.0 | 46.0 | # EnrollmentEligibilityCriteria Represents criteria that define patient enrollment eligibility for one or more care programs. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: A comprehensive description of the enrollment eligibility criteria. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: A short name for the enrollment eligibility criteria. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ## 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. [EnrollmentEligibilityCriteriaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [EnrollmentEligibilityCriteriaFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [EnrollmentEligibilityCriteriaHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [EnrollmentEligibilityCriteriaOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [EnrollmentEligibilityCriteriaShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # EpisodeOfCare The episodeOfCare FHIR resource maps to the Care​Episode​ and Care​EpisodeDetail​ objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [episodeOfCare](http://hl7.org/fhir/R4/episodeofcare.html#resource) map to the fields in Salesforce. Table 1. episodeOfCare - Salesforce | Goal Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.M | The identifier information for an episode of care is represented as Identifier records that reference the Care​Episode record using their Identifier​.Parent​RecordId field​. | | status | Care​Episode​.Status | Picklist | 1.1 | While FHIR defines this field as a code value, the Salesforce implementation is a picklist. | | status​History | N/A | N/A | N/A | Not supported | | type | Care​Episode​.Type | Multi-Select Picklist | 0.M | While FHIR defines this field as a codeable concept, the Salesforce implementation is a multi-select picklist. | | diagnosis​.condition | Care​Episode​Detail​.Detail​Type | Picklist | 0.M | Select Diagnosis as the picklist value in detailType. | | diagnosis​.condition | Care​Episode​Detail​.Detail​RecordId | Lookup: Health​Condition | 0.M | Select Diagnosis as the picklist value in detailType. | | diagnosis​.role | Care​Episode​Detail​.RoleCodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | N/A | | diagnosis​.rank | Care​Episode​Detail​.Rank | Number | 0.1 | N/A | | patient | Care​Episode​.PatientId | Master-Detail: Account | 1.1 | N/A | | managing​Organization | Care​Episode​.Responsible​Organization​Id | Lookup: Account, Healthcare​Provider | 0.1 | N/A | | period | Care​Episode​.Start​Date​Time | DateTime | 0.1 | The Salesforce implementation implements the Period data type as a pair of DateTime fields. | | period | Care​Episode​.End​End​Date​Time | DateTime | 0.1 | The Salesforce implementation implements the Period data type as a pair of DateTime fields. | | referral​Request | Care​Episode​Detail​.Detail​Type | Picklist | 0.1 | Select Referral Request as the picklist value in detailType. | | referral​Request | Care​Episode​Detail​.Detail​RecordId | Lookup: Clinical​Service​Request | 0.1 | Select Clinical​Service​Request as the domain set for Reference​RecordId. | | care​Manager | Care​Episode​.Care​Coordinator​Id | Lookup: Healthcare​Provider, Healthcare​Practitioner​Facility | 0.1 | N/A | | team | N/A | N/A | N/A | Not supported | | account | N/A | N/A | N/A | Not supported | # Error Message A generic error message containing error code and the message text. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | Error code. | Small, 46.0 | 46.0 | | message | String | Error message text. | Small, 46.0 | 46.0 | # Error Response Output Error response representation. ## JSON Example { "error": { "code": "INVALID\_INPUT", "message": "The ReceivedDocument field doesn’t exist in the specified DocumentChecklistItem object." } } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | errorCode | String | Error code. | Small, 55.0 | 55.0 | | message | String | Message stating the reason for error, if any. | Small, 55.0 | 55.0 | # EstimatedExpense Represents the estimated expense of a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The amount estimated to be incurred for an expense. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the estimated expense. ### ExpenseSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the managed event associated with the estimated expense. This field is a polymorphic relationship field. - **Relationship Name**: ExpenseSource - **Refers To**: MngEvent ### ExpenseTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the expense type associated with the expense. This field is a relationship field. - **Relationship Name**: ExpenseType - **Refers To**: ExpenseType ### FundingSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the budget or the managed event budget that has provided the funding for the estimated expense. This field is a polymorphic relationship field. - **Relationship Name**: FundingSource - **Refers To**: Budget, MngEventBudget ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the estimated expense. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of the resource that the estimated expense is allocated for. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the estimated expense. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price of each unit of the resource that the estimated expense is allocated for. ## 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. EstimatedExpenseFeed Feed tracking is available for the object. EstimatedExpenseHistory History is available for tracked fields of the object. EstimatedExpenseShare Sharing is available for the object. # EstimatedExpensePtcpAlloc Each row represents an allocation of managed event participant to an estimated expense of a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The amount allocated to the participant for an estimated expense. ### EstimatedExpenseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The amount a participant estimates will be spent at the managed event. This field is a relationship field. - **Relationship Name**: EstimatedExpense - **Relationship Type**: Master-detail - **Refers To**: EstimatedExpense (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Estimated Expense Participant Allocation. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the managed event participant who's incurring the expense. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Refers To**: MngEventParticipant # Evaluate Access Action Evaluates a specified access check (user permission) against the current security context and returns whether the running user has the requested permission. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/evaluateAccess Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: GET **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
type String Required

The type of access check to evaluate. Supported value: UserPermission.
name String Required

The API name of the access check setting to evaluate.
## Outputs | Output | Type | Description | | --- | --- | --- | | isEnabled | Boolean | Indicates whether the access check evaluates to true for the current security context. | ## Example Sample Request { "inputs": \[ { "type": "UserPermission", "name": "SkipLifeSciencesTriggerHandlers" } \] } Sample Response \[ { "actionName": "evaluateAccess", "errors": null, "isSuccess": true, "outputValues": { "isEnabled": true } } \] # Event Management Event Management enables life sciences organizations to plan and execute regulated field events, including speaker programs, representative-led meetings, and healthcare professional (HCP) sponsorship events, within a structured, compliant workflow. Sales representatives create and manage events from initial planning through close-out, by coordinating with participants, assigning subjects, tracking expenses, and selecting the event resources. Built on configurable workflow paths, Event Management enforces compliance through expert eligibility checks, subject assignment rules, monetary cap validations, and compliance statement acknowledgments. Administrators can tailor the workflow to match their organization's unique operational requirements. ![Event Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_event_management_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/life-sciences-consent-management.html "HTML (New Window)"). ## Event Management Objects in Life Sciences Customer Engagement - [Activity Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_activityplan.htm) - [Estimated Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_estimatedexpense.htm) - [Event Management Participant Role](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtparticipantrole.htm) - [Event Management Participant Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtparticipanttype.htm) - [Event Management Participant Type Role Mapping](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventmgmtptcptyperolemap.htm) - [Expense](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_expense.htm) - [Expense Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expenseparticipant.htm) - [Expense Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expensetype.htm) - [Expert](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expert.htm) - [Expert Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_expertsubject.htm) - [Managed Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngevent.htm) - [Managed Event Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventparticipant.htm) - [Managed Event Participant Discrepancy](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventparticipantdiscrepancy.htm) - [Managed Event Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventproduct.htm) - [Managed Event Resource](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventresource.htm) - [Managed Event Resource Preference](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventresourcepreference.htm) - [Managed Event Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventterritory.htm) - [Managed Event Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventtype.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Forum](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationforum.htm) - [Provider Activity Goal](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoal.htm) - [Provider Activity Goal Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoallimit.htm) - [Provider Activity Goal Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitygoalmeasure.htm) - [Provider Activity Measure Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideractivitymeasuretype.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [Subject Material Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectmaterialtemplate.htm) - [Subject Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectproduct.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) ## Event Management Extended Capabilities Explore additional objects that you can use to extend Event Management capabilities beyond the standard workflows. For more information on each object, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm "Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform.") and [Grantmaking Object Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_object_reference_parent.htm). - [Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budget.htm) - [Budget Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetcategory.htm) - [Budget Category Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetcategoryvalue.htm) - [Budget Managed Event Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetmngeventtype.htm) - [Budget Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.nonprofit_cloud.meta/nonprofit_cloud/sforce_api_objects_budgetperiod.htm) - [Budget Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetproduct.htm) - [Budget Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_budgetterritory.htm) - [Estimated Expense Participant Allocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_estimatedexpenseptcpalloc.htm) - [Event Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplan.htm) - [Event Plan Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanbudget.htm) - [Event Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanitem.htm) - [Event Plan Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanparticipant.htm) - [Event Plan Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanproduct.htm) - [Event Plan Service Specialization](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplansvcspclzn.htm) - [Event Plan Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplansubject.htm) - [Event Plan Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_eventplanterritory.htm) - [Geo Country](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_geocountry.htm) - [Managed Event Budget](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngeventbudget.htm) - [Restricted Party](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_restrictedparty.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # EventMgmtParticipantRole Each row represents the responsibility or function a participant performs within an event. For example, organizing, coordinating, presenting, or attending. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Event Management Participant Role. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the configurable name of the role assigned to a participant in a managed event. ### StandardRole - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Represents the predefined participant role provided by the system. - **Possible values**: - Approver - Attendee - Contributor - Coordinator - Coorganizer - Expert - HostOrganizer - HostSpeaker - Organizer - Other - SatelliteOrganizer # EventMgmtParticipantType Each row represents the category or classification of participants associated with a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Event Management Participant Type. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### StandardType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The standard participant types that are predefined. - **Possible values**: - Attendee - Colleague - Expert - NonProfiledAttendee - Other - WriteInAttendee ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The category of the event participant. # EventMgmtPtcpTypeRoleMap Each row represents the mapping of allowed participant roles to specific participant types for a given event type. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### EventMgmtParticipantRoleId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the participant role that defines the responsibility or function of the participant within the event. This field is a relationship field. - **Relationship Name**: EventMgmtParticipantRole - **Refers To**: EventMgmtParticipantRole ### EventMgmtParticipantTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the category of an event participant. This field is a relationship field. - **Relationship Name**: EventMgmtParticipantType - **Refers To**: EventMgmtParticipantType ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the participant type and role mapping is currently active (True) or not (False). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### MngEventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the managed event type for which the participant type and role combination is allowed. This field is a relationship field. - **Relationship Name**: MngEventType - **Refers To**: MngEventType ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Event Management Participant Type Role Mapping. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User # EventPlan Represents the plan for an event type. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of event plan. ### CountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country that the event plan is for. This field is a relationship field. - **Relationship Name**: Country - **Refers To**: GeoCountry ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the event plan, including the objectives for the plan. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the event plan. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PrimaryOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who is the primary owner of the event plan. This field is a relationship field. - **Relationship Name**: PrimaryOwner - **Refers To**: User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the event plan. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies the status of the event plan. - **Possible values**: - Active - Archived - Draft ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies the type of business process that the record is for. - **Possible values**: - ManagedEvent—Managed Event ### VersionNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version number of the event plan. ## 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. EventPlanFeed Feed tracking is available for the object. EventPlanHistory History is available for tracked fields of the object. EventPlanShare Sharing is available for the object. # EventPlanBudget Represents a junction between an event plan and a budget that's allocated for the event plan. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BudgetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The budget that the event plan's expenses are allocated to. This field is a relationship field. - **Relationship Name**: Budget - **Refers To**: Budget ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The event plan that the related budget is a part of. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan budget. ## 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. EventPlanBudgetFeed Feed tracking is available for the object. EventPlanBudgetHistory History is available for tracked fields of the object. # EventPlanItem Represents an item of an event plan. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that are currently associated with the event plan item. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that has been spent across all the events associated with the event plan item. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the event plan item. ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The event plan item that the current event plan item rolls up to. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events that can roll up to the event plan item. ### MaxExpertLimitPerEvent - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of experts that are allowed for each event associated with the event plan item. ### MaxPtcpLimitPerEvent - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of participants that are allowed for each event associated with the event plan item. ### MaxSpendAmountLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: ### MaxSpendAmtLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent across all events associated with the event plan item. ### MngEventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The managed event type associated with the event plan item. This field is a relationship field. - **Relationship Name**: MngEventType - **Refers To**: MngEventType ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan item. ### ParentEventPlanItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The event plan item that the current event plan item rolls up to. This field is a relationship field. - **Relationship Name**: ParentEventPlanItem - **Refers To**: EventPlanItem ### Period - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the period type of the event plan. - **Possible values**: - Monthly - Quarterly - Yearly ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the event plan item. ## 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. EventPlanItemFeed Feed tracking is available for the object. EventPlanItemHistory History is available for tracked fields of the object. # EventPlanParticipant Represents a junction between an event plan and the person who is set to participate in events that roll up to the event plan. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the contract that's generated for the event plan participant. This field is a relationship field. - **Relationship Name**: Contract - **Refers To**: Contract ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that the participant has currently participated in. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that the participant has spent across all the events that they have participated in. ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The event plan that the related participant belongs to. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events the participant can be a part of. ### MaxSpendAmtLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that the participant can spend across all events they participate in. ### MaxSpendAmtLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can that can be spent towards the participant for the events that they participate in. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan participant. ### ParticipantReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person or organization that's part of the related event plan. This field is a polymorphic relationship field. - **Relationship Name**: ParticipantReference - **Refers To**: Account, Expert ### ParticipantRoleId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the role of the participant in the event plan. This field is a relationship field. - **Relationship Name**: ParticipantRole - **Refers To**: ParticipantRole ### ParticipantType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of participant who is part of the event plan. ## 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. EventPlanParticipantFeed Feed tracking is available for the object. EventPlanParticipantHistory History is available for tracked fields of the object. # EventPlanProduct Represents a junction between an event plan and a product or category that's part of the event plan. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that the product or category has currently been a part of. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that has spent across on the product or category across all events. ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The event plan that the related product or category is a part of. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events the product or category can be a part of. ### MaxSpendAmtLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent for the product or category across all events. ### MaxSpendAmtLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent on the product or category for an event. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autogenerated number of the event plan product. ### ProductCategoryId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The category associated with the event plan product. This field is a relationship field. - **Relationship Name**: ProductCategory - **Refers To**: ProductCategory ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with the event plan product. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The product or category that is part of the event plan. This field is a polymorphic relationship field. - **Relationship Name**: ProductReference - **Refers To**: Product2, ProductCategory ## 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. EventPlanProductFeed Feed tracking is available for the object. EventPlanProductHistory History is available for tracked fields of the object. # EventPlanSubject Represents a junction between an event plan and a subject that's part of the event plan. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that the subject has currently been a part of. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that has spent across on the subject across all events. ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The event plan that the related subject is a part of. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events the subject can be a part of. ### MaxSpendAmtLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent for the subject across all events. ### MaxSpendAmtLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent on the subject for an event. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The autogenerated number of the event plan subject. ### SubjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The subject that is part of the event plan. This field is a relationship field. - **Relationship Name**: Subject - **Refers To**: Subject ## 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. EventPlanSubjectFeed Feed tracking is available for the object. EventPlanSubjectHistory History is available for tracked fields of the object. # EventPlanSvcSpclzn Each row represents a junction between an event plan and a specific event service specialization, ensuring the plan's resources are appropriately constrained by the specialization's compliance and budgetary rules to maintain strategic alignment. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that the specialization or tier has currently been a part of. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that is spent on the specialization or tier across all events. ### EventMgmtSvcSpclznId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the service specialization that is associated with the event plan. This field is a relationship field. - **Relationship Name**: EventMgmtSvcSpclzn - **Refers To**: EventMgmtSvcSpclzn ### EventMgmtSvcSpclznTierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the service specialization tier that is associated with the event plan. This field is a relationship field. - **Relationship Name**: EventMgmtSvcSpclznTier - **Refers To**: EventMgmtSvcSpclznTier ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the event plan that the related event service specialization is a part of. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events the specialization or tier can be a part of. ### MaxSpendAmountLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent for the specialization or tier across all events. ### MaxSpendAmountLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent on the specialization or tier for an event. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan service specialization. ## 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. EventPlanSvcSpclznFeed Feed tracking is available for the object. EventPlanSvcSpclznHistory History is available for tracked fields of the object. # EventPlanTerritory Represents a junction between an event plan and the territory that the event plan is for. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of events that the territory has currently organised. ### CurrentTotalSpendAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that the territory has spent across across all events. ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The event plan for the related territory. This field is a relationship field. - **Relationship Name**: EventPlan - **Relationship Type**: Master-detail - **Refers To**: EventPlan (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MaxEventLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events the territory can organize. ### MaxSpendAmtLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent by the territory across all events. ### MaxSpendAmtLimitPerEvent - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum amount that can be spent by the territory for an event. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the event plan territory. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The territory that the event plan is for. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. EventPlanTerritoryChangeEvent Change events are available for the object. EventPlanTerritoryFeed Feed tracking is available for the object. EventPlanTerritoryHistory History is available for tracked fields of the object. # Expense Life Sciences Cloud fields extend the standard Expense object to represent expenses related to a visit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The amount of the expense. ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The notes that are attached to the managed event participant. ### EstimatedExpenseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the estimated expense associated with the expense. This field is a relationship field. - **Relationship Name**: EstimatedExpense - **Refers To**: EstimatedExpense ### ExpenseNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the expense. ### ExpenseOriginId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated provider visit record. This field is a polymorphic relationship field. - **Relationship Name**: ExpenseOrigin - **Refers To**: Visit ### ExpenseSystemIntegrationError - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The error details from the expense system integration. ### ExpenseSystemIntegrationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the expense system integration for the expense. ### IsAllocationUneven - **Type**: boolean - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the expense allocation is uneven across participants. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of the expense. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RelatedExpenseType - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated expense type record. This field is a relationship field. - **Relationship Name**: RelatedExpenseType - **Refers To**: ExpenseType ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ### TransactionDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The date when the expense is incurred for the provider visit. # ExpenseParticipant Represents a junction between an expense and the person who incurred the expense. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Amount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The amount that the expense participant spent. ### ExpenseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the expense associated with the expense participant. This field is a relationship field. - **Relationship Name**: Expense - **Relationship Type**: Master-detail - **Refers To**: Expense (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the expense participant. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of either the account, contact, or managed event participant associated with the expense participant. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Refers To**: Account, Contact, MngEventParticipant ### PrvdExpenseSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the expense system linked to the health care provider. ## 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. ExpenseParticipantFeed Feed tracking is available for the object. ExpenseParticipantHistory History is available for tracked fields of the object. # ExpenseType The ExpenseType object is a category that's used to classify an expense that occurs. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AllocationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: How the expense type is allocated. - **Possible values**: - GroupAllocation—Group Allocation - IndividualAllocation—Individual Allocation - MultipleAllocations—Multiple Allocations - NotApplicable—Not Applicable ### Classification - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the expense. Valid values are Estimate and Actual. Estimate expenses are used for planning, and actual expenses indicate when expenses are incurred. - **Possible values**: - Actual - Estimate ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the expense type. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective end date of the expense type. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective start date of the expense type. ### ExpenseAvailabilityType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the modules for which the expense type is available - **Possible values**: - ProviderVisit ### ExpenseSystemPaymentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SAP Concur payment type information. ### IconName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the icon shown for an expense type. ### IsIncludedInCap - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expense is included in the monetary cap. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the expense type. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the expense type record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentExpenseTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent expense type associated with the record. This field is a relationship field. - **Relationship Name**: ParentExpenseType - **Refers To**: ExpenseType ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### TypeCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SAP Concur expense type code or category. ## 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. [ExpenseTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ExpenseTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ExpenseTypeShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Expert Represents the details of an expert who can speak or present at managed events. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the person account of the the expert who is external to the company. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### AdditionalInformation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional information about the expert, including background, expertise summary, professional overview, and any other relevant context for their profile. ### EvaluationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the evaluation staus of the expert. The evaluation can include processes such as background checks, compliance checks, and credentials. ### ExpenseSysExpertIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the expert in an external system. For example, Concur Attendee ID. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expert is active. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the expert. ### PrimaryOrganizationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the account of the organization that the expert is primarily associated with. This field is a relationship field. - **Relationship Name**: PrimaryOrganization - **Refers To**: Account ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the expert. - **Possible values**: - Approved - Nominated - Rejected ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of expert. ## 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. ExpertFeed Feed tracking is available for the object. ExpertHistory History is available for tracked fields of the object. # ExpertSubject Represents a junction between an expert and the subject that the expert is certified to speak or present about in managed events. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### EffectiveDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Required. Specifies the date and time from when the expert is qualified as a subject expert. ### ExpertId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the expert. This field is a relationship field. - **Relationship Name**: Expert - **Relationship Type**: Master-detail - **Refers To**: Expert (the master object) ### ExpirationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time until when the expert is qualified as a subject expert. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the expert subject. ### QualificationEventPtpcId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The managed event participant that associates the expert with the managed event they participated in to qualify as an expert on the subject. This field is a relationship field. - **Relationship Name**: QualificationEventPtpc - **Refers To**: MngEventParticipant ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the current status of the subject expert. ### SubjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the subject that the expert has expertise on. This field is a relationship field. - **Relationship Name**: Subject - **Refers To**: Subject ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ## 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. ExpertSubjectFeed Feed tracking is available for the object. ExpertSubjectHistory History is available for tracked fields of the object. # FHIR Address The output representation of the FHIR address values. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | city | String | The city of the address. | Small, 53.0 | 53.0 | | country | String | The country of the address. | Small, 53.0 | 53.0 | | line | String | The street of the address. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | periodEnd | String | The date until when the address is active. | Small, 53.0 | 53.0 | | periodStart | String | The date from when the address is active. | Small, 53.0 | 53.0 | | postalCode | String | The postal code for the address. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the address record that’s created in Salesforce. | Small, 53.0 | 53.0 | | state | String | The state or province of the address. | Small, 53.0 | 53.0 | | type | String | The type of the address. For example, physical and postal. | Small, 53.0 | 53.0 | | use | String | The usage type of the address. | Small, 53.0 | 53.0 | # FHIR Address Input Input representation for the Address FHIR object. The Address FHIR object maps to the [ContactPointAddress](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Address.htm "The Address FHIR resource maps to the Contact​Point​Address​ object in Salesforce.") object in Salesforce. ## JSON example { "address": \[ { "use": "temp", "type": "postal", "city": "San Francisco", "state": "California", "country": "U.S", "postalCode": "12345", "line": "Salesforce", "periodStart": "1999-11-09T15:40:30.000Z", "periodEnd": "20202-01-02T15:40:30.000Z" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | city | String | The city of the address. | Optional | 53.0 | | country | String | The country of the address. | Optional | 53.0 | | line | String | The street of the address. | Optional | 53.0 | | periodEnd | String | The date until when the address is active. | Optional | 53.0 | | periodStart | String | The date from when the address is active. | Optional | 53.0 | | postalCode | String | The postal code for the address. | Optional | 53.0 | | state | String | The state or province of the address. | Optional | 53.0 | | type | String | The type of address. For example, postal and physical. | Optional | 53.0 | | use | String | The usage type of the address. | Optional | 53.0 | # FHIR Codeable Concept The output representation of the Code Set Bundle records created to represent a codeableConcept value. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | coding | [.FHIR Coding](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_coding_output.htm "The output representation of the Code Set records created to represent a Coding value.")\[\] | The code set records created to represent the codings specified in the [codeableConcept](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept.htm "Input representation for the Codeable​Concept FHIR object.") input. | Small, 53.0 | 53.0 | | hash | String | The unique code set bundle key that represents the combination of code sets included in the code set bundle. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the code set bundle records created in Salesforce to store the codeableConcept values. | Small, 53.0 | 53.0 | | text | String | The human-readable textual representation of the concept, as specified in the codeableConcept request. | Small, 53.0 | 53.0 | # FHIR Codeable Concept Input Input representation for the Codeable​Concept FHIR object. The Codeable​Concept FHIR object maps to the [CodeSetBundle](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_CodeableConcept.htm "The Codeable​Concept FHIR resource maps to the CodeSet​BundleBundle object in Salesforce.") object in Salesforce. ## Root XML tag ## JSON example { "codeableConcept": { "text": "Burn of Ear", "coding": \[ { "display": "Burn of ear", "code": "1234567", "system": "http://sfdc.co", "version": "2.16.840.1.113883.6.96", "isActive": true, "isPrimary": true, "use": "Clinical", "userSelected": true, "startDate": "1993-11-09T15:40:30.000Z", "endDate": "2021-08-24T17:00:00.000Z", "additionalInformation": \[ { "fieldName": "IsCustomCode", "dataType": "boolean", "fieldValue": true } \] }, { "display": "Burn of ear", "code": "9876543", "system": "http://sfdc.org", "version": "3.17.841.2.113884.7.97", "isActive": true, "isPrimary": true, "use": "Clinical", "userSelected": true, "startDate": "1997-01-25T03:40:30.000Z", "endDate": "2021-08-24T05:00:00.000Z", "additionalInformation": \[ { "fieldName": "IsCustomCode", "dataType": "boolean", "fieldValue": true } } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | coding | [FHIR Coding Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_coding.htm "Input representation for the Coding FHIR object.")\[\] | The codes that are part of this codeableConcept. You can specify up to 15 codings for a concept. | Optional | 53.0 | | hash | String | The unique key that represents the concept with its combination of codings. If this value isn’t specified explicitly, a value is auto-generated by the system. | Optional | 53.0 | | recordId | String | recordId | Optional | 53.0 | | text | String | The human-readable textual representation of the concept represented by the codeableConcept and its codings. | Optional | 53.0 | # FHIR Codeable Concept Or ID Input Input representation for FHIR Codeable Concept or ID. ## Root XML tag ## JSON example { "codeableConcept":{ "text":"Burn of Ear status reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"1234995607", "system":"http://sfdc.co", "version":"2.16.840.1.113883.6.96", "isActive":true, "isPrimary":true, "use":"Clinical", "userSelected":true, "startDate":"1993-11-09T15:40:30.000Z", "endDate":"2021-08-24T17:00:00.000Z" } \] } } ## Properties
Name Type Description Required or Optional Available Version
codeableConcept FHIR Codeable Concept Represents the CodeableConcept FHIR object. Required

Note: Optional if salesforceId is specified.

 54.0
salesforceId String The ID of the Salesforce record. Required

Note: Optional if codeableConcept is specified.

 54.0
# FHIR Coding The output representation of the Code Set records created to represent a Coding value. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | code | String | The industry-defined code that represents a concept, and is defined by a system and its version. | Small, 53.0 | 53.0 | | display | String | The human-readable textural representation of the concept represented by the code. | Small, 53.0 | 53.0 | | endDate | String | The date until when the code set is valid. | Small, 53.0 | 53.0 | | hash | String | The unique code set key associated with the code set record. | Small, 53.0 | 53.0 | | isActive | Boolean | Indicates whether the code set is active or not. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the code set record created to store a coding value. | Small, 53.0 | 53.0 | | startDate | String | The date from when the code set is valid. | Small, 53.0 | 53.0 | | system | String | The terminology system that defines the meaning of the code set. | Small, 53.0 | 53.0 | | use | String | The code set usage type associated with the code set record, stored as a picklist value. | Small, 53.0 | 53.0 | | userSelected | Boolean | Indicates whether the code was selected directly by the user and is intended to be the primary code for the concept. | Small, 53.0 | 53.0 | | version | String | The version of the system that defines a code set. | Small, 53.0 | 53.0 | # FHIR Coding Input Input representation for the Coding FHIR object. The Coding FHIR object maps to the [CodeSet](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Coding.htm "The Coding FHIR resource maps to the CodeSet object in Salesforce.") object in Salesforce. ## Root XML tag ## JSON example "coding": \[ { "display": "Burn of ear", "code": "1234567", "system": "http://sfdc.co", "version": "2.16.840.1.113883.6.96", "isActive": true, "isPrimary": true, "use": "Clinical", "userSelected": true "startDate": "1993-11-09T15:40:30.000Z", "endDate": "2021-08-24T17:00:00.000Z", "additionalInformation": \[ { "fieldName": "IsCustomCode", "dataType": "boolean", "fieldValue": true } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | code | String | The industry-defined code that represents a concept and is defined by its system version. | Optional | 53.0 | | display | String | The human-readable text representation of the code. | Optional | 53.0 | | endDate | String | The date until when the code is valid. | Optional | 53.0 | | hash | String | The code set key associated with the code set record create for this coding. This field is a text field with a unique value to identify the code set record. You can either manually assign a code set key, or let the system generate one for you if you don’t specify it in your request. | Optional | 53.0 | | isActive | Boolean | Indicates whether the code is active (true) or not (false). | Optional | 53.0 | | isCustomCode | Boolean | Indicates whether the defined code is a custom code (true) or not (false). | Optional | 54.0 | | recordId | String | The Salesforce record ID of the code. | Optional | 53.0 | | startDate | String | The date from when the code is valid. | Optional | 53.0 | | system | String | The terminology system that defines the code. | Optional | 53.0 | | use | String | The code set type associated with the code set record, stored as a picklist value. | Optional | 53.0 | | userSelected | Boolean | Indicates whether the code was selected directly by the user and is intended to be the primary code for the concept. | Optional | 53.0 | | version | String | The version of the system that defines the code. | Optional | 53.0 | # FHIR Contact Point The output representation of contact details stored as a ContactPointPhone record. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | periodEnd | String | The date until when a contact detail is active. | Small, 53.0 | 53.0 | | periodStart | String | The date from when a contact detail is active. | Small, 53.0 | 53.0 | | rank | Integer | The preferred order in which the patient’s contact details are to be used. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the record created to store the contact detail. | Small, 53.0 | 53.0 | | system | String | The communication system associated with a contact detail. For example, phone and email. | Small, 53.0 | 53.0 | | use | String | The usage type of the contact detail. | Small, 53.0 | 53.0 | | value | String | The contact number or email address stored in the Contact​Point​Phone​.Telephone​Number. Contact​Point​Phone​.Area​Code, Contact​Point​Phone​.Extension​Number, and Contact.​Email fields. | Small, 53.0 | 53.0 | # FHIR Contact Point Input Input representation for the ContactPoint FHIR object. The ContactPoint FHIR object maps to the [ContactPoint](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_ContactPoint.htm "The ContactPoint FHIR resource maps to the Contact​Point​Phone​ object in Salesforce.") object in Salesforce. ## JSON example { "ContactPoint": \[ { "system": "email", "value": "a@bc.com", "use": "office", "rank": "1", "periodStart": "1998-05-26T15:40:30.000Z", "periodEnd": "2021-08-09T15:40:30.000Z" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | periodEnd | String | The date until when the contact detail is active. | Optional | 53.0 | | periodStart | String | The date from when the contact detail is active. | Optional | 53.0 | | rank | Integer | The preference rank of the contact detail among all the contact details associated with a person. | Optional | 53.0 | | system | String | The system of the contact detail. For example, email and phone. | Optional | 53.0 | | use | String | The usage type of the contact detail. For example, home and office. | Optional | 53.0 | | value | String | The actual details of the patient’s contact point phone record stored in the Contact​Point​Phone​.Telephone​Number. Contact​Point​Phone​.Area​Code, Contact​Point​Phone​.Extension​Number, and Contact.​Email fields. | Optional | 53.0 | # FHIR Dispense Input The input representation of FHIR Dispense. ## Root XML tag ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | medicationReference | String | The reference of the medication request. | Optional | 54.0 | # FHIR Dosage Input The input representation of dosage information for a patient’s medication. The Dosage FHIR resource maps to the [PatientMedicationDosage](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_PatientMedicationDosage.htm "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.") object in Salesforce. ## Root XML tag ## JSON example { "sequence":"10.0", "text":"commentsText", "additionalInstruction":"Additioanl Instructions", "patientInstruction":"Patient Instructions", "asNeeded":"true", "site":{ "salesforceId":"0iPxx00000000MbEAI" }, "route":{ "codeableConcept":{ "text":"Burn of Ear route", "coding":\[ { "display":"Burn of ear route", "code":"123456700", "system":"http://sfdc.co", "version":"2.16.840.1.113883.6.96", "isActive":true, "isPrimary":true, "use":"Clinical", "userSelected":true, "startDate":"1993-11-09T15:40:30.000Z", "endDate":"2021-08-24T17:00:00.000Z", } \] } }, "method":{ "codeableConcept":{ "text":"Burn of Ear Method", "coding":\[ { "display":"Burn of ear", "code":"1234567777", "system":"http://sfdc.co", "version":"2.16.840.1.113883.6.96", "isActive":true, "isPrimary":true, "use":"Clinical", "userSelected":true, "startDate":"1993-11-09T15:40:30.000Z", "endDate":"2021-08-24T17:00:00.000Z", } \] } }, "doseAndRate":{ "type":"Ordered", "dose":{ "dosageQuantityType":"Dose", "dosageQuantityNumerator":"10", "dosageQuantityDenominator":"20", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTest", "description":"MG description", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "salesforceId":"0hExx0000000001EAA" } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalInformation | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | The additional information associated with the medication for the patient. | Optional | 54.0 | | additionalInstruction | String | The supplemental instructions or warnings associated with the medication for the patient. | Optional | 54.0 | | asNeeded | Boolean | Indicates whether the medication is taken on an as-needed basis. | Optional | 54.0 | | doseAndRate | [FHIR Dose And Rate Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_dose_and_rate.htm "Input representation of the specified dose and rate.") | The amount of dosage administration. | Optional | 54.0 | | method | [FHIR Codeable Concept Or ID Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept_or_id.htm "Input representation for FHIR Codeable Concept or ID.") | The method of dosage administration. | Optional | 54.0 | | patientInstruction | String | The patient or consumer instructions associated with this medication. | Optional | 54.0 | | route | [FHIR Codeable Concept Or ID Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept_or_id.htm "Input representation for FHIR Codeable Concept or ID.") | The route of dosage adminisitration. | Optional | 54.0 | | sequence | Double | The position of this medication in the sequence of medications prescribed to a patient. | Optional | 54.0 | | site | [FHIR Codeable Concept Or ID Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept_or_id.htm "Input representation for FHIR Codeable Concept or ID.") | The site of dosage adminisitration. | Optional | 54.0 | | sourceSystem | String | The source system from where the dosage record was brought into Salesforce. | Optional | 54.0 | | sourceSystemId | String | The identifier of the dosage record in its source system. | Optional | 54.0 | | sourceSystemModified | String | The date and time when the dosage record was last modified in its source system. | Optional | 54.0 | | text | String | The free text dosage instructions associated with the medication for the patient. | Optional | 54.0 | # FHIR Dose Input representation for the dosage quantity. ## Root XML tag ## JSON example { "dosageQuantityType":"Dose", "dosageQuantityNumerator":"10", "dosageQuantityDenominator":"20", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTttest", "description":"MG description", "type":"Custom" } } } ## Properties
Name Type Description Required or Optional Available Version
dosageQuantityDenominator Double The denominator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range. Optional 54.0
dosageQuantityNumerator Double The numerator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range. Optional 54.0
dosageQuantityType String The type of dosage quantity recorded in DosageQuantityNumerator and DosageQuantityDenominator.
Possible values are:
  • Dose
  • Dose Range
 Optional 54.0
dosageUnit FHIR Unit Of Measure Or ID The unit of dosage quantity. Optional 54.0
# FHIR Dose And Rate Input representation of the specified dose and rate. ## Root XML tag ## JSON example { "type":"Ordered", "dose":{ "dosageQuantityType":"Dose", "dosageQuantityNumerator":"10", "dosageQuantityDenominator":"20", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTttest", "description":"MG description", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | dose | [FHIR Dose Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_dose.htm "Input representation for the dosage quantity.") | Represents the dosage quantity. | Optional | 54.0 | | rate | [FHIR Rate Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_rate.htm "Input representation for dosage rate.") | Represents the dosage rate. | Optional | 54.0 | | type | String | The type of the specified dose. | Optional | 54.0 | # FHIR Human Name The output representation of a PersonName record created to represent a humanName value. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | family | String | The family name of the patient. This field stores a combination of the person’s middle and last names. | Small, 53.0 | 53.0 | | given | String | The first name of the person. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | periodEnd | String | The date until when the name is active. | Small, 53.0 | 53.0 | | periodStart | String | The date from when the name is active. | Small, 53.0 | 53.0 | | prefix | String | The prefix attached to the person’s name. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the PersonName record created to store the humanName value. | Small, 53.0 | 53.0 | | sourceSystem | String | The source system from where the PersonName record was brought into Salesforce. | Small, 53.0 | 53.0 | | sourceSystemId | String | The identifier of the person name record in its source system. | Small, 53.0 | 53.0 | | sourceSystem​ModifiedDate | String | The date and time when the person name record was last modified in its source system. | Small, 53.0 | 53.0 | | suffix | String | The suffix attached to the person’s name. | Small, 53.0 | 53.0 | | text | String | The full name of the person. | Small, 53.0 | 53.0 | | use | String | The type of use the name is meant for. For example, temp, official, or alias. | Small, 53.0 | 53.0 | # FHIR Human Name Input The input representation for the name of a person and all its associated metadata. The Human​Name FHIR object maps to the [Human​Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_HumanName.htm "The Human​Name FHIR resource maps to the Person​Name object in Salesforce​.") object in Salesforce​. ## JSON example "humanName": \[ { "use": "Official", "text": "Charles Green", "family": "Green", "given": "Charles", "prefix": "Mr.", "suffix": "Jr.", "periodStart": "1998-05-26T15:40:30.000Z", "periodEnd": "2021-08-09T15:40:30.000Z", "sourceSystem": "http://sfdc.co", "sourceSystemId": "567890", "sourceSystemModified": "2012-07-26T15:40:30.000Z" } \] ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | family | String | The last name of the patient. This field stores a combination of the patient’s middle and last name. | Optional | 53.0 | | given | String | The first name of the patient. | Optional | 53.0 | | periodEnd | String | The date until when the name is active. | Optional | 53.0 | | periodStart | String | The date from when the name is active. | Optional | 53.0 | | prefix | String | The prefix of the name. | Optional | 53.0 | | sourceSystem | String | The source system from where the humanName is brought into Salesforce. | Optional | 53.0 | | sourceSystemId | String | The identifier of the humanName record in its source system. | Optional | 53.0 | | sourceSystem​ModifiedDate | String | The date and time when the humanName record was last modified in its source system. | Optional | 53.0 | | suffix | String | The suffix of the name. | Optional | 53.0 | | text | String | The full name of the person. | Optional | 53.0 | | use | String | The usage type of the name. | Optional | 53.0 | # FHIR Identifier The output representation of the Identified records created to represent an identifier value. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | assigner | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.") | The authorized body that issued the identifier, specified as a reference to an Account record. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | periodEnd | String | The date and time until when the Identifier is active, recorded in DateTime format. | Small, 53.0 | 53.0 | | periodStart | String | The date and time from when the Identifier is active, recorded in DateTime format. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the Identifier record created to store the identifier value. | Small, 53.0 | 53.0 | | sourceSystem | String | The source system from which the identifier record was brought into Salesforce. | Small, 53.0 | 53.0 | | sourceSystemId | String | The identifier of the identifier record in its source system | Small, 53.0 | 53.0 | | sourceSystemModifiedDate | String | The date and time when the identifier record was last modified in its source system. | Small, 53.0 | 53.0 | | type | [FHIR Codeable Concept](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_codeable_concept_output.htm "The output representation of the Code Set Bundle records created to represent a codeableConcept value.") | The system-defined code that represents the type of ID the identifier record is. | Small, 53.0 | 53.0 | | use | String | The usage type of the Identifier. | Small, 53.0 | 53.0 | | value | String | The ID value of the Identifier. | Small, 53.0 | 53.0 | # FHIR Identifier Input The input representation of the Identifier FHIR object. The Identifier FHIR object maps to the [Identifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Identifier.htm "The Identifier FHIR resource maps to the Identifier object in Salesforce.") object in Salesforce. ## Root XML tag ## JSON example { "identifier": \[ { "assigner": { "referenceResource": "Organization", "referenceId": "XYZId" }, "type": { "text": "Passport number", "coding": \[ { "display": "Passport number", "code": "PPN", "isActive": true, "use": "Identifier" } \] }, "value": "ABCD5678", "use": "Official", "periodStart": "1998-05-26T15:40:30.000Z", "periodEnd": "2021-08-09T15:40:30.000Z", "sourceSystem": "http://sfdc.co", "sourceSystemId": "567890", "sourceSystemModified": "2012-07-26T15:40:30.000Z" } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | assigner | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.") | The authorized body that issued the identifier, stored as a reference to the Account object. | Optional | 53.0 | | periodEnd | String | The date and time until when the Identifier is active, recorded in DateTime format. | Optional | 53.0 | | periodStart | String | The date and time from when the Identifier is active, recorded in DateTime format. | Optional | 53.0 | | sourceSystem | String | The source system from which the identifier record was brought into Salesforce. | Optional | 53.0 | | sourceSystemId | String | The identifier of the identifier record in its source system. | Optional | 53.0 | | sourceSystemModifiedDate | String | The date and time when the identifier record was last modified in its source system. | Optional | 53.0 | | type | [FHIR Codeable Concept Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept.htm "Input representation for the Codeable​Concept FHIR object.") | The system-defined code that represents the type of ID the identifier record is. | Optional | 53.0 | | use | String | The usage type of the Identifier record. | Optional | 53.0 | | value | String | The value associated with an Identifier record. | Optional | 53.0 | # FHIR Medication Resource Input The input representation of FHIR Medication. The medication FHIR resource maps to the [Medication](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_Medication.htm "Represents detailed information about different medications. This object is available in API version 51.0 and later.")​ object in Salesforce​. ## Root XML tag ## JSON example { "medicationReference":{ "referenceResource":"Medication", "referenceId":"", "salesforceId":"0itRM0000004CUkYAM", "relationship":"" } ## Properties
Name Type Description Required or Optional Available Version
medicationCodeableConcept FHIR Codeable Concept Or ID Input The codeable concept value of the medication. Optional

Note: This field must be specified if medicationReference is not specified.

 54.0
medicationReference FHIR Reference Input The reference of the medication request. Optional

Note: This field must be specified if medicationCodeableConcept is not specified.

 54.0
# FHIR Medication Statement Input representation for the Medication Statement FHIR object. This is a record of medication that the patient is currently taking or has taken in the past. The Medication Statement FHIR resource maps to the [MedicationStatement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_MedicationStatement.htm "Represents a record of medication that the patient is currently taking or has taken in the past. This object is available in API version 51.0 and later.") object in Salesforce. ## Root XML tag ## Properties
Name Type Description Required or Optional Available Version
additionalInformation Custom Field Value Input[] Additional information associated with the medication statement. Optional 54.0
basedOn FHIR Reference Input[] Additional information based on which the medication statement is prepared. Optional 54.0
category String The category of the medication statement. Optional 54.0
context FHIR Reference Input The specific context associated with the medication. Optional 54.0
dateAsserted String The date and time the medication statement is made. Optional 54.0
derivedFrom FHIR Reference Input[] Additional information about where the medication statement is derived. Optional 54.0
dosage FHIR Dosage Input[] Represents the dosage information set for medication. Optional 54.0
effectiveEndDateTime String The stated end date and time for the medication. Optional 54.0
effectiveStartDateTime String The stated start date and time for the medication. Optional 54.0
identifier FHIR Identifier Input[] Set an identifier value to the medication statement. Optional 54.0
informationSource FHIR Reference Input Set who or where the information in the medication statement came from. Optional 54.0
medication FHIR Medication Resource Input Represents detailed information about different medications. Required 54.0
partOf FHIR Reference Input[] Validates only references of medication dispense, medication statement, procedure, observation are passed. Optional 54.0
reasonCode FHIR Codeable Concept Or ID Input[] The system-defined code that specifies the reason for the medication. Optional 54.0
reasonReference FHIR Reference Input[] The observation, condition, or diagnostic report that warranted the medication. Optional 54.0
sourceSystem String The name of the system this record came from. Optional 54.0
sourceSystemId String The ID of this record in its source system. Optional 54.0
sourceSystemModified String The date on which this item was last changed in the source system. Optional 54.0
status String The status of the medication in this statement.
Possible values are:
  • Active
  • Completed
  • Entered-in-Error
  • Intended
  • Not-Taken
  • On-Hold
  • Stopped
  • Unknown
 Required 54.0
statusReason FHIR Codeable Concept Or ID Input[] The reason for the medication status. Optional 54.0
# FHIR Patient The output representation of the patient stored in Salesforce, as specified in the input request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | active | Boolean | Indicates whether the patient is active or not. | Small,53.0 | 53.0 | | additional​Information | [Custom Field Value Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | address | [FHIR AddresOutput](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_address_output.htm "The output representation of the FHIR address values.")\[\] | The addresses of the patient, stored as contact point address records. | Small, 53.0 | 53.0 | | birthDate | String | The date of birth of the patient, recorded in Date format. | Small, 53.0 | 53.0 | | communication | [Patient Communication Language](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_communication_language_output.htm "The output representation of the PersonLanguage records that represent the communication preferences of a person.")\[\] | The languages of communication associated with the patient, recorded in the PersonLanguage object. | Small, 53.0 | 53.0 | | contact | [Patient Contact Party](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_contact_party_output.htm "The output representation of contact parties associated with a patient.")\[\] | The contact party associated with the patient record. Contacts are connected to patients using a Contact​Contact​Relation\_\_c junction record. | Small, 53.0 | 53.0 | | deceasedDateTime | String | The date and time of the patient’s death. | Small, 53.0 | 53.0 | | gender | String | The gender of the patient. | Small, 53.0 | 53.0 | | general​Practitioner | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.")\[\] | The practitioner associated with the patient. Practitioners are connected to patients using a Contact​Contact​Relation\_\_c junction record​. | Small, 53.0 | 53.0 | | identifier | [FHIR Identifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_identifier_output.htm "The output representation of the Identified records created to represent an identifier value.")\[\] | The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field. | Small, 53.0 | 53.0 | | managing​Organisation | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.") | The organization that manages the patient recorded. Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​. | Small, 53.0 | 53.0 | | maritalStatus | String | The current marital status of the patient. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | multipleBirthInteger | Integer | The birth order of the patient in a multiple-birth event. | Small, 53.0 | 53.0 | | name | [FHIR Human Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_human_name_output.htm "The output representation of a PersonName record created to represent a humanName value.")\[\] | The person name of the patient. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the Person Account record that represents the patient. | Small, 53.0 | 53.0 | | sourceSystemId | String | The record identifier of the patient’s record in its source system. | Small, 53.0 | 53.0 | | telecom | [FHIR Contact Point](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_contact_point_output.htm "The output representation of contact details stored as a ContactPointPhone record.")\[\] | The contact details of the patient. For example, phone numbers and email addresses. | Small, 53.0 | 53.0 | # FHIR Patient Input Input representation for the FHIR patient resource. The Patient FHIR resource maps to the [Patient](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Patient.htm "The Patient FHIR resource maps to the Account and Contact objects in Salesforce​. Patients are modeled using Person Accounts.") objects in Salesforce​. Patients are modeled using Person Accounts. ## JSON example { "active": true, "identifier": \[ { "assigner": { "referenceResource": "Organization", "referenceId": "Org12345XYZ" }, "type": { "text": "Passport Number", "coding": \[ { "display": "Passport number", "code": "PPN", "isActive": true, "use": "Identifier" } \] }, "value": "ABCD5678XYZ" } \], "name": \[ { "use": "alias", "text": "Charles Green", "family": "Green", "given": "Charles", "prefix": "Mr.", "suffix": "Sr." } \], "communication": \[ { "language": "English", "preferenceRank": 1 } \], "address": \[ { "use": "temp", "type": "postal", "line": "Green Household" } \], "telecom": \[ { "system": "email", "value": "a@bc.com" } \], "gender": "male", "birthDate": "2000-09-12T18:13:41Z", "maritalStatus": "married", "contact": \[ { "relationship": { "coding": \[ { "display": "Partner" } \] }, "name": { "use": "Temp", "text": "Shawna Green", "family": "Green", "given": "Shawna", "prefix": "Mrs.", "suffix": "Jr." }, "telecom": \[ { "system": "email", "value": "c@de.com" }, { "system": "phone", "value": "12345678", "use": "temp", "rank": 1 } \], "address": { "use": "temp", "type": "postal", "line": "Green Household" } } \], "generalPractitioner": \[ { "referenceResource": "Practitioner", "referenceId": "PRAC789XYZ", "relationship": "Plastic Surgeon" } \], "managingOrganisation": { "referenceResource": "Organization", "referenceId": "MI9007GBE" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | active | Boolean | Indicates whether the patient record is active or not. | Optional | 53.0 | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | address | [FHIR Address Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_address.htm "Input representation for the Address FHIR object.")\[\] | The address of the patient. | Optional | 53.0 | | birthDate | String | The date of birth of the patient. | Optional | 53.0 | | communication | [Patient Communication Language Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_patient_communication_language.htm "Input representation of the patient communication language.")\[\] | The languages of communication associated with the patient. | Optional | 53.0 | | contact | [Contact Party For Patient Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_patient_contact_party.htm "The input representation of the patient contact party.")\[\] | The contact associated with the patient record, modeled as a person account. Contacts are connected to patients using the Contact​Contact​Relation\_\_c junction object. | Optional | 53.0 | | deceased​​​DateTime | String | The date and time of the patient’s death. | Optional | 53.0 | | gender | String | The gender of the patient. | Optional | 53.0 | | general​Practitioner | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.")\[\] | The practitioners associated with the patient, modeled as either person accounts or Contacts and HealthcareProvider records. Practitioners are connected to patients using the Contact​Contact​Relation\_\_c junction object​. | Optional | 53.0 | | identifier | [FHIR Identifier Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_identifier.htm "The input representation of the Identifier FHIR object.")\[\] | The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field. | Optional | 53.0 | | managing​Organisation | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.") | The organization that manages the patient record, referenced using a lookup to the Account object. Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​. | Optional | 53.0 | | maritalStatus | String | The current marital status of the patient. | Optional | 53.0 | | multiple​BirthInteger | Integer | The birth order of the patient, in the event that the patient was a part of a multiple birth event. | Optional | 53.0 | | name | [FHIR Human Name Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_human_name.htm "The input representation for the name of a person and all its associated metadata.")\[\] | The names of the patient, stored as a PersonName record. | Optional | 53.0 | | sourceSystemId | String | The source system ID associated with a patient record. | Optional | 53.0 | | telecom | [FHIR Contact Point Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_contact_point.htm "Input representation for the ContactPoint FHIR object.")\[\] | Contact details of the patient, such as phone numbers and email addresses. These contact details are stored as Contact​Point​Phone records that reference the patient records using their Contact​Point​Phone​.ParentId field. | Optional | 53.0 | # FHIR Rate Input representation for dosage rate. ## Root XML tag ## JSON example { "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } } } ## Properties
Name Type Description Required or Optional Available Version
dosageRateDenominator Double The denominator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range Optional 54.0
dosageRateNumerator Double The numerator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range. Optional 54.0
dosageRateType String The type of dosage rate recorded in DosageRateNumerator and DosageRateDenominator.
Possibale values are:
  • Frequency
  • Frequency Range
  • Frequency Ratio
 Optional 54.0
dosageRateUnit FHIR Unit Of Measure Or ID The unit of dosage rate. Optional 54.0
# FHIR Reference The output representation of the FHIR reference values. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | accountContact​RelationId | String | The Salesforce ID of junction record. This record is created to connect a person’s person account record with the person account record of an associated person, such as a contact party or practitioner. | Small, 53.0 | 53.0 | | contactContact​RelationId | String | The Salesforce ID of junction record. This record is created to connect a person’s person account record with the business account record of an associated organization, such as an issuer or a managing organization. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | referenceId | String | The source system ID of the person or organization referenced. | Small, 53.0 | 53.0 | | referenceResource | String | The FHIR resource type of the referenced entity, for instance practitioner or organization. | Small, 53.0 | 53.0 | | relationship | String | The relationship between the patient and the healthcare provider or the managing organization, stored using Reciprocal Roles records. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the record that represents the referenced person or organization. | Small, 53.0 | 53.0 | # FHIR Reference Input The input representation for the Reference FHIR object. ## Root XML tag ## JSON example { "reference": { "referenceResource": "practitioner", "referenceId": "ABCId", "relationship": "Oncologist" } } ## Properties
Name Type Description Required or Optional Available Version
referenceId String The ID of the medication or practitioner (healthcare provider) record or the managing organization (account) record in the source system. Required

Note: Optional if salesforceId is specified.

 53.0
referenceResource String The FHIR resource referred to. For example, organization or practitioner. Required 53.0
relationship String The relationship between the patient and the healthcare provider or the managing organization, stored using the Reciprocal Roles records. Optional 53.0
salesforceId String The Salesforce ID of the record that’s created in Salesforce. Required

Note: Optional if referenceId is specified.

 54.0
# FHIR Request Input representation for the supply of medication, along with information about how it should be administered. ​The ​Medication​​Request FH​I​R resource maps to the [MedicationRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_MedicationRequest.htm "Represents a request or order for the supply of medication, along with information about how it should be administered. This object is available in API version 51.0 and later.") object in​Salesforce​. ## Root XML tag ## Properties
Name Type Description Required or Optional Available Version
medicationReference String The reference of the medication request. Optional 54.0
status String The status of the medication request.
Possible values are:
  • Active
  • Cancelled
  • Completed
  • Draft
  • Entered-in-Error
  • On-Hold
  • Stopped
  • Unknown
 Optional 54.0
type String The type of the medication request.
Possible values are:
  • Filler Order
  • Instance Order
  • Option
  • Original Order
  • Plan
  • Proposal
  • Reflex Order
 Optional 54.0
# FHIR Unit Of Measure Input representation for Unit of Measure. ## Root XML tag ## JSON example { "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | description | String | The description of this unit of measure. | Optional | 54.0 | | type | String | The type of the unit of measure. For example, weight, distance, and period. | Required | 54.0 | | unitCode | String | The code for this unit of measure. For example, mm\[Hg\], mcg/mL., kgs, and lbs. | Required | 54.0 | # FHIR Unit Of Measure Or ID Input representation for Unit of Measure Or Id. ## Root XML tag ## JSON example { "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } ## Properties
Name Type Description Required or Optional Available Version
salesforceId String The Salesforce ID of the unit of measure record. Required

Note: Optional if unitOfMeasure is specified.

 54.0
unitOfMeasure FHIR Unit Of Measure Represents the unit of measures for care metrics and care observations. Optional

Note: Optional if salesforceId is specified.

 54.0
# Field Email Field Email streamlines the email creation process, enhances efficiency, and ensures professional and compliant communication that aligns with brand guidelines. Predefined email templates ensure compliance with regulations like GDPR and CAN-SPAM while maintaining brand consistency. Customization options such as dynamic variables and content fragments, allow for personalized messages that resonate with recipients. Tracking key performance metrics like opens and clicks enables users to optimize their email campaigns effectively. ![Field Email entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_field_email.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/field-email.html "HTML (New Window)"). ## Field Email Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Communication Subscription](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscription.htm) - [Communication Subscription Consent](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_commsubscriptionconsent.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Document Link](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemail.htm) - [Life Science Email Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemailfragment.htm) - [Life Science Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtemplate.htm) - [Life Science Email Template Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplfragment.htm) - [Life Science Email Template Related Fragment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplrelafrgmt.htm) - [Life Science Email Template Snapshot](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtmplsnapshot.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Party Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpartyaccess.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Survey](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_survey.htm) - [Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_task.htm) - [Territory Content Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territorycontenttmplasgnt.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Field Insights Field Insights data model helps you to automate the synthesis of complex provider information into clear, actionable presentations, ensuring users are informed before each visit. Users can listen to these audio briefings on the go as podcasts in the Life Sciences Cloud Mobile app's built-in audio player. With Field Inisghts, audio briefings are generated daily, users get insights customized to their role with on-the-go access. Field Insights also supports offline playback, playback continuity, and background playback to support # Field Value Output Represents the value of a field. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | developerName | String | The developer name of a field. | Small, 54.0 | 54.0 | | value | String | The value of a field. | Small, 54.0 | 54.0 | # Fields on Account Life Sciences Cloud fields extend the standard Account object to represent information about patients and providers. ## Fields ### Effective Date - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the person account is active. ### End Date - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the person account is no longer active. ### Source System ID - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. This field can’t be encrypted. # Fields on ActionPlanTemplate Life Sciences Cloud fields extend the standard ActionPlanTemplate object for integration with external systems. ## Fields ### ParentTemplateId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the parent template associated with the action plan template. This field is a relationship field. - **Relationship Name**: ParentTemplate - **Refers To**: ActionPlanTemplate ### SourceSystemIdentifier - **Type**: String - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: String - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. # Fields on ActionPlanTemplateItem Life Sciences Cloud fields extend the standard ActionPlanTemplateItem object to support integration with external systems, commonly used for Key Account Management. ## Fields ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. # Fields on AssessmentIndicatorDefinition Life Sciences Cloud fields extend the AssessmentIndicatorDefinition object to represent the default comparison rule for store checks. ## Fields ### DefaultComparisonRule - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The default rule for comparing the actual and target values on RetailVisitKpi. - **Possible values**: - No Comparison Applied - Actual Value Equals Target Value - Actual Value Does Not Match Target Value - Actual Value Is Greater than Target Value - Actual Value Is Greater than or Equal to Target Value - Actual Value Is Less than Target Value - Actual Value Is Less than or Equal to Target Value - Actual Value Is After Target Value - Actual Value Is On or After Target Value - Actual Value Is Before Target Value - Actual Value Is On or Before Target Value - Actual Value Contains Target Value - Actual Value Does Not Contain Target Value - Actual Value Contains All Elements of Target Value - Actual Value Contains at Least One Element of Target Value - Actual Value Contains None of the Target Value Elements For more information on the AssessmentIndicatorDefinition object, see [AssessmentIndicatorDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_assessmentindicatordefinition.htm). # Fields on Assortment Life Sciences Cloud fields extend the Assortment object to represent the usage type for store checks. ## Fields ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The purpose or process for which this assortment record is used. - **Possible values**: - None - Store Check For more information on the Assortment object, see [Assortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_assortment.htm). # Fields on AssortmentProduct Life Sciences Cloud fields extend the AssortmentProduct object to represent whether a product is required in an assortment. ## Fields ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is required in the assortment. For more information on the AssortmentProduct object, see [AssortmentProduct](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_assortment_product.htm). # Fields on Contact Life Sciences Cloud fields extend the standard Contact object to represent information about an individual. ## Fields ### MaritalStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual’s marital status. - **Possible values**: - Divorced - Married - Separated - Single - Widowed # Fields on ContactPointAddress Life Sciences Cloud fields extend the standard Contact Point Address object to represent a contact’s billing or shipping address associated with an individual or account. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ContactPointAddress](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointaddress.htm) ## Fields ### BrickName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the geography brick associated with the contact point address record. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the contact point address record. ### FullAddress - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The concatenated address of the contact point address. This field is a calculated field. ### GeoGroup1Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The first geography group code associated with the contact point address. ### GeoGroup2Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The second geography group code associated with the contact point address. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a contact’s address is active for the account (true) or not (false). - **Default value**: false ### IsStateDstrLicenseExempt - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the contact point address is exempt from the requirement for a State Distributor License (SDL). - **Default value**: false ### IsTerrAssignmentExcluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a contact’s address is excluded from territory alignment (true) or not (false). - **Default value**: false ### IsValidated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a contact’s address is validated (true) or not (false). - **Default value**: false ### RelatedContactPointAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The source of this contact point address record. This field is a relationship field. - **Relationship Name**: RelatedContactPointAddress - **Refers To**: ContactPointAddress ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### WebSiteUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of the website associated with the contact. ## 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. [ContactPointAddressChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ContactPointAddressHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ContactPointAddressShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Fields on Event Life Sciences Cloud fields extend the standard Event object to represent an event in the calendar. In the user interface, event and task records are collectively referred to as activities. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_event.htm) ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains a text description of the event. Limit: 32,000 characters. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Available in API versions 13.0 and later. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. This field is optional, depending on the following: - If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. If both fields are null, the duration defaults to one day. - If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if the values add up to the same amount of time. Depending on your API version, errors with the DurationInMinutes and EndDateTime fields may appear in different places. - Versions 38.0 and before—Errors always appear in the DurationInMinutes field. - Versions 39.0 and later—If there’s no value for the DurationInMinutes field, errors appear in the EndDateTime field. Otherwise, they appear in the DurationInMinutes field. ### IsAllDayEvent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the ActivityDate field (true) or the ActivityDateTime field (false) is used to define the date or time of the event. Label is **All-Day Event**. For more details, see the DurationInMinutes and EndDateTime fields on the [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_event.htm) object. - **Default value**: false ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Contains the ID of the user or public calendar who owns the event. Label is **Assigned to ID**. This is a polymorphic relationship field. By default, the event is assigned to the user who created it. If the event is created by the Automated Process user, add a different value for OwnerId. The Automated Process user isn’t a valid value for the OwnerId field. - **Relationship Name**: Owner - **Refers To**: Calendar, User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Indicates the start date and time of the event. Available in versions 13.0 and later. If the Event IsAllDayEvent flag is set to true (indicating that it’s an all-day Event), then the event start date information is contained in the StartDateTime field. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate. If the Event IsAllDayEvent flag is set to false (indicating that it isn’t an all-day event), then the event start date information is contained in the StartDateTime field. The time portion is always transferred in the Coordinated Universal Time (UTC) time zone. You need to translate the time portion to or from a local time zone for the user or the application, as appropriate. If this field has a value, then ActivityDate and ActivityDateTime must either be null or match the value of this field. ### Subject - **Type**: combobox - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The subject line of the event, such as Call, Email, or Meeting. Limit: 255 characters. # Fields on Event Relation Life Sciences Cloud fields extend the standard Event Relation object to represent a person (a user, lead, or contact) or a resource (such as a conference room) invited to an event. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: EventRelation](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_eventattendee.htm) ## Fields ### EventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Contains the ID of the event. This value can’t be changed after it’s been specified. This is a relationship field. - **Relationship Name**: Event - **Relationship Type**: Lookup - **Refers To**: Event ### RelationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Contains the ID of the person (User, Contact, or Lead) or the resource invited to an event. When Shared Activities is enabled, RelationId can also contain the ID of an account, opportunity, or other object related to an event. This value can’t be changed after it’s been specified. This is a polymorphic relationship field. - **Relationship Name**: Relation - **Relationship Type**: Lookup - **Refers To**: Calendar, Contact, Lead, User # Fields on ProductRequest Life Sciences Cloud fields extend the standard ProductRequest object for sample order information, including destination user and urgency level. ## Fields ### DestinationLocationUserId - **Type**: Reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary user of the destination location associated with the product request. This field is a relationship field. - **Relationship Name**: DestinationLocationUser - **Refers To**: User ### UrgencyLevel - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the level of urgency associated with the product request. # Fields on ProductRequestLineItem Life Sciences Cloud fields extend the Product Request Line Item object to represent information about sample order details. ## Fields ### ExceptionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of exception while placing a product request. # Fields on ProductTransfer Life Sciences Cloud fields extend the standard ProductTransfer object to capture specific inventory and batch information. ## Fields ### InventoryCountReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count record where the product transfer is recorded. This field is a relationship field. - **Relationship Name**: InventoryCountReference - **Refers To**: InventoryCntProdtBatchItem ### InventoryOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory operation associated with the product transfer. This field is a relationship field. - **Relationship Name**: InventoryOperation - **Refers To**: InventoryOperation ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production batch associated with the transferred products. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### ReceivedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the transferred product is received at the destination location. ### TransferCause - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the cause of the product transfer. ### WarningMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The warning message displayed to the end user during product transfer. # Fields on Quote Life Sciences Cloud fields extend the Quote object to represent visit, delivery, payment, and pricing information for quoted orders. ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information that isn't captured in other fields on the quote. ### AggregationStrategy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The aggregation strategy used for cumulative pricing. ### BillingContactPointAddress - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The corporate or store billing address. This address is a contact point address on the account. This field is a relationship field. - **Relationship Name**: BillingContactPointAddress - **Refers To**: ContactPointAddress ### CaptureDate - **Type**: date - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the quoted order is created. ### DistributionChannel - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The distribution channel associated with the quote. This field is a relationship field. - **Relationship Name**: DistributionChannel - **Refers To**: DistributionChannel ### PaymentTerm - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The intended payment term for this quote. This field is a relationship field. - **Relationship Name**: PaymentTerm - **Refers To**: PaymentTerm ### RequestedFirstDeliveryDate - **Type**: date - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The earliest delivery date the customer requested for products in the quote. ### ShippingContactPointAddress - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The warehouse or store location where products are shipped. This address is a contact point address on the account. This field is a relationship field. - **Relationship Name**: ShippingContactPointAddress - **Refers To**: ContactPointAddress ### TotalFreeItemQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total number of free goods in the quote. ### TotalQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total quantity of items in the quote. ### Visit - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit during which a quoted order is created. - **Relationship Name**: Visit - **Refers To**: Visit For more information on the Quote object, see [Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_quote.htm). # Fields on QuoteLineItem Life Sciences Cloud fields extend the QuoteLineItem object to represent free goods and total quantity on a quoted order line. ## Fields ### AdditionalFreeItemQty - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of free items that are manually added to the quote line item. ### TotalQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total quantity on the line item, including the manually added free goods. For more information on the QuoteLineItem object, see [QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_quotelineitem.htm). # Fields on RetailStoreKpi Life Sciences Cloud fields extend the standard RetailStoreKpi object to represent the target price for a store KPI. ## Fields ### TargetPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The target price or the target currency value for the measuring parameter. For more information on the RetailStoreKpi object, see [RetailStoreKpi](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_retailstorekpi.htm). # Fields on RetailVisitKpi Life Sciences Cloud fields extend the standard RetailVisitKpi object to represent actual and target prices captured during a store visit. ## Fields ### ActualPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual price of the product captured during a visit. ### TargetPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The target price of the product. For more information on the RetailVisitKpi object, see [RetailVisitKpi](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_retailvisitkpi.htm). # Fields on StoreAssortment Life Sciences Cloud fields extend the standard StoreAssortment object to represent the store check type for an assortment associated with a store. ## Fields ### StoreCheckType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of check that is performed on the assortment in the store. For more information on the StoreAssortment object, see [StoreAssortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_store_assortment.htm). # Financial Assistance Program The financial assistance program data model helps life sciences organizations implement several financial assistance programs for eligible patients to receive assistance with their out of pocket medical expenses.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Life Sciences or Health Cloud
The financial assistance program objects are available to users with Health Cloud Starter (for Life Sciences Cloud) or Health Cloud Foundation (for Health Cloud) and the Manage Financial Assistance Program permission set. The objects are available in API version 61.0 and later. ![Financial Assistance Program relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_financial_assistance_program_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/financial-assistance-for-patient-services-program.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # First Reviewer The name of the person who reviewed the request first. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | username | String | username | Big, 46.0 | 46.0 | # First Reviewer Input The name of the person who reviewed the request. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | username | String | User name of the first reviewer. | Yes | 46.0 | # ​Flag The ​Flag ​FHI​R resource maps to the Clinical​Alert object in Salesforce​. ## ​FHI​R V4​.0 - Clinical ​Data ​Model ​Mapping Here’s how the fields defined by ​FHI​R for [​Flag](https://www.hl7.org/fhir/flag.html#Flag) map to the fields in Salesforce​. Table 1. ​Flag - Salesforce | ​Flag ​Resource | Salesforce ​Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.​M | The identifier information for a clinical alert is represented as Identifier records that reference the clinical alert record using their Identifier​.​Parent​RecordId field​. | | status | Clinical​Alert​.Status | ​Picklist | 0​.1 | While ​FHI​R defines ​Flag​.status as a code, the Salesforce implementation of Clinical​Alert​.Status is picklist​. | | category | Clinical​Alert​.Categories | ​Multi-Select ​Picklist | 0​.​M | While ​FHI​R defines ​Flag​.category as a code set bundle, the Salesforce implementation of Clinical​Alert​.Categories is a multi-select picklist​. | | code | Clinical​Alert​.CodeId | Lookup: CodeSet​Bundle | 1​.1 | While ​FHI​R defines ​Flag​.code as a code set bundle only, the Salesforce implementation flattens it into Clinical​Alert​.Code and Clinical​Alert​.Code​Description​. The latter is meant to display non-coded information to users as required​. | | code | Clinical​Alert​.Code​Description | String | 0​.1 | While ​FHI​R defines ​Flag​.code as a code set bundle only, the Salesforce implementation flattens it into Clinical​Alert​.Code and Clinical​Alert​.Code​Description​. The latter is meant to display non-coded information to users as required​. | | subject | Clinical​Alert​.Subject | ​Polymorphic Lookup: Location, ​Account Healthcare​Provider, ​Medication, and ​Patient​Medical​Procedure | 1​.1 | The Salesforce implementation of flag​.subject doesn’t support plan definitions​. | | period | Clinical​Alert​.Start​Date | ​Date Time | 0​.1 | In Salesforce’s implementation, ​Flag​.period is split into two fields, Clinical​Alert​.Start​Date and Clinical​Alert​.​End​Date​. | | period | Clinical​Alert​.​End​Date | ​Date Time | 0​.1 | In Salesforce’s implementation, ​Flag​.period is split into two fields, Clinical​Alert​.Start​Date and Clinical​Alert​.​End​Date​. | | encounter | Clinical​Alert​.​Related​EncounterId | Lookup: Clinical​Encounter | 0​.1 | N/​A | | author | Clinical​Alert​.​Raised​ById | ​Polymorphic Lookup: Healthcare​Provider, Care​Registered​Device, and Healthcare​Practitioner​Facility | 0​.1 | The Salesforce implementation of flag​.author doesn’t support patients, and organizations​. | #### See Also - [ClinicalAlert](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalAlert.htm "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.") # Flow for Life Sciences Cloud The Flow for Life Sciences Cloud represents the metadata associated with a flow. Use Flow to create an application that takes users through a series of pages to query and update the records in the database. You can also run logic and provide branching capability based on user input to build dynamic applications. ## FlowActionCall Life Sciences Cloud exposes additional actionType values for the FlowActionCall metadata type. ### actionType - **Field Type**: InvocableActionType (enumeration of type string) - **Description**: Required. The action type. Additional valid values for Life Sciences Cloud are: - assignCndtToResearchStudyGroup—Assign candidates, enrolled in the clinical trials through randomization to research study comparison groups. - cloneActvtyPlanTerritories—Clones Activity Plan records and associates them with specified territories. Available in API version 67.0 and later. - evaluateAccess—Evaluates a specified access check (user permission) against the current security context and returns whether the running user has the requested permission. Available in API version 68.0 and later. - generateResearchStudyBlocks—Generate research study randomization block records to link each block with a specific research study comparison group by using the randomization process. - getContextData—Retrieves the context data that is passed as an input to a prompt template that generates a summary of the data. - getQualifiedProducts—Retrieves the PricebookEntry IDs for products that a user is authorized to use for a given account and territories. When productPurpose isn’t specified, the action defaults to Quote. Allowed purpose values are Quote, Visit, and Order. Available in API version 66.0 and later. - processCriteriaMatchingResp—Parses a GPT-generated JSON response to evaluate each inclusion and exclusion criterion for a given Research Study Candidate, determining whether each criterion is matched or not. This action stores the GPT response in the Care Program Enrollment Evaluation Result entity and computes the number of matched inclusion criteria and exclusion criteria, returning these counts as output. - serializeHierarchicalContextData—Serializes the hierarchical context data from the Apex embeddedai\_\_RecordApexRepresentation records that are passed as input to a prompt template that generates a summary of the data. - setLsQuoteDocumentDefaults—Sets default attributes on document recipients for a specified quote document based on its attached Lightning flexipage layout. Available in API version 68.0 and later. - shareQuoteBasedOnAccount—Synchronizes Quote sharing with Account sharing by querying AccountShare records for the specified Quote account ID and upserting the corresponding QuoteShare records. Available in API version 68.0 and later. # Formulary Represents the details of the formulary covered by the payer's health insurance plan. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The effective end date of the formulary. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The effective start date of the formulary. ### FormularyType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of formulary. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the formulary. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the formulary record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference domain associated with the formulary. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Account ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the formulary. ## 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. [FormularyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [FormularyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [FormularyShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # FormularyItem Represents details of products within the formulary, including the drug tier, coverage, and copay. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CopayAmount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The copayment amount for the product within the formulary. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The additional details of the formulary product record. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The effective end date of the product within the formulary. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The effective start date of the product within the formulary. ### FormularyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the parent formulary record associated with the formulary item. This field is a relationship field. - **Relationship Name**: Formulary - **Relationship Type**: Master-detail - **Refers To**: Formulary (the master object) ### HasQuantityLimit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product within the formulary has a quantity limit (true) or not (false). - **Default value**: false ### ItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the product associated with the formulary. This field is a polymorphic relationship field. - **Relationship Name**: Item - **Refers To**: Product2 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the formulary item. ### PriorAuthorizationRequiredType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of prior authorization required for the product within the formulary. ### QuantityLimitDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The detailed description of quantity limits the formulary imposes on a product. This may include a rolling dispense limit, maximum daily, or therapy days for a time period. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the product within the formulary. ### StepTherapyLimitType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of step therapy required for the product within the formulary. ### TierType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the tier of the product within the formulary. ### TotalCoveredLifeCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of patients covered for a product within the formulary. ### TotalCoveredPharmacyLifeCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of pharmacy lives covered for a product within the formulary. ## 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. [FormularyItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [FormularyItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # General Events General Events enable users to log and manage various non-customer related activities. With the Planner tool, users can easily create, view, and manage General Events in their schedules. Users can also add employees to a General Event for team collaborations. ![General Events entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_general_events_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/general-events.html "HTML (New Window)"). ## General Events Objects in Life Sciences Customer Engagement - [Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_event.htm) - [Event Relation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_eventattendee.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). #### See Also - [_Life Sciences Cloud Fields on Standard Objects_: Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_event.htm) - [_Life Sciences Cloud Fields on Standard Objects_: Event Relation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_eventattendee.htm) # General Practitioner Member's primary or general care practitioner. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | generalPractitionerNpi | String | General Practitioner NPI number. | Big, 46.0 | 46.0 | # General Practitioner Input Member's primary or general care practitioner. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | npi | String | General Practitioner NPI number. | Yes | 46.0 | # Generate Research Study Blocks Action Generate research study randomization block records to link each block with a specific research study comparison group by using the randomization process. The Generate Research Study Blocks action generates blocks during the design time to verify the randomized assignment of groups and to test the required block multipliers. This action is available in API version 61.0 and later. ## Special Access Rules The Generate Research Study Blocks action is available in Enterprise and Unlimited Editions with Life Sciences Cloud and the Participant Enrollment Add-On license. Additionally, the org must be enabled with Research Study Randomization. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/generateResearchStudyBlocks Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
researchStudy​RandomizationId string Required.

ID of the research study randomization record that you want to generate the blocks for.
researchStudy​TargetCandidateCount integer Required.

Number of candidates that you want to generate the blocks for.

## Outputs | Output | Type | Description | | --- | --- | --- | | researchStudy​RandomizationBlockIds | string | List of generated research study randomization block IDs. | ## Example **POST** This sample request is for the Generate Research Study Blocks action. { "inputs": \[ { "researchStudyRandomizationId": "1Rdxx0000004CguCAE", "researchStudyTargetCandidateCount": 10 } \] } This sample response is for the Generate Research Study Blocks action. \[ { "actionName": "generateResearchStudyBlocks", "errors": null, "invocationId": null, "isSuccess": true, "outputValues": { "researchStudyRandomizationBlockIds": \[ "1Mtxx0000004CLw", "1Mtxx0000004CLx", "1Mtxx0000004CLy" \] }, "sortOrder": -1, "version": 1 } \] #### See Also - [_Salesforce Help_: Enable Participant Management](https://help.salesforce.com/s/articleView?id=ind.lsc_admin_enable_participant_management.htm&type=5&language=en_US "Salesforce Help: Enable Participant Management - HTML (New Window)") - [_Salesforce Help_: Enroll Participants Using Block Generation](https://help.salesforce.com/s/articleView?id=ind.lsc_admin_participant_management_create_using_block_generation.htm&type=5&language=en_US "Salesforce Help: Enroll Participants Using Block Generation - HTML (New Window)") # Get Context Data Action Retrieves the context data that is passed as an input to a prompt template that generates a summary of the data. This action is available in API version 62.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getContextData Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: GET **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
contextInputRepresentation List<Apex> Required

A collection of Apex embeddedai__ContextInputRep records that contain details of the hierarchical data of the sObjects to get the context data for.
contextDefinitionName String Required

The name of the context definition to use to get the context data.
## Outputs | Output | Type | Description | | --- | --- | --- | | recordApexRepresentation | List | A collection of Apex embeddedai\_\_RecordApexRepresentationrecords that contain the context data. | ## Example Sample Request { "inputs": \[ { "contextInputRepresentation": \[ { "mappingName": "OutcomeSummaryMapping", "ids": \[ "9OCxx0000004C92GAE" \], "objectName": "Outcome", "nodeName": "SummaryContext" } \], "contextDefinitionName": "CareProgramOutcomeSummary\_\_stdctx" } \] } Sample Response \[ { "recordApexRepresentation": \[ { "relatedRecordData": \[ { "relatedRecordData": \[ { "recordData": \[ { "value": "Percentage", "key": "UnitOfMeasureName" }, { "value": "Symptom Monitoring", "key": "IndicatorDefinitionName" } \], "objectType": "IndicatorAssignment" } \], "recordData": \[ { "value": "Reduced Symptoms", "key": "Name" } \], "objectType": "Outcome" } \], "recordData": \[ { "value": "Drug Use Satisfaction Improvement Program", "key": "Name" } \], "objectType": "CareProgram" } \] } \] # Get Life Sciences Configuration Field Names and Values Gets key-value pairs of field names and their values for Life Sciences configuration records of a given category. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getLifeSciCnfgFieldNmAndVal Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
userId String Required

ID of the user for whom the configuration record is fetched.
categoryName String Required

Name of the category whose configuration record is fetched. The category type is always hierarchy.

fieldNamesList List<String> Optional

The comma-delimited list of field names of the configuration record that’s fetched. If this parameter is empty, the invocable action returns all the fields of the given category of configuration record for the specified user.
## Outputs | Output | Type | Description | | --- | --- | --- | | configurationFieldOutputRepresentations | List | Collection of Apex RestApi.LsConfigFieldOutput records that contain key-value pairs of field names and their values belonging to the active configuration record that was fetched. | ## Example This sample request is for the Get Life Sciences Configuration Field Names and Values action. { "inputs": \[ { "userId" : "005xx00000114xxYAA", "categoryName": "ProviderSummarization", "fieldnamesList" : \["ProviderSummaryConfiguration"\] } \] } This sample input is for calling the Get Life Sciences Configuration Field Names and Values action from the Apex code. Invocable.Action action = Invocable.Action.createStandardAction('getLifeSciCnfgFieldNmAndVal'); action.setInvocationParameter('userId', '005xx00000114xxYAA'); action.setInvocationParameter('categoryName', 'ProviderSummarization'); List results = action.invoke(); System.debug('result = ' + results); This sample response is for the Get Life Sciences Configuration Field Names and Values action. \[ { "actionName": "getLifeSciCnfgFieldNmAndVal", "errors": null, "invocationId": null, "isSuccess": true, "outcome": null, "outputValues": { "configurationFieldOutputRepresentations": \[ { "value": "lsc4ce\_\_providersummary", "name": "ProviderSummaryConfiguration" } \] }, "sortOrder": -1, "version": 1 } \] # Get Qualified Products Action Retrieves the PricebookEntry IDs for products that a user is authorized to use for a given account and territories. When productPurpose isn’t specified, the action defaults to Quote. Allowed purpose values are Quote, Visit, and Order. This action is available in API version 66.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getQualifiedProducts Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs | Input | Type | Description | | --- | --- | --- | | accountId | ID | Required. The ID of the account used to qualify products. | | territoryIds | ID | Required. The IDs of the territories used to qualify products. Accepts up to 200 IDs. | | pricebookId | ID | Required. The ID of the price book used to retrieve qualified price book entries. Invocable REST keys are case-sensitive; use pricebookId (lowercase b). | | catalogId | ID | Optional. The ID of the product catalog (prefix 0ZS). Required when categoryId is specified. | | categoryId | ID | Optional. The ID of the product category (prefix 0ZG). Requires catalogId. | | searchTerm | String | Optional. A search string used to filter products by name. | | productPurpose | String | Optional. The product territory availability purpose picklist API value. Allowed values are Quote, Visit, and Order. Defaults to Quote when omitted. | | usageType | String | Optional. The product territory availability usage type picklist API value. The allowed value is LifeSciences. Defaults to LifeSciences when omitted. | | pageLimit | Integer | Optional. The maximum number of price book entry IDs to return in a single response. Valid range is 1–200. Default value is 200. | | pageOffset | Integer | Optional. The zero-based offset used for pagination. Defaults to 0. | | currencyIsoCode | String | Optional in single-currency orgs. Required in multi-currency orgs; omitting it throws an error. When provided, the value must be a valid 3-letter uppercase ISO currency code, such as USD or EUR. | ## Outputs | Output | Type | Description | | --- | --- | --- | | pricebookEntryIds | ID | A collection of qualified PricebookEntry IDs for the current page. Invocable REST keys are case-sensitive. Use pricebookEntryIds (lowercase b). The number of IDs returned in one response is limited by pageLimit (1–200, default value is 200), not by the invocable collection capacity. | | hasMoreRecords | Boolean | Indicates whether more qualified price book entries are available beyond the current page. | | displayCurrencyIsoCode | String | The ISO currency code used to display the returned price book entries. | ## Example This example retrieves up to 50 qualified price book entry IDs for an account and territory, filtered by catalog, category, search term, purpose, and currency. **Example request** { "inputs" : \[ { "accountId" : "001XX000000AAAA", "territoryIds" : \[ "0MIXX000000TTTT" \], "pricebookId" : "01sXX000000PBBB", "catalogId" : "0ZSXX000000CCCC", "categoryId" : "0ZGXX000000GGGG", "searchTerm" : "Aspirin", "productPurpose" : "Quote", "usageType" : "LifeSciences", "pageLimit" : 50, "pageOffset" : 0, "currencyIsoCode" : "USD" } \] } **Example response** \[ { "actionName" : "getQualifiedProducts", "errors" : null, "invocationId" : null, "isSuccess" : true, "outputValues" : { "pricebookEntryIds" : \[ "01uXX0000004PPP", "01uXX0000005PPP" \], "hasMoreRecords" : false, "displayCurrencyIsoCode" : "USD" }, "version" : 1 } \] # Goal The Goal FHIR resource maps to the Goal​Assignment​ and Goal​AssignmentDetail​ objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Goal](http://hl7.org/fhir/R4/goal.html#resource) map to the fields in Salesforce. Table 1. Goal - Salesforce | Goal Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | Identifier | N/A | N/A | N/A | Not supported | | life​cycle​Status | Goal​Assignment​.Status | Picklist | 0.1 | While FHIR defines this field as a one-to-one code value, the Salesforce implementation is a zero-to-one picklist. | | achievementStatus | Goal​Assignment​.Progression​Status | Picklist | 0.1 | While FHIR defines this value as a codeable concept, the Salesforce implementation is a picklist. | | category | N/A | N/A | N/A | Not supported | | continuous | Goal​Assignment​.IsContinuous​Goal | Boolean | 0.1 | N/A | | priority | Goal​Assignment​.Priority | Picklist | 0.1 | While FHIR defines this field as a codeable concept, the Salesforce implementation is a picklist. | | description | Goal​Assignment​.Description | Text Area | 0.1 | While FHIR defines this field as a one-to-one codeable concept, the salesforce implementation supports both zero-to-one text values and zero-to-one codeable concept and codeset values. | | description | Goal​Assignment​.Description​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | While FHIR defines this field as a one-to-one codeable concept, the salesforce implementation supports both zero-to-one text values and zero-to-one codeable concept and codeset values. | | subject | Goal​Assignment​.Parent​RecordId | Lookup: Account, Care​Plan. Goal​Assignment, CarePlan​Activity | 1.1 | The Salesforce implementation additionally supports goal and carePlan as valid subject values for goal. | | start | Goal​Assignment​.Start​Date | Date | 0.1 | N/A | | start | Goal​Assignment​.Start​Event​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.1 | N/A | | target | N/A | N/A | N/A | Not Supported | | status​Date | Goal​Assignment​.Status​Date | DateTime | 0.1 | The Salesforce Implementation uses the DateTime data type instead of Date. | | status​Reason | Goal​Assignment​.status​Reason | Text | 0.1 | N/A | | expressedBy | Goal​Assignment​.Assigned​ById | Lookup: Account, Contact, Healthcare Provider, Healthcare Practitioner Facility | 0.1 | The Salesforce implementation doesn’t support careTeam values for this field. | | addresses | Goal​Assignment​Detail​.Detail​Type | Picklist | 0.M | Select Addressed Item as the picklist value in detailType and select one of the supported domain sets in detailRecord. | | addresses | Goal​Assignment​Detail​.Detail​RecordId | Lookup: Health​Condition, Care​Observation, Medication​Statement, Medication​Request, Clinical​Service​Request | 0.M | The Salesforce implementation doesn’t support procedure, nutrition​Order, and Risk​Assessment values. | | outcome​Code | Goal​Assignment​Detail​.Detail​Type | Picklist | 0.M | Select Outcome Code as the picklist value in detailType. | | outcome​Code | Goal​Assignment​Detail​.Detail​CodeId | Lookup: CodeSet​Bundle, Code​Set | 0.M | N/A | | outcome​Reference | Goal​Assignment​Detail​.Detail​Type | Picklist | 0.M | Select Outcome Reference as the picklist value in detail​Type. | | outcome​Reference | Goal​Assignment​Detail​.Detail​RecordId | Lookup: Care​Observation | 0.M | Select Care Observation as the domain set in Detail​RecordId. | | note | N/A | N/A | N/A | Not supported | # GoalAssignment Represents the goals that are part of a care plan. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignedById - **Type**: Polymorphic lookup Reference (Key Account Management) - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the person who assigned the goal. This field is a polymorphic relationship field. - **Relationship Name**: AssignedBy - **Relationship Type**: Lookup - **Refers To**: Account, CarePerformer, Contact, HealthcarePractitionerFacility, HealthcareProvider ### CompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the goal is completed. ### CompletionPercentage - **Type**: percent - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Records the progress of the goal with a percentage value. ### CustomGoalName - **Type**: String - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the custom goal. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the goal. ### GoalAssigneeId - **Type**: Polymorphic lookup Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person to whom the goal is assigned. This field is a polymorphic relationship field. - **Relationship Name**: GoalAssignee - **Relationship Type**: Lookup - **Refers To**: Account, Contact ### GoalDefinitionId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the goal definition in the PGI library that defines the details of the goal. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Refers To**: GoalDefinition ### GoalType - **Type**: String - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the type of the goal. ### IsContinuousGoal - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the goal is a continuous goal (true) or not (false). For instance, setting a goal to quit smoking. - **Default value**: false ### LastReferencedDate - **Type**: DateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: DateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: String - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the goal assignment record. ### OwnerId - **Type**: Polymorphic lookup Reference (Key Account Management) - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this goal assignment record. This field is a polymorphic relationship field for Key Account Mangement. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentRecordId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The parent record that the goal is associated with. This field is a polymorphic relationship field. - **Relationship Name**: ParentRecord - **Refers To**: - Account - CarePlanActivity - GoalAssignment - TerritoryBusinsessPlan ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the priority of the goal. - **Possible values**: - High - Low - Medium ### SortOrder - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Determines the spot of the goal in the list of all goals in a care plan. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the goal is intended to start. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the goal. - **Default value**: Not Started - **Possible values**: - Canceled - Completed - In Progress - Not Started ### StatusDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Records the date and time when the current status was set. ### StatusReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the reason for the current status. ### Target - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: The target of the goal assignment. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### TargetCompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the goal is targeted to be completed. ## 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. [GoalAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [GoalAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [GoalAssignmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [GoalAssignmentShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # GoalDefinition Represents a goal or a business objective that’s used as a reference. When instantiated, GoalDefinition records create GoalAssignment records that serve as goals in care plans. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category that the defined goal belongs to. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the defined goal. ### IsCustomGoalNameRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the custom goal name is required. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the goal definition record. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this goal definition record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: - Group - User ### ParentGoalId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the parent record. This field is a relationship field. - **Relationship Name**: ParentGoal - **Relationship Type**: Lookup - **Refers To**: GoalDefinition ### ScopeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of scope of the goal definition. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - Affiliate - Global - Territory ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the goal defintion. - **Default value**: Active - **Possible values**: - Active - Inactive ### Type - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of the defined goal. - **Default value**: Individual - **Possible values**: - Individual—Intermediate Goal - Strategic—Top Goal ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the usage type of the defined goal. ## 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. [GoalDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [GoalDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [GoalDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # GoalDefinitionProduct Represents a junction between a goal definition and a product. Stores information about the goal definition that defines the business objective for a product. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### GoalDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The goal definition that defines the business objective for a product. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Relationship Type**: Master-detail - **Refers To**: GoalDefinition (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the goal definition product record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the goal definition. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ## 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. [GoalDefinitionProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [GoalDefinitionProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [GoalDefinitionProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Health Insurance The health insurance data model provides objects for managing the ways care is paid for. It represents information about participants such as employment, insurance coverage, and dependents. You can manage details of the benefits provided by plans to members and treatment preauthorization requests made by members or providers. The health insurance data model includes standard objects and record types. You need the Health Cloud Starter permission set to create, edit, and delete records in the data model. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). - **[Purchaser Group](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/health_purchaser_group.htm)** A purchaser group is a subset of the purchaser. For example, your company may have individual employee groups in different regions of the country. Each purchaser group can have separate options for insurance plans. - **[Purchaser Group Member Association](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/health_purchaser_group_member_association.htm)** An association that records the members who belong to a purchaser group. This association is represented by records on the AccountContactRelation object. # 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for HealthcareFacility in Other Objects In addition to creating a record using these fields, you can add more details to your HealthcareFacility record by creating records in certain other objects, and referencing your HealthcareFacility record as the parent record. Here’s the list of objects you can associate to HealthcareFacility in this way, the type of information they add, and the field they use to reference HealthcareFacility. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the facility. | ParentRecordId | ## Fields ### AccountId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the business account of the facility. - **Referenced Objects**: - Account ### AreResearchStudiesConducted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether research studies are conducted in the healthcare facility (true) or not (false). This field is available in API version 63.0 when Site Management is enabled. - **Default value**: false ### AvailabilityExceptions - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The times when the facility isn’t available. Only non-standard time-offs are recorded in this field. - **Examples**: Facility time off because of a natural disaster. ### AverageActualPtcpEnrlDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average actual number of days spent enrolling participants at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AverageActlPtcpEnrlRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The average actual participant enrollment rate for all research studies at the site. This field is available in API version 64.0 and later when Site Management is enabled. ### AverageOpdPatientCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average count of the patients that visit the OPD at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgActualPtcpEnrlCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average actual number of participants that are enrolled for the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgClnclTrialAgreeDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average time taken to execute the clinical trial agreement. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgInvtglProductReleaseDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the start of the site activation process to the release of the investigational product at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgProjectedPtcpEnrlCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of participants that are expected to enroll for the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgProjectedPtcpEnrlDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average projected number of days to enroll participants at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgProtocolDeviationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of protocol deviations reported during the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgQualVstToInitVstDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site qualification visit and site initiation visit. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgRegltyDocTrnarndDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average turnaround time for the preparation of the regulatory documents for Institutional Review Board (IRB) or the Ethics Committee (EC) submission. This field is available in API version 62.0 and later when Site Management is enabled. ### AvgRsrchEthicalReviewDrtn - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the average duration required for an approval for the clinical trial at the heathcare facility from the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - 30 - 60 Days - 61 - 90 Days - 91 - 120 Days - Greater than 120 Days - Less than 30 Days ### AvgSiteActvToFstPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site activation and the first participant visit to the site. ### AvgSiteActvToLastPtcpDrtn - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The average number of days between the site activation and the last participant visit to the site. This field is available in API version 62.0 and later when Site Management is enabled. ### Classification - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the classification of the healthcare facility, such as Previous Partner, Key Opinion Leader, and Novice Member. This field is available in API version 63.0 and later when Site Management is enabled. - **Possible values**: - Key Opinion Leader - Novice Member. - Previous Partner ### ClinicalTrialAgreementType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of clinical trial agreement that can be done with the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Tetra-Partite - Tripartite ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider associated with the facility. This field is a relationship field. This field is available in API version 62.0 and later when Site Management is enabled. - **Relationship Name**: HealthcareProvider - **Refers To**: HealthcareProvider ### InvestigationalProductType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of investigational product available at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Biologic - Device - Diagnostic - Drug - Others - Palliative - Vaccine ### InvtglProdtDestructionCpbl - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of Investigational Product disposal capability. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Off-Site - On-Site - Others ### InvtglProdtPreparationCpbl - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the list of handling equipment available at the facility for the investigational product. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Extemporaneous Preparation - Horizontal Laminar Flow Hood - Non-Vented Glove Box - Other - Vented Glove Box - Vertical Laminar Flow Hood ### InvtglProductStorageCpbl - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the features of the investigational product store available at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Access Controlled - Back-Up Power - Minimum and Maximum Temperature Monitoring - Temperature Alarm - Temperature Monitoring - Temperature Monitoring Log Generation ### IsAfflWithSiteMgmtOrg - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare facility is affiliated to the site management organization. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### FacilityTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the facility in terms of that functions performed. - **Referenced Objects**: - CodeSetBundle ### IsAlwaysOpen - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the facility is open during all hours. ### IsDedResearchStudyRoomAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a dedicated room is available at the healthcare facility to conduct the research study. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsDedRsrchStdyMntrRmAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a dedicated room is available at the healthcare facility to monitor the research study. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsGoodClnclPracTrnPrvd - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether good clinical practice training is provided at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsPgxSpcmnCollAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the pharmacogenoic specimen collection is available at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsPkpdSpcmnCollStrgAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether PKPD specimen collection and storage is available at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsRsrchEthicalRvwSbmsSupp - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the facility supports the regulatory document submission to the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsRsrchStudyMtrlStoreAvl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a store is available at the healthcare facility to keep the research study materials, such as laboratory kits. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsSatelliteSite - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare facility is a satellite site of another healthcare facility (true) or not (false). This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### IsTrainingProvided - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a training is provided to the research staff at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date that the record was viewed. ### LicensedBedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of licensed beds the facility has. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the location record representing the facility’s geolocation. - **Referenced Objects**: - Location ### LocationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the facility in terms of its physical structure. - **Possible values**: - Building - Facility - House - ICU Ward ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the healthcare facility record. ### ParentHealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent facility that the facility is a part of. - **Examples**: The hospital that an ER wing is a part of. - **Referenced Objects**: - HealthcareFacility ### PatientAgeRange - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the age range of the patients at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - 18 to 64 - Greater than or Equal to 65 - Less than or Equal to 17 ### RegulatoryViolationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of regulatory violations reported during the research study at the site. This field is available in API version 62.0 and later when Site Management is enabled. ### ResearchStudyMethod - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the method of conducting the study at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Hybrid - Traditional - Virtual ### ResearchStudyPhase - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the phases under which the study is conducted. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Phase 1 - Phase 2 - Phase 3 - Phase 4 ### ResearchStudyStartYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start year of the research study at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. ### ResearchStudyType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of research study conducted at the healthcare facility. This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - Expanded Access - Interventional - Observational ### RsrchEthicalRvwComteType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management is enabled. - **Possible values**: - 30 - 60 Days - 61 - 90 Days - 91 - 120 Days - Greater than 120 Days - Less than 30 Days ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### UnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure that’s used to calculate the duration of a specific activity at the facility. This field is available in API version 62.0 and later when Site Management is enabled. This field is a relationship field. - **Relationship Name**: UnitOfMeasure - **Refers To**: UnitOfMeasure ## 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. [HealthcareFacilityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [HealthcareFacilityFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcareFacilityHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # HealthcareFacilityNetwork Represents a junction object identifying the insurance network that a location or business entity is a part of. Network participation records are also stored in this object. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account associated with this facility network. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the facility network. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this facility network is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this facility network is no longer effective. ### GenderRestriction - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether this facility network only applies to male or female patients or members instead of all patients or members. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the HealthcareFacility record associated with the network. Use this field if the associated provider is a business account. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Healthcare provider associated with this facility network. - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### HighestValidAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the highest age of patient that this facility network is applicable for. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### LowestValidAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the lowest age of patient that this facility network is applicable for. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the facility network record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PanelLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Indicates the maximum number of patients in the practitioner's panel for this payer network and practitioner location. ### PanelStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the practitioner is accepting new patients based on the status of their patient panel. ### PayerNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Payer network associated with this facility network. ### PractitionerFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner facility associated with this facility network. Use this field if the provider associated with the network is an individual practitioner. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual practitioner associated with the facility network. ### ProviderNetworkContractId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Provider network contract associated with this facility network This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: ProviderNetworkContract ### ProviderNetworkTierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Provider network tier associated with this facility network. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: ProviderNetworkTier ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthcareFacilityNetworkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [HealthcareFacilityNetworkFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcareFacilityNetworkHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcareFacilityNetworkOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcareFacilityNetworkShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthcarePayerNetwork Represents an insurance network group. For example, an insurance company’s exclusive provider organization (EPO) plans. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Code - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Code representing the payer network. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the payer network. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this payer network is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this payer network is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LineofBusiness - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the line of business supported by this payer network. - **Possible values**: - Commercial for Groups - Commercial for Individuals - Exchange - Medicaid - Medicare ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the payer network. ### NetworkType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of network, such as HMO, PPO, or EPO. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentPayerNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent healthcare payer network associated with this payer network. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcarePayerNetwork ### PayerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the payer network. This is a relationship field. - **Relationship Name**: Payer - **Relationship Type**: Lookup - **Refers To**: Account ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of an external record on its source system. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthcarePayerNetworkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [HealthcarePayerNetworkFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcarePayerNetworkHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcarePayerNetworkOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcarePayerNetworkShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthcarePractitionerFacility Represents the different locations in which a practitioner provides services. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account associated with this practitioner facility. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this practitioner facility is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this practitioner facility is no longer effective. ### GenderRestriction - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether physician sees patients of a specific gender. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Healthcare facility associated with this healthcare practitioner facility. - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Healthcare provider associated with this healthcare practitioner facility. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### HighestValidAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The highest age of patients that the practitioner sees at this facility ### InitialStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date the practitioner started at this facility. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### IsDirectoryPrint - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this facility is displayed in an online or printed directory. ### IsPrimaryCarePhysician - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the practitioner provides primary care services at this facility. ### IsPrimaryFacility - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the facility is the primary facility for the practitioner. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LowestValidAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The lowest age of patients that the practitioner sees at this facility. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the practitioner facility record. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the operating hours for this practitioner at this facility. This is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the practitioner associated with this facility. This is a relationship field. - **Relationship Name**: Practitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### ServiceTerritoryMember - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory member associated with the record. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of an external record on its source system. ### TerminationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date the practitioner stopped working at this facility. ### TerminationReasonCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason the practitioner facility is no longer current. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthcarePractitionerFacilityFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [HealthcarePractitionerFacilityHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [HealthcarePractitionerFacilityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [HealthcarePractitionerFacilityShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # HealthcareProvider Represents business-level details about the healthcare organization or the practitioner. ## Special Access Rules In Life Sciences Cloud, the HealthCareProvider object and its fields are used by the Account Management and the Segmentation feature areas. This topic lists fields used in both features. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AbbreviatedName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the abbreviated name of the Japanese healthcare organization (HCO) for INS-DOC records. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account that this healthcare provider is associated with. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AssociatedSampleLimit - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The JSON comprising the list of Sample Limits for the HealthcareProvider record. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### CaqhIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: This field is unique within your organization. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### DataChangeComments - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Captures comments explaining the reasons or context for changes made to the data. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### DoesDispenseMedication - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the account dispenses medication. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date from which the provider becomes effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date from which the provider is no longer effective. ### EhrSystem - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Name of the EHR system used at this facility or organization. ### HasCarrierContract - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider’s contract follows a CMS model MA contract amendment, based on Centers for Medicare and Medicaid Services (CMS) guidelines. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### HasSalesDataRestriction - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether access to the sales data about the healthcare provider is restricted. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### InitialStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the facility first became operational or the practitioner first began practicing. ### IsNotSearchable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider is excluded from search results. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### IsPrivacyLawEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the privacy law regulations are enabled. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### IsSpeaker - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider is designated as a speaker for engagement. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the provider. ### OperatingCountryCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the country code of the country to which the account belongs. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - US ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentOrganizationAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the ID of the parent account, used to establish the account hierarchy. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Relationship Name**: ParentOrganizationAccount - **Refers To**: Account ### PhoneticName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Japanese phonetic name, applicable to both HCP and HCO, which is used for sorting and text-based searches. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### PhoneticName2 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Japanese phonetic name, applicable to both HCP and HCO, which is used for sorting and text-based searches. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The practitioner that this healthcare provider record is associated with. This field is a relationship field. - **Relationship Name**: Practitioner - **Refers To**: Contact ### ProfessionalDesignation - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the professional designation of the healthcare professional. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### ProfessionalTitle - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the professional title of the healthcare professional. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### ProviderClass - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The class of facility, such as an IPA, medical group, or solo practitioner. - **Possible values**: - IPA - Medical Group - Solo Practitioner ### ProviderFullName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The healthcare provider’s full name. This name comes from the related Account record. For person accounts, the name combines the firstName and lastName fields. If firstName is empty, only lastName is used. The name excludes MiddleName and Suffix. For other accounts, the Name field is used. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### ProviderPhotoId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Content Document file that is a photo of the Healthcare Provider. This field is a relationship field. - **Relationship Name**: ProviderPhoto - **Relationship Type**: Lookup - **Refers To**: ContentDocument ### ProviderType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of provider or facility. For example, pharmacist or ambulatory care facility. - **Possible values**: - Ambulatory Care - Dentist - Hospital - Laboratory - Medical Doctor - Pharmacist - Pharmacy ### ReferredByContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the provider who originated the referral. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Relationship Name**: ReferredByContact - **Refers To**: Contact ### RelatedHealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the HCP account associated with the INS-DOC. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Relationship Name**: RelatedHealthcareProvider - **Refers To**: HealthcareProvider ### RelatedUserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The User record that relates to the Healthcare Provider record. This field is a relationship field. - **Relationship Name**: RelatedUser - **Relationship Type**: Lookup - **Refers To**: User ### SalesDataRstrcEffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the sales data restriction becomes effective. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the system from which the record was sourced. This field is unique within your organization ### SourceSystemModifiedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the record was last updated in the source system ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the provider. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. - **Possible values**: - Active - Inactive - Pending ### TerminationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for this provider. ### TerminationReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for termination. ### TotalLicensedBeds - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Total number of licensed beds at this facility, if applicable. ### WrittenName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Chines character name of the organization, applicable only to healthcare professionals (HCPs), which is required for INS-DOC records. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later. ## 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. [HealthcareProviderChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 59.0) Change events are available for the object. [HealthcareProviderFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [HealthcareProviderHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [HealthcareProviderOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [HealthcareProviderShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # HealthcareProviderNpi Represents identifiers from the National Provider Identifier that are assigned to every facility and licensed practitioner in the United States. Also includes NPI assigned date, primary mailing address on file, and so on. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the facility that this NPI belongs to. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this NPI is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this NPI is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Practitioner or facility name as listed in the NPI database. ### Npi - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ten-digit identifier for a provider from the National Plan and Provider Enumeration System. ### NpiType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies whether the NPI is for an individual or an organization. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the practitioner that this NPI belongs to. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the record was sourced. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthcareProviderNpiChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [HealthcareProviderNpiFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcareProviderNpiHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcareProviderNpiOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcareProviderNpiShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthcareProviderService Represents a junction object between a HealthcareService and a HealthcareProvider or HealthcareFacility or HealthcarePractitionerFacility. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareServiceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the healthcare service that is offered. This field is a relationship field. - **Relationship Name**: CareService - **Relationship Type**: Lookup - **Refers To**: CareService ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the Healthcare Provider or Healthcare Facility or Healthcare Practitioner Facility began offering this service. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the Healthcare Provider or Healthcare Facility or Healthcare Practitioner Facility stopped offering this service. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this offering is active (true) or not active (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this association between a Healthcare Service and a Healthcare Provider or Healthcare Facility or Healthcare Practitioner Facility. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the Healthcare Provider or Healthcare Facility or Healthcare Practitioner Facility that offers this service. This field is a polymorphic relationship field. - **Relationship Name**: Provider - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, HealthcarePractitionerFacility, HealthcareProvider ## 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. [HealthcareProviderServiceHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcareProviderServiceOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcareProviderServiceShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthcareProviderSpecialty Represents specialties for a practitioner or a service provider organization. A provider can have multiple specialties such as anesthesiology and cardiovascular. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account associated with this specialty. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ActiveResearchStudyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of active research studies being performed by the healthcare provider for the specialty. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. ### CompletedResearchStudyCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of research studies completed by the healthcare provider for the specialty. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this provider specialty is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this provider specialty is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### IsPrimarySpecialty - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the specialty is the provider's primary specialty. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the provider’s specialty. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner associated with the specialty. This is a relationship field. - **Relationship Name**: Practitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### ResearchStudyPhase - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the research study phase that the healthcare provider has experience with. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. - **Possible values**: - Phase 1 - Phase 2 - Phase 3 - Phase 4 ### ResearchStudyType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the research study type that the healthcare provider has experience with. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. - **Possible values**: - Hybrid - Traditional - Virtual ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of an external record on its source system. ### SpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Care specialty record associated with the provider. This is a relationship field. - **Relationship Name**: Specialty - **Relationship Type**: Lookup - **Refers To**: CareSpecialty ### SpecialtyRole - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Role of the specialty for the provider or practitioner. ## 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. [HealthcareProviderSpecialtyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") (API version 59.0) Change events are available for the object. [HealthcareProviderSpecialtyFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [HealthcareProviderSpecialtyHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [HealthcareProviderSpecialtyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [HealthcareProviderSpecialtyShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # HealthcareProviderTaxonomy Represents taxonomy or subspecialty codes for a practitioner or facility. A provider or facility can have multiple taxonomies. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business account associated with the provider taxonomy. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this taxonomy is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this taxonomy is no longer effective. ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider associated with the taxonomy. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. This field is a relationship field. - **Relationship Name**: HealthcareProvider - **Refers To**: HealthcareProvider ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### IsPrimaryTaxonomy - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the taxonomy is the provider's primary taxonomy. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the provider taxonomy. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contact record for the practitioner. This is a relationship field. - **Relationship Name**: Practitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the record was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Record ID in source system of provider directory. ### TaxonomyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Care taxonomy record associated with the provider taxonomy. This is a relationship field. - **Relationship Name**: Taxonomy - **Relationship Type**: Lookup - **Refers To**: CareTaxonomy ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [HealthcareProviderTaxonomyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [HealthcareProviderTaxonomyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcareProviderTaxonomyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcareProviderTaxonomyOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcareProviderTaxonomyShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthcareServiceDetail Represents a junction object between a CareService and a CodeSetBundle. For example, this object links a healthcare service such as physical therapy to a set of related codes. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareServiceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The ID of the healthcare service associated with the code. This field is a relationship field. - **Relationship Name**: CareService - **Relationship Type**: Lookup - **Refers To**: CareService ### DetailCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. The ID of the code associated with the healthcare service. This field is a polymorphic relationship field. - **Relationship Name**: DetailCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### DetailType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of service detail. - **Default value**: Service\_Category - **Possible values**: - Service\_Category - Service\_Type ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of this association between a HealthcareService and a CodeSetBundle. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## 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. [HealthcareServiceDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthcareServiceDetailOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HealthcareServiceDetailShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # HealthCondition Represents a clinical condition, problem, or any clinically relevant occurrence that is a matter of concern. 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() ## Additional Information for HealthCondition in Other Objects In addition to creating a record using these fields, you can add more details to your HealthCondition record by creating records in certain other objects, and referencing your HealthCondition record as the parent record. Here’s the list of objects you can associate to HealthCondition in this way, the type of information they add, and the field they use to reference HealthCondition. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the health condition. | ParentRecordId | ## Fields ### AbatementEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the abatement period. ### AbatementStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the abatement period or the specific date and time when the condition abated. ### AssertionSourceId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person made the assertion about the condition. This may be a physician, a patient, or even the patient’s contact. - **Referenced Objects**: - Account - HealthcareProvider ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the health condition of the disease outbreak. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter that the immunization was a part of. - **Referenced Objects**: - ClinicalEncounter ### ConditionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents the condition. - **Referenced Objects**: - CodeSetBundle ### ConditionStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the condition. - **Possible values**: - Active - Inactive - Recurrence - Relapse - Remission - Resolved ### DiagnosticStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The diagnostic status of the condition. - **Possible values**: - Confirmed - Differential - Entered in error - Provisional - Refuted - Unconfirmed ### ExtlProblemDefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the external problem definition in the source system. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the health condition record. ### OnsetEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the onset period. ### OnsetStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the onset period or the specific date and time when the condition manifested. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the health condition record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient who is afflicted with the condition. - **Referenced Objects**: - Account ### ProblemDefinitionId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the problem definition in the PGI library that was used to instantiate the HealthCondition record in a care plan. This field is available from version 57.0 This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Lookup - **Refers To**: ProblemDefinition ### ProblemDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description for the condition as a problem in a care plan. This field is available from version 57.0 ### ProblemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the condition as a problem in a care plan. This field is available from version 57.0 ### RecordCreationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record of the condition was created. ### RecordCreatorId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who created the record of the condition. - **Referenced Objects**: - Account - HealthcareProvider ### RelatedHealthConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition associated with the primary health condition. This field is a relationship field. - **Relationship Name**: RelatedHealthCondition - **Refers To**: HealthCondition ### RelatedHealthConditionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of health condition based on which the primary and related health conditions are associated. - **Possible values**: - Coinfection ### ReportDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date the health condition was reported. ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the severity of the condition. - **Possible values**: - Mild - Moderate - Severe ### SiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the site of the condition on the patient’s body. - **Referenced Objects**: - CodeSetBundle ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier for the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### StageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the stage of the condition. - **Referenced Objects**: - CodeSetBundle ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contextual type of the condition. - **Possible values**: - Encounter Diagnosis - Problem List Item ### DiagnosticStatusCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category of a patient's diagnosis status. - **Possible values**: - Confirmed - Probable - Suspected - Unknown ## 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. [HealthConditionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [HealthConditionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [HealthConditionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # HealthConditionDetail This child object is used to associate body site and laterality codes to HealthCondition records. This object is available in API version 52.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailCodeId - **Type**: Polymorphic Master-Detail reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a code set or code set bundle that adds information to a HealthCondition record. - **Referenced Objects**: CodeSet, CodeSetBundle ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Speicifies the type of information represented by the detail code that’s accosicated to the HealthCondition record. - **Possible values**: - Body Site - Laterality ### HealthConditionId - **Type**: Master-Detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent HealthCondition record to which the body site and laterality information is being added. - **Referenced Objects**: HealthCondition ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the HealthConditionDetail record. ## Usage - Use the HealthConditionId field to reference the parent HealthCondition record that the additional information is being associated to. - 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 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. [HealthConditionDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthConditionDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HealthConditionDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # HL7 v2.3 Data Types Supported in Salesforce Standard Objects Salesforce Standard objects support the following data types defined in HL7 v2.3. - **[CE - Coded Element](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_CE.htm)** The Coded Element (CE) HL7 segment maps to the CodeSet object in Salesforce. - **[CX - Extended Composite ID With Check Digit](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_CX.htm)** The Extended Composite ID With Check Digit (CX) HL7 segment maps to the Identifier object in Salesforce. - **[XPN - Extended Person Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_XPN.htm)** The Extended Person Name (XPN) HL7 segment maps to the PersonName object in Salesforce. - **[XTN - Extended Telecommunication Number](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_XTN.htm)** The Extended Telecommunication Number (XTN) HL7 segment maps to the ContactPointPhone object in Salesforce. # 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. 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)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm "The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.") - [Patient Visit (PV1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm "The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.") - [Patient Visit - Additional Information (PV2)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm "The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.") - [Observation Segment (OBX)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBX.htm "The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.") - [Patient Allergy Information (AL1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_AL1.htm "The Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce.") - **Order Message (ORM\_O01)** - [Patient Identification (PID)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm "The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.") - [Patient Visit (PV1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm "The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.") - [Patient Visit - Additional Information (PV2)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm "The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.") - [Patient Allergy Information (AL1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_AL1.htm "The Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce.") - [Common Order Segment (ORC)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_ORC.htm "The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce.") - **Unsolicited Transmission of an Observation Message (ORU\_R01)** - [Patient Identification (PID)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm "The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.") - [Patient Visit (PV1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm "The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.") - [Patient Visit - Additional Information (PV2)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm "The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.") - [Common Order Segment (ORC)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_ORC.htm "The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce.") - [Observation Request Segment (OBR)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBR.htm "The Observation Request Segment (OBR) HL7 segment maps primarily to the ClinicalServiceRequest, DiagnosticSummary, and PatientMEdicalProcedure objects in Salesforce.") - [Observation Segment (OBX)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBX.htm "The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.") - **Unsolicited Vaccination Record Update (VXU\_V04)** - [Patient Identification (PID)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm "The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.") - [Patient Visit (PV1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm "The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.") - [Patient Visit - Additional Information (PV2)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm "The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.") - [Common Order Segment (ORC)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_ORC.htm "The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce.") - [Pharmacy Administration Segment (RXA)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXA.htm "The Pharmacy Administration Segment (RXA) HL7 segment maps primarily to the PatientImmunization and Medication objects in Salesforce.") - [Pharmacy Route Segment (RXR)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXR.htm "The Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization and PatientMedicationDosage objects in Salesforce.") - [Observation Segment (OBX)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBX.htm "The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.") - **Pharmacy/Treatment Encoded Order Message (RDE\_O01)** - [Patient Identification (PID)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm "The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce.") - [Patient Visit (PV1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm "The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce.") - [Patient Visit - Additional Information (PV2)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm "The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce.") - [Patient Allergy Information (AL1)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_AL1.htm "The Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce.") - [Common Order Segment (ORC)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_ORC.htm "The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce.") - [Pharmacy Encoded Order Segment (RXE)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXE.htm "The Pharmacy Encoded Order Segment (RXE) HL7 segment maps primarily to the Medication object in Salesforce.") - [Pharmacy Route Segment (RXR)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXR.htm "The Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization and PatientMedicationDosage objects in Salesforce.") - [Pharmacy Component Order Segment (RXC)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXC.htm "The Pharmacy Component Order Segment (RXC) HL7 segment maps to the Medication and MedicationRequestobjects in Salesforce.") - [Observation Segment (OBX)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBX.htm "The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce.") # HL7 v2.3 Segments Supported in Salesforce Standard Objects Salesforce Standard objects support the following segments in HL7 v2.3. - **[AL1 - Patient Allergy Information](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_AL1.htm)** The Patient Allergy Information (AL1) HL7 segment maps to the AllergyIntolerance object in Salesforce. - **[OBR - Observation Request Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBR.htm)** The Observation Request Segment (OBR) HL7 segment maps primarily to the ClinicalServiceRequest, DiagnosticSummary, and PatientMEdicalProcedure objects in Salesforce. - **[OBX - Observation Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_OBX.htm)** The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce. - **[ORC - Common Order Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_ORC.htm)** The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce. - **[PID - Patient Identification](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PID.htm)** The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce. - **[PV1 - Patient Visit](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV1.htm)** The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce. - **[PV2 - Patient Visit - Additional Information](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_PV2.htm)** The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce. - **[RXA - Pharmacy Administration Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXA.htm)** The Pharmacy Administration Segment (RXA) HL7 segment maps primarily to the PatientImmunization and Medication objects in Salesforce. - **[RXC - Pharmacy Component Order Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXC.htm)** The Pharmacy Component Order Segment (RXC) HL7 segment maps to the Medication and MedicationRequestobjects in Salesforce. - **[RXE - Pharmacy Encoded Order Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXE.htm)** The Pharmacy Encoded Order Segment (RXE) HL7 segment maps primarily to the Medication object in Salesforce. - **[RXR - Pharmacy Route Segment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_hl7_RXR.htm)** The Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization and PatientMedicationDosage objects in Salesforce. # HlthCareProvTreatedCondition Represents a junction object between a healthcare provider, facility, or practitioner and a problem definition that's related to a health condition, such as disease or illness. For example, this object links a doctor to the treatment of diabetes, or a facility to the treatment of spinal injuries. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the health condition that's treated by a healthcare provider, facility, or practitioner. This field is a relationship field. - **Relationship Name**: Condition - **Relationship Type**: Lookup - **Refers To**: ProblemDefinition ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the provider began treating the condition. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the provider stopped treating the condition. ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The ID of the HealthcareProvider or HealthcareFacility or PractitionerFacility associated with the record. This represents the Provider that treats the condition. This field is a relationship field. - **Relationship Name**: HealthcareProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider is actively treating the condition (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this association between a healthcare provider, facility, or practitioner, and a problem definition that's related to a health condition. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## 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. [HlthCareProvTreatedConditionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [HlthCareProvTreatedConditionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [HlthCareProvTreatedConditionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Human​Name The Human​Name FHIR resource maps to the Person​Name object in Salesforce​. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [Human​Name](https://www.hl7.org/fhir/datatypes.html#HumanName) map to the fields in Salesforce​. Table 1. Human​Name - Salesforce | Human​Name Resource | Salesforce Field | ​Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | family | Person​Name​.Last​Name | String | 0​.1 | In cases where a person has a middle name, Person​Name​.Last​Name is supposed to store a combination of the middle name and the last name​. | | Given | Person​Name​.First​Name | String | 0​.1 | While the cardinality defined by FHIR for Human​Name​.Given is zero-to-many, the Salesforce implementation in Person​Name​.First​Name is zero-to-one​. | | text | Person​Name​.Full​Name | String | 0​.1 | N/A | | use | Person​Name​.​Name​Usage​Type | ​Dynamic picklist | 0​.1 | While FHIR defines Human​Name​.use as a code, Salesforce implements Person​Name​.​Name​Usage​Type as a dynamic picklist​. | | prefix | Person​Name​.Prefix | String | 0​.1 | While the cardinality defined by FHIR for Human​Name​.prefix is zero-to-many, the Salesforce implementation in Person​Name​.Prefix is zero-to-one​. | | suffix | Person​Name​.Suffix | String | 0​.1 | While the cardinality defined by FHIR for Human​Name​.suffix is zero-to-many, the Salesforce implementation in Person​Name​.Suffix is zero-to-one​. | | period | Person​Name​.Effective​Date | ​Date Time | 0​.1 | In Salesforce’s implementation, Human​Name​.period is split into two fields, Person​Name​.Effective​Date and Person​Name​.End​Date​. | | period | Person​Name​.End​Date | ​Date Time | 0​.1 | In Salesforce’s implementation, Human​Name​.period is split into two fields, Person​Name​.Effective​Date and Person​Name​.End​Date​. | # Identifier Represents identifier information for multiple objects. This object is available in API version 51.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description related to the identifier. ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from when the identifier is valid. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from when the identifier is no longer valid. ### IdTypeId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of ID the identifier is. - **Referenced Objects**: - CodeSet - CodeSetBundle ### IdUsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of use of the ID. - **Possible values**: - Official - Old - Secondary - Temp - Usual ### IdValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value of the identifier. ### IdentifierKey - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: A unique key assigned to the identifier record. This is a calculated field. ### IssuingAuthorityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authorized body that issued the identifier. - **Referenced Objects**: - Account ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name for the identifier record. ### ParentRecordId - **Type**: Polymorphic master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent entity associated with the identifier. - **Referenced Objects**: - Account - BoardCertification - Contact - CareRegisteredDevice - Medication - HealthCondition - AllergyIntolerance - PatientMedicalProcedure - PatientImmunization - MedicationStatement - ClinicalEncounter - HealthcareFacility - HealthcareProvider - ClinicalAlert - MedicationRequest - DiagnosticSummary - HealthcarePractitionerFacility - ClinicalServiceRequest - ClinicalDetectedIssue—This value is available in API version 55.0 and later. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from which the identifier record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the identifier record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the identifier record was last modified in its source system. ## Usage The identifier object is used to assign identifiers to records in various other objects. Here’s a list of the objects whose records you can add identifiers to: - Account - Contact - Board Certification - Medication - HealthCondition - AllergyIntolerance - PatientMedicalProcedure - PatientImmunization - MedicationStatement - ClinicalEncounter - HealthcareFacility - ClinicalAlert - MedicationRequest - DiagnosticSummary - HealthcarePractitionerFacility - ClinicalServiceRequest - ClinicalDetectedIssue You connect the identifier record to its related record in any of the listed objects by referencing that record using the ParentRecordId field. ## 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. [IdentifierChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # Identifier The Identifier FHIR resource maps to the Identifier object in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Identifier](https://www.hl7.org/fhir/datatypes.html#Identifier) map to the fields in Salesforce. Table 1. Identifier - Salesforce | Identifier Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | use | Identifier​.IdUsage​Type | Picklist | 0.1 | FHIR defines identifier​.use as a code set. However, the Salesforce implementation of Identifier​.IdUsage​Type is a dynamic picklist because of the limited list of possible values. | | type | Identifier​.IdTypeId | Polymorphic Lookup: CodeSet, CodeSet​Bundle | 0.1 | N/A | | system | Identifier​.Source​System | String | 0.1 | FHIR defines identifier​.system as a URI. However, the Salesforce implementation of Identifier​.Source​System is a string because Salesforce doesn’t support the URI data type. | | value | Identifier​.IdValue | String | 0.1 | N/A | | period | Identifier​.Effective​Date | DateTime | 0.1 | In Salesforce’s implementation, identifier​.period is split into two fields, Identifier​.Effective​Date and Identifier​.End​Date. | | period | Identifier​.End​Date | DateTime | 0.1 | In Salesforce’s implementation, identifier​.period is split into two fields, Identifier​.Effective​Date and Identifier​.End​Date. | | assigner | Identifier​.Issuing​Authority​Id | Lookup: Account | 0.1 | N/A | #### See Also - [Identifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_Identifier.htm "Represents identifier information for multiple objects. This object is available in API version 51.0 and later.") # ​Immunization The ​Immunization FHIR resource maps to the Patient​Immunization and PatientHealthReaction objects in Salesforce​. ## FHIR V4​.0 - ​Clinical Data Model Mapping Here’s how the fields defined by FHIR for [​Immunization](https://www.hl7.org/fhir/immunization.html) map to the fields in Salesforce​. Table 1. ​Immunization - Salesforce | ​Immunization Resource | Salesforce Field | Type | Salesforce ​Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.M | The identifier information for an immunization is represented as Identifier records that reference the Patient​Immunization record using their Identifier​.Parent​RecordId field​. | | status | Patient​Immunization​.Status | Picklist | 0​.1 | While FHIR defines immunization​.status as a code set bundle, the Salesforce implementation of Patient​Immunization​.Status is picklist​. | | status​Reason | Patient​Immunization​.Status​Reason​​CodeId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | vaccine​Code | Patient​Immunization​.Vaccine​CodeId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | patient | Patient​Immunization​.PatientId | Master-Detail Reference: Account | 1​.1 | N/A | | encounter | Patient​Immunization​.​Clinical​Encounter​Id | Lookup: ​Clinical​Encounter | 0​.1 | N/A | | occurrence​.occurrence​Date​Time | Patient​Immunization​.Vaccination​Date | Date​Time | 0​.1 | N/A | | occurrence​.occurrence​String | Patient​Immunization​.Vaccination​Period | String | 0​.1 | N/A | | recorded | Patient​Immunization​.Record​Creation​Date​Time | Date​Time | 0​.1 | N/A | | primary​Source | Patient​Immunization​.Is​Recorded​By​Vaccinator | Boolean | 0​.1 | N/A | | report​Origin | Patient​Immunization​.Information​SourceId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | location | Patient​Immunization​.FacilityId | Lookup: Healthcare​.Facility | 0​.1 | N/A | | manufacturer | Patient​Immunization​.Manufacturer | String | 0​.1 | Use this field if only the name of the organization is required. | | manufacturer | Patient​Immunization​.Manufacturer​AccountId | Lookup: Account | | N/A | | lot​Number | Patient​Immunization​.Lot​Number | String | 0​.1 | N/A | | expiration​Date | Patient​Immunization​.Expiration​Date | Date​Time | 0​.1 | N/A | | site | Patient​Immunization​.SiteId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | route | Patient​Immunization​.RouteId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | dose | Patient​Immunization​.​Dose | Double | 0​.1 | The Salesforce equivalent of immunization​.dose is represented used the fields Patient​Immunization​.​Dose for the quantity and Patient​Immunization​.​Dose​UnitId for the unit​. | | dose | Patient​Immunization​.​Dose​UnitId | Lookup: UnitOf​Measure | 0​.1 | The Salesforce equivalent of immunization​.dose is represented used the fields Patient​Immunization​.​Dose for the quantity and Patient​Immunization​.​Dose​UnitId for the unit​. | | performer | ​Care​Performer | Object | 0​.M | The performer information for an immunization is represented as ​Care​Performer records that reference the Patient​Immunization record using their ​Care​Performer​.Parent​RecordId field​. | | performer​.function | ​Care​Performer​.RoleId | Lookup: ​CodeSet​​Bundle | 0​.1 | N/A | | performer​.actor | ​Care​Performer​.PersonId | Polymorphic Lookup: Account and Healthcare​Provider | 1​.1 | N/A | | note | N/A | N/A | N/A | Not supported | | reason​Code | Patient​Immunization​.Reason​CodeId | Lookup: ​CodeSet​Bundle | 0​.1 | N/A | | reason​Reference | Patient​Immunization​.Health​Condition​Id | Lookup: Health​Condition | 0​.1 | The FHIR resourceimmunization​.reason​Reference is flattened into three separate zero-to-one references to Health​Condition, ​Care​Observation, and Diagnostic​Summary in the Salesforce implementation​. | | reason​Reference | Patient​Immunization​.​Care​Observation​Id | Lookup: ​Care​Observation | 0​.1 | The FHIR resourceimmunization​.reason​Reference is flattened into three separate zero-to-one references to Health​Condition, ​Care​Observation, and Diagnostic​Summary in the Salesforce implementation​. | | reason​Reference | Patient​Immunization​.Diagnostic​Summary​Id | Lookup: Diagnostic​Summary | 0​.1 | The FHIR resourceimmunization​.reason​Reference is flattened into three separate zero-to-one references to Health​Condition, ​Care​Observation, and Diagnostic​Summary in the Salesforce implementation​. | | isSubpotent | Patient​Immunization​.IsSubpotent | Boolean | 0​.1 | N/A | | subpotent​Reason | Patient​Immunization​.Subpotency​Reason​​CodeId | Lookup: ​CodeSet​Bundle | 0​.1 | While FHIR defines immunization​.subpotent​Reason as a zero-to-many resource, the Salesforce implementation of Patient​Immunization​.Subpotency​Reason​​CodeId is a zero-to-one reference​. | | education | N/A | N/A | N/A | Not supported | | program​Eligibility | N/A | N/A | N/A | Not supported | | funding​Source | N/A | N/A | N/A | Not supported | | reaction | Patient​Health​Reaction | Object | 0​.M | The reaction information for an immunization is represented as Patient​Health​Reaction records that reference the Patient​Immunization record using their Patient​Health​Reaction​.ParentId field​. | | reaction​.date | Patient​Health​Reaction​.Reaction​Date​Time | Date​Time | 0​.1 | N/A | | reaction​.detail | Patient​Health​Reaction​.Observation​Id | Lookup: ​Care​Observation | 0​.1 | N/A | | reaction​.reported | Patient​Health​Reaction​.IsSelf​Reported | Boolean | 0​.1 | N/A | | protocol​Applied | N/A | N/A | 0​.1 | While FHIR defines immunization​.protocol​Applied as a zero-to-many reference, the Salesforce implementation of its child resources is zero-to-one​. | | protocol​Applied​.series | Patient​Immunization​.​Immunization​Recommendation | String | 0​.1 | N/A | | protocol​Applied​.authority | Patient​Immunization​.Recommending​Authority | String | 0​.1 | While FHIR defines immunization​.protocol​Applied​.authority as a reference to organization, the Salesforce implementation of Patient​Immunization​.Recommending​Authority is a text field​. | | protocol​Applied​.target​Disease | Patient​Immunization​.Target​Disease​​CodeId | Lookup: ​CodeSet​Bundle | 0​.1 | N/A | | protocol​Applied​.dose​Number​Positive​Int | Patient​Immunization​.​Current​Dose | Double | 0​.1 | N/A | | protocol​Applied​.dose​Number​String | N/A | N/A | N/A | The Salesforce implementation of immunization​.protocol​Applied​.dose​Number supports only integer values​. | | protocol​Applied​.series​Doses​Positive​Int | Patient​Immunization​.Recommended​Doses | Double | 0​.1 | N/A | | protocol​Applied​.series​Doses​String | N/A | N/A | N/A | The Salesforce implementation of immunization​.protocol​Applied​.series​Doses supports only integer values​. | #### See Also - [PatientImmunization](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_PatientImmunization.htm "Represents information about a patient’s immunizations. This object is available in API version 51.0 and later.") # IndicatorAssignment Represents the assignment of an indicator definition that's used to measure the performance of an outcome or a related activity. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program associated with the indicator assignment. This field is a relationship field. This field is available in API version 61.0 and later with the Patient Program Outcome Management permission set. - **Relationship Name**: CareProgram - **Relationship Type**: Lookup - **Refers To**: CareProgram ### IndicatorAssignmentType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the object that the indicator assignment measures. - **Possible values**: - Outcome - Care Program —This value is available from API version 61.0 and later. ### IndicatorDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The indicator definition that's associated with the indicator assignment. This field is a relationship field. - **Relationship Name**: IndicatorDefinition - **Relationship Type**: Master-Detail - **Refers To**: IndicatorDefinition ### IndicatorImprvGuideline - **Type**: textarea - **Properties**: Create,Nillable, Update - **Description**: The guidelines to improve the indicator score. This field is available in API version 62.0 and later with the Patient Program Outcome Management permission set. ### IntendedDirection - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the intended direction of change in the behavior, knowledge, skills, status, or level of functioning that's detailed in the parent indicator definition. - **Possible values**: - Decrease - Increase - Maintain ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the indicator assignment. ### OutcomeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The outcome that the indicator assignment measures. This field is a relationship field. - **Relationship Name**: Outcome - **Relationship Type**: Lookup - **Refers To**: Outcome ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of this indicator assignment. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the indicator assignment. - **Possible values**: - Active - Canceled - Completed - Planned ## 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. [IndicatorAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [IndicatorAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [IndicatorAssignmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [IndicatorAssignmentShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # IndicatorDefinition Represents information about the indicator assignment and the process of measuring and calculating the indicator results. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the indicator definition. ### FlowDefinitionApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the flow definition associated with the indicator definition. This field is available from API version 60.0 and later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last referenced this indicator definition. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last viewed this indicator definition. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the indicator definition. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns the outcome. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the indicator definition. - **Possible values**: - Active - Canceled - Completed - Planned ### UnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unit of measure for the target, baseline, and result values that are associated with this indicator definition. This field is a relationship field. - **Relationship Name**: UnitOfMeasure - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ## 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. [IndicatorDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [IndicatorDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [IndicatorDefinitionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [IndicatorDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # IndicatorPerformancePeriod Represents information about a specified time period including the frequency at which indicator results should be calculated and the baseline value of the indicator. This object is available in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### BaselineDescription - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the baseline value. ### BaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the indicator assignment at the beginning of the indicator performance period. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the indicator performance period. ### IndicatorAssignmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The indicator assignment that’s associated with the indicator performance period. This field is a relationship field. - **Relationship Name**: IndicatorAssignment - **Relationship Type**: Master-Detail - **Refers To**: IndicatorAssignment ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastResultMeasurementDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date when the last result value was measured. This field is a calculated field. ### LastResultValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The result value from the most recently measured indicator result. This field is a calculated field. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the indicator performance period. ### TargetProgress - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the progress of the target within the time period. - **Possible values**: - At Risk - Complete - Not Met - Not Started - On Track ### TargetValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The target value of the indicator assignment within the time period. ### TimePeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The time period that is associated with the indicator performance period. This field is a relationship field. - **Relationship Name**: TimePeriod - **Relationship Type**: Lookup - **Refers To**: TimePeriod ## 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. [IndicatorPerformancePeriodFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [IndicatorPerformancePeriodHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # IndicatorResult Represents the result of an indicator assignment for the specified time period that can be used to track the performance of the indicator. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### CalculationMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines whether the indicator result was added manually or calculated by automation. This field is available from API version 60.0 and later. - **Possible values**: - AutomaticallyCalculated - Manual ### Denominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort - **Description**: The denominator in automatically-calculated results that are an average or percent. This field is available from API version 60.0 and later. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the indicator result. ### FlowDefinitionApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The API name of the flow definition associated with this indicator result. This field is available from API version 60.0 and later. ### FlowVersion - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The version of the flow that calculated this result. This field is available from API version 60.0 and later. ### IndicatorPerformancePeriodId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The indicator performance period for which the result is defined. This field is a relationship field. - **Relationship Name**: IndicatorPerformancePeriod - **Relationship Type**: Master-Detail - **Refers To**: IndicatorPerformancePeriod ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last referenced this indicator result. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last viewed this indicator result. ### MeasurementDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date on which the indicator result is measured. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the indicator result. ### Numerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort - **Description**: The numerator in automatically-calculated results that are an average or percent. This field is available from API version 60.0 and later. ### ResultValue - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The result for the indicator performance period. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of the result for the time period. - **Possible values**: - Final - Interim ## 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. [IndicatorResultFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [IndicatorResultHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # IndustriesSettings Represents settings for Life Sciences Cloud. In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for details. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field. ## File Suffix and Directory Location IndustriesSettings are stored in a single file named Industries.settings in the settings directory. ## Version The settings for Life Sciences Cloud are available in API version 61.0 and later. ## Fields for Life Sciences Cloud See the [IndustriesSettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_industriessettings.htm) metadata type in the Metadata API Developer Guide. ## Declarative Metadata Sample Definition The following is an example of a Industries.Settings metadata file. true true true The following is an example package.xml that references the previous definition. Industries Settings 68.0 # InformationOrigin The CRDMetricData FHIR resource maps to the AssessmentQuestionResponse object. ## FHIR V4.0 - Discovery Framework Data Model Mapping Here’s how the fields defined by FHIR for [InformationOrigin](https://build.fhir.org/ig/HL7/davinci-dtr/StructureDefinition-information-origin.html) map to the fields in Salesforce. Table 1. InformationOrigin - Salesforce | informationorigin element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | extension:source.value\[x\] | AssessmentQuestionResponse.OriginType | Picklist | 0.1 | N/A | | extension:author | AssessmentQuestionResponse.ReviewerId | Reference: Account, Contact, Healthcare Provider, User | 0.1 | N/A | | extension:author.extension:role | AssessmentQuestionResponse.ReviewerRoleId | Reference: Code Set, Code Set Bundle | 0.M | N/A | # Input Classes These are the Apex input classes for Life Sciences Cloud. - **[ConnectApi.EmailTemplateInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_email_template_input.htm)** Input representation for creating or updating an email template. - **[ConnectApi.PageProductInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_page_product_input.htm)** Input representation for creating or deleting product guidance associations on a presentation page. - **[ConnectApi.PresentationContentInputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_input_presentation_content_input.htm)** Input representation for creating or updating presentation content. # Inquiry Represents the details of an inquiry logged by a sales representative or other user. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account associated with the inquiry. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the case associated with the inquiry. Inquiry is an extension of the case. This is a unique field. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Master-detail - **Refers To**: Case (the master object) ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The special handling instructions for Inquiry. ### DisclaimerText - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The disclaimer that was presented to the user for the Inquiry. ### InquiryChannelType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the channel through which the inquiry was made. - **Possible values**: - Email - Fax - Call Center - Field Request - Web ### IsSignatureCopyRequested - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the signature copy is requested (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The Timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the inquiry. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The priority type of the inquiry. Possible values are: - Yes - No ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record type of the inquiry. This field is a relationship field. - **Relationship Name**: RecordType - **Refers To**: RecordType ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference record ID of the inquiry. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Visit ### ResponseContactPointRecId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact method through which the account receives the information. This field is a polymorphic relationship field. - **Relationship Name**: ResponseContactPointRec - **Refers To**: ContactPointAddress, ContactPointEmail, ContactPointPhone ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### Status - **Type**: picklist - **Properties**: Defaulted on Create, Filter, Group, Nillable, Sort - **Description**: The status of the inquiry. - **Default value**: Draft - **Possible values**: - Assigned - Draft - Responded - Signed - Submitted ### SubmittedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the inquiry was submitted. ### Territory2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory or organizational region associated with the inquiry. This field is a relationship field. - **Relationship Name**: Territory2 - **Refers To**: Territory2 ### TerritoryName - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the name of the related territory when the territory is deleted. This field is only used for reporting purposes. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type or category of the inquiry. - **Possible values**: - Efficacy - Safety - Others ## 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. [InquiryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InquiryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [InquiryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # InquiryQuestion Represents a question asked by a healthcare professional (HCP) during an inquiry. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the case associated with the inquiry question. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Master-detail - **Refers To**: Case (the master object) ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional details or context related to the inquiry question. ### InquiryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID associated with the inquiry. This field is a relationship field. - **Relationship Name**: Inquiry - **Refers To**: Inquiry ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name assigned to the inquiry question. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the inquiry question. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: LifeSciMarketableProduct, Product2 ### Question - **Type**: textarea - **Properties**: Create, Update - **Description**: The inquiry question asked by the healthcare professional. ### ResponseStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The indicator for the sales representative to determine whether the question has been answered. - **Possible values**: - Not Responded - Responded ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [InquiryQuestionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InquiryQuestionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [InquiryQuestionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [InquiryQuestionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # InquiryQuestionAnswer Represents the answer provided by the Medical Science Liaison (MSL) to the inquiry question. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional details related to the response provided for the inquiry question. ### InquiryQuestionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID associated with the inquiry question. This field is a relationship field. - **Relationship Name**: InquiryQuestion - **Refers To**: InquiryQuestion ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name assigned to the answer of the inquiry question. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Response - **Type**: textarea - **Properties**: Create, Update - **Description**: The answer or response provided to the inquiry question. ### ResponseContactPointRecId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact method used to deliver the response. This field is a polymorphic relationship field. - **Relationship Name**: ResponseContactPointRec - **Refers To**: ContactPointAddress, ContactPointEmail, ContactPointPhone ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response was provided. ### ResponseDurationDays - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The number of days taken to provide a response to the inquiry. This field is a calculated field. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [InquiryQuestionAnswerChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [InquiryQuestionAnswerFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [InquiryQuestionAnswerHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [InquiryQuestionAnswerShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # IntegrationJobRun Represents the statistical details of asynchronous integration jobs that are run on the system. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ChangeEndRange - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The identifier for the end of the incremental execution of the job. ### ChangeStartRange - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The identifier for the start of the incremental execution of the job. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the job was completed. ### JobAdditionalInfo - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional information on the job, for example, the country to which the job is applied. ### JobExectionSummary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The summary of the job, such as the downloaded record types with the count and number of failed records. ### JobIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The MuleSoft identifier for the job. ### JobName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the integration job. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the integration job run. ### Origin - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The feature from which the job is initiated. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the integration job run. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the job was started. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the job. ### TotalRecordsFailed - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of failed records in the job. ### TotalRecordsProcessed - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of processed records in the job. ## 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. [IntegrationJobRunFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [IntegrationJobRunHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [IntegrationJobRunShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Intelligent Content Intelligent Content facilitates marketing strategies by enabling direct and interactive communications with healthcare professionals (HCPs). Sales and medical teams can deliver personalized presentations based on real-time feedback and analytics, enhancing the impact of their interactions. By continuously refining and optimizing marketing messages and strategies through data collection and analysis, Intelligent Content ensures that they are relevant and responsive to HCP needs and preferences. Intelligent Content capabilities include analytics and optimized user interfaces, offering a comprehensive solution for targeted content delivery in both planned and unplanned presentations. ![Intelligent Content entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_intelligent_content_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/intelligent-content.html "HTML (New Window)"). ## Intelligent Content Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Document Link](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocumentlink.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Email Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciemailtemplate.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Presentation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentation.htm) - [Presentation Click Stream Entry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationclickstrmentry.htm) - [Presentation Forum](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationforum.htm) - [Presentation Linked Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationlinkedpage.htm) - [Presentation Page](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpage.htm) - [Presentation Page Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpageproduct.htm) - [Presentation Party Access](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_presentationpartyaccess.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisit.htm) - [Provider Visit Detailing Product Message](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitdtlproductmsg.htm) - [Provider Visit Product Detailing](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitproddetailing.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Intelligent Document Automation Use the Intelligent Document Automation data objects to simplify the document management process, reduce manual data entry, and get patients the right care and services faster by managing patient and member forms all in one place, from intake through processing. The Intelligent Document Automation data objects are visible to users with the Health Cloud Starter permission set. Available in API version 47.0 and later. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Intelligent Document Management Use the Intelligent Document Management resources to create or update records in Salesforce objects based on the content document records or received document records. Currently, a user can use the manual flow from the user interface to create records in the target Salesforce objects. A user can create target records based on the content document records or received document records using: - Transform Document—Transform the received document to create a record in the target Salesforce object. - Review Document—When the transformed document is used to create the target record, users can review the document for any conflicts, choose to resolve the conflicts, and update the document. With the Intelligent Document Automation APIs, you can automate the process of getting the mappings between the values of the keys extracted from the content document and the Salesforce object fields, and create a record in the target Salesforce object. Before using the APIs, perform AWS text extraction from the content document record or received document record by using the POST request on the [OCR Text Extraction](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_extraction_of_content_doc.htm) resource. ## Supported Salesforce Objects Account, BusinessMilestone, Case, Contact, CareDiagnosis, CareRequest, CareRequestDrug, CareRequestExtension, CareRequestItem, CareProgramEnrollee, Lead, Opportunity, Visit, and custom objects. ## Special Access Rules To use these resources, you must have the HealthCloud, DocumentChecklist, and AWSTextract1000LimitAddOn licenses. ## Available Resources | Resource | Description | | --- | --- | | [/connect/form-reader/contentDocuments​/${contentDocumentId}/record](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_create_content_documents.htm) | Create records in Salesforce objects using a document based on a content document record. | | [/connect/form-reader/contentDocuments​/${contentDocumentId}/record/${targetRecordId}](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_update_content_documents.htm) | Update an existing record in a Salesforce object using a document based on a content document record. | | [/connect/form-reader/receivedDocuments​/${receivedDocumentId}/record](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_create_received_documents.htm) | Create records in Salesforce objects using a document based on a received document record. | | [/connect/form-reader/receivedDocuments​/${receivedDocumentId}/record/${targetRecordId}](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_update_received_documents.htm) | Update an existing record in a Salesforce object using a document based on a received document record. | | [/connect/document-automation/contentDocuments​/${contentDocumentId}/linkedObjects/${linkedObjectId}](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_split_documents.htm "Split a document and attach one or more pages from the transformed document to Salesforce records.") | Split a document and attach one or more pages from the transformed document to Salesforce records. | - **[Split Documents](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_split_documents.htm)** Split a document and attach one or more pages from the transformed document to Salesforce records. # Intelligent Sales Help your sales team plan and execute sales visits and manage field inventory with Intelligent Sales.
Available in: Enterprise and Unlimited Editions
![A screenshot of the Intelligent Sales data model.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/images/intelligent_sales_ERD.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/intelligent-sales.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # InventoryCntProdtBatchItem Represents the inventory count of a product batch at a location. The inventory count product batch item is a child object of inventory count assessment. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual end date and time for counting the batch's inventory. ### ActualQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual quantity of the batch's inventory. ### ActualStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual start date and time for counting the batch's inventory. ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the person who counts the inventory. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: Contact, User ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A comment, note, or instruction that gives additional context for the count of the batch's inventory. ### DiscrepancyReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of reason for the discrepancy between the actual quantity and the expected quantity. ### ExpectedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected quantity of the batch's inventory. ### InventoryCountAssessmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The inventory count assessment associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: InventoryCountAssessment - **Relationship Type**: Master-detail - **Refers To**: InventoryCountAssessment (the master object) ### InventoryCountProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count product item associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: InventoryCountProductItem - **Refers To**: InventoryCountProductItem ### IsBlindCount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expected inventory quantity is visible to the assignee during inventory counting (true) or not (false). - **Default value**: false ### IsDiscrepancyInQuantity - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether there's a discrepancy between the actual quantity and the expected quantity (true) or not (false). This field is a calculated field. - **Default value**: false ### IsSerializedProduct - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the product being counted is serialized (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the location associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### LocationPrimaryUserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the primary user of the location associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: LocationPrimaryUser - **Refers To**: User ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the inventory count product batch item record. ### ProductBatchItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the product batch item associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: ProductBatchItem - **Refers To**: ProductBatchItem ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the product item associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductionBatchId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the production batch associated with the inventory count product batch item. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of inventory count product batch item. - **Possible values**: - Completed - InProgress—In Progress - NotStarted—Not Started # InventoryCountAssessment Represents an inventory count performed at a location. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual end date and time for the inventory count. ### ActualStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The actual start date and time for the inventory count. ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who counts the inventory. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: Contact, User ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comment, note, or instruction that gives additional context for the inventory count. ### InventoryCountPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count plan associated with the inventory count. This field is a relationship field. - **Relationship Name**: InventoryCountPlan - **Refers To**: InventoryCountPlan ### IsBlindCount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expected inventory quantity is visible to the assignee when they count the inventory (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The location associated with the inventory count. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### LocationPrimaryUserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary user of the location associated with the inventory count. This field is a relationship field. - **Relationship Name**: LocationPrimaryUser - **Refers To**: User ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the inventory count assessment record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the inventory count assessment record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PlannedEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The planned end date and time for the inventory count. ### PlannedStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The planned start date and time for the inventory count. ### Purpose - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the purpose of the inventory count. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the inventory count. - **Possible values**: - Assigned - AuditorApproved—Auditor Approved - Complete—Completed - InProgress—In Progress ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the inventory count. - **Possible values**: - Adhoc - Audited - Initial - Periodic ### VerificationSubmittedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the inventory count is submitted for verification. ### VerifierComment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comment, note, or instruction for the verification of inventory count. ### VerifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who verifies the inventory count. This field is a polymorphic relationship field. - **Relationship Name**: Verifier - **Refers To**: Contact, User # InventoryOperation Represents operations performed on the inventory, such as transfers, disbursements, or adjustments. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores additional information about the inventory operation. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comments for the inventory operation. ### DestinationAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The address at which the products are delivered. This field is a relationship field. - **Relationship Name**: DestinationAddress - **Refers To**: Address ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the destination location associated with the inventory operation. This field is a relationship field. - **Relationship Name**: DestinationLocation - **Refers To**: Location ### DestinationLocationUserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the primary user associated with the destination location of the inventory operation. This field is a relationship field. - **Relationship Name**: DestinationLocationUser - **Refers To**: User ### IsDuplicate - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation is a duplicate (true) or not (false). - **Default value**: false ### IsException - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation has any exception (true) or not (false). - **Default value**: false ### IsSystemCreated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the inventory operation is created by the system (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the inventory operation record. ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of inventory operation. - **Possible values**: - Adjustment - Disbursement - Return - Transfer - TransferIn—Transfer In - TransferOut—Transfer Out ### OpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The opportunity associated with the inventory operation. This field is a relationship field. - **Relationship Name**: Opportunity - **Refers To**: Opportunity ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the inventory operation record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product request associated with the inventory operation. This field is a relationship field. - **Relationship Name**: ProductRequest - **Refers To**: ProductRequest ### RelatedOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the related operation associated with the inventory operation. This field is a relationship field. - **Relationship Name**: RelatedOperation - **Refers To**: InventoryOperation ### ShipmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status indicating the condition of the shipment. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the source location associated with the inventory operation. This field is a relationship field. - **Relationship Name**: SourceLocation - **Refers To**: Location ### SourceLocationUserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the primary user associated with the source location of the inventory operation. This field is a relationship field. - **Relationship Name**: SourceLocationUser - **Refers To**: User ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the visit associated with the inventory operation. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [InventoryOperationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [InventoryOperationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [InventoryOperationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Key Account Management Key Account Management enables Key Account Managers (KAM) to strategically manage and engage with their most important customers. By using comprehensive account and territory plans, KAMs can set clear business objectives, track progress, and ensure alignment across global, affiliate, and territory levels. This structured approach enhances customer targeting accuracy and drives effective execution of strategic initiatives. With capabilities for creating multiple plans, defining specific objectives, and assigning tasks, the Key Account Management ensures alignment, collaboration, and effective execution of strategies to achieve desired business outcomes. ## Account Plan Key account managers use Account Plans to enhance the accuracy of customer targeting and management by defining business objectives at the global, affiliate, and territory levels. Key Account Management in Life Sciences Cloud consists of five stages: Goal Setting, Targeting, Strategic Planning, Execution, and Reporting. An account can have multiple account plans, each with one or more objectives. Each objective can have one or more tactics, which are groups of tasks that can be tracked for progress and rolled up to higher objectives. Assign tasks and tactics to various team members for stakeholders and track them through sprints. ![Account Plan entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_key_account_plan_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/key-account-management-account-plan.html "HTML (New Window)"). ## Territory Plan Key account managers use Territory Plans to enhance the accuracy of customer targeting and management by establishing business objectives at the Global, Affiliate, and Territory levels. These plans include setting goals, tracking progress, and reporting outcomes through the KAM operating model, which consists of five stages: Goal Setting, Execution, and Reporting. There are three types of objectives: Global Business objectives, Affiliate objectives, and Territory objectives, each serving a specific tracking purpose. Territory Plans can contain multiple objectives, each with corresponding tactics to monitor progress and achieve set goals effectively. Tracking tasks from tactics to objectives ensures a comprehensive approach to managing territories and achieving desired outcomes. ![Territory Plan entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_key_territory_plan_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/key-account-management-territory-plan.html "HTML (New Window)"). ## Key Account Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Account Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_accountplan.htm) - [Account Plan Objective](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_accountplanobjective.htm) - [Account Plan Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanparticipant.htm) - [Account Plan Participant Stakeholder](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_acctplanptcpstakeholder.htm) - [Account Plan Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanproduct.htm) - [Account Plan Related Object Analysis](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanrelaobjanalysis.htm) - [Account Plan Relationship](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanrelationship.htm) - [Account Plan Stakeholder](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstakeholder.htm) - [Account Plan Stakeholder Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstkhldraction.htm) - [Account Plan Stakeholder Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_accountplanstkhldrproduct.htm) - [Action Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplan.htm) - [Action Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplanitem_kam.htm) - [Action Plan Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplate.htm) - [Action Plan Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplateassignment.htm) - [Action Plan Template Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitem.htm) - [Action Plan Template Item Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitemvalue_kam.htm) - [Action Plan Template Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateversion_kam.htm) - [Assessment Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_assessmenttask.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Goal Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goalassignment.htm) - [Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinition.htm) - [Goal Definition Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinitionproduct.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Account Product Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctproductinfo.htm) - [Sprint](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_sprint.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory.htm) - [Territory Business Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territorybusinessplan.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Group](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_group.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). #### See Also - [_Object Reference for the Salesforce Platform_: ActionPlanItem](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplanitem.htm) - [_Object Reference for the Salesforce Platform_: ActionPlanTemplateVersion](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateversion.htm) - [_Object Reference for the Salesforce Platform_: ActionPlanTemplateItemValue](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplateitemvalue.htm) - [_Object Reference for the Salesforce Platform_: ActionPlanTemplateAssignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplateassignment.htm) - [_Object Reference for the Salesforce Platform_: ActionPlan](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplan.htm) - [_Object Reference for the Salesforce Platform_: ActionPlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionplantemplate.htm) # Life Sciences Cloud Associated Objects This section provides a list of objects associated to Life Sciences 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/system_fields.htm "HTML (New Window)") in the Object Reference for Salesforce 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, inspect the WSDL or use a schema viewer. # Life Sciences Cloud Business APIs You can access Life Sciences 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 Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm "HTML (New Window)") - **[Resources](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_resources.htm)** Use these resources of Life Sciences Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications. - **[Request Bodies](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_requests.htm)** This section lists the request bodies for Life Sciences Cloud Business APIs. The query parameters for an endpoint are listed along with each resource. - **[Response Bodies](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_responses.htm)** A resource can return a response body in either JSON or XML format. #### See Also - [_Connect REST API Developer Guide_: Introduction](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm "Connect REST API Developer Guide: Introduction - HTML (New Window)") # Life Sciences Cloud Data Models Life Sciences Cloud uses a suite of standard Salesforce objects to structure and store data related to Clinical Engagement, Customer Engagement, Patient Engagement, MedTech Commercial Engagement and other features. To better understand how features work, it helps to look at the data models, which are graphical representations of collections of objects and their relationships. - **[Clinical Engagement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_clinical_engagement.htm)** These objects are available for Life Sciences Cloud for Clinical Engagement. - **[Customer Engagement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_customer_engagement_data_model.htm)** These objects are available for Life Sciences Customer Engagement. - **[Patient Engagement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_patient_engagement_data_model.htm)** These objects are available for Life Sciences Cloud for Patient Engagement. - **[MedTech Commercial Engagement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_medtec_commercial_engagement.htm)** These objects are available for Life Sciences Cloud for MedTech Commercial Engagement. # Life Sciences Cloud Developer Guide Life Sciences Cloud is an end-to-end, purpose-built platform for the life sciences industry spanning clinical to medical to commercial domains. This guide includes the available developer resources for Life Sciences Cloud. - **[Life Sciences Cloud Data Models](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_data_models_overview.htm)** Life Sciences Cloud uses a suite of standard Salesforce objects to structure and store data related to Clinical Engagement, Customer Engagement, Patient Engagement, MedTech Commercial Engagement and other features. To better understand how features work, it helps to look at the data models, which are graphical representations of collections of objects and their relationships. - **[Life Sciences Cloud Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm)** Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform. - **[Life Sciences Cloud Fields on Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_custom_fields.htm)** Life Sciences Cloud adds fields to some standard Salesforce objects to represent information about individuals. These fields are available only in orgs where Life Sciences Cloud is enabled. - **[StandardValueSet Names and Standard Picklist Fields](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_standardvalueset_names.htm)** This table lists the names of standard picklists as standard value sets and their corresponding field names. - **[Life Sciences Cloud Platform Events](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_platform_events_parent.htm)** Use the ApplnFormAppealStsChgEvnt platform event to notify subscribers when the status of the Financial Assistance Program’s appeal changes. Use the CareBnftVrfyRqstStsChgEvent platform event to notify subscribers when the status of care benefit verify request changes. - **[Working With Electronic Health Records](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hl7.htm)** HL7 (Health Level Seven) is a standard for exchanging electronic health records (EHR). You can parse EHR data transmitted via HL7 data messages and store it in Salesforce. - **[Life Sciences Cloud Business APIs](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_business_apis_rest_reference.htm)** You can access Life Sciences Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. - **[Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_apex_reference.htm)** This Apex reference goes into detail about the built-in Apex classes, interfaces, methods, or enums for Life Sciences Cloud. - **[Life Sciences Cloud Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lifesciences_invocable_actions_parent.htm)** Use the standard invocable actions available with Life Sciences Cloud to streamline the process of enrolling participants in clinical trials. - **[Life Sciences Cloud Tooling API Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_tooling_api_parent.htm)** Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. - **[Life Sciences Cloud Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_metadata_types.htm)** Metadata API enables you to access some types and feature settings that you can customize in the user interface. - **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_api_rest_eol.htm)** #### See Also - [_Revenue Lifecycle Management Developer Guide_: Product Catalog Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/pcm_overview.htm "Revenue Lifecycle Management Developer Guide: Product Catalog Management - HTML (New Window)") # Life Sciences Cloud Fields on Standard Objects Life Sciences Cloud adds fields to some standard Salesforce objects to represent information about individuals. These fields are available only in orgs where Life Sciences Cloud is enabled. # Life Sciences Cloud Metadata Types Metadata API enables you to access some types and feature settings that you can customize in the user interface. For more information about Metadata API and to find a complete reference of existing metadata types, see [Metadata API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_intro.htm "HTML (New Window)"). #### See Also - [_Metadata API Developer Guide_: Understanding Metadata API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_intro.htm "Metadata API Developer Guide: Understanding Metadata API - HTML (New Window)") # Life Sciences Cloud Platform Events Use the ApplnFormAppealStsChgEvnt platform event to notify subscribers when the status of the Financial Assistance Program’s appeal changes. Use the CareBnftVrfyRqstStsChgEvent platform event to notify subscribers when the status of care benefit verify request changes. This platform event object is available within the Life Sciences Cloud platform. - **[ApplnFormAppealStsChgEvnt](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_applnformappealstschgevnt.htm)** Notifies subscribers of changes to the status of an appeal filed against a Financial Assistance Program. This object is available in API version 63.0 and later. - **[CareBnftVrfyRqstStsChgEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_carebnftvrfyrqststschgevent.htm)** Notifies subscribers of changes to the status of a care benefit verify request. This object is available in API version 65.0 and later. - **[PrvdManagedEventVldEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdmanagedeventvldevent.htm)** Represents an event that's generated when a provider-related managed event fails or breaches its validation limits. This triggers notifications to users to take prompt action to rectify the breach. This object is available in API version 67.0 and later. # Life Sciences Cloud Standard Invocable Actions Use the standard invocable actions available with Life Sciences Cloud to streamline the process of enrolling participants in clinical trials. - **[Assign Candidate to Research Study Group Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/actions_obj_assign_candidate_to_research_study_group.htm)** Assign candidates, enrolled in the clinical trials through randomization to research study comparison groups. - **[Build Product Territory Detailed Availability Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_build_prod_terr_dtl_availabilities.htm)** Build Product Territory Detailed Availability records using existing Product Territory Availability records. - **[Clone Activity Plan And Territories Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_clone_actvty_plan_territories.htm)** Clones Activity Plan records and associates them with specified territories. - **[Evaluate Access Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_evaluate_access.htm)** Evaluates a specified access check (user permission) against the current security context and returns whether the running user has the requested permission. - **[Generate Research Study Blocks Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/actions_obj_generate_research_study_blocks.htm)** Generate research study randomization block records to link each block with a specific research study comparison group by using the randomization process. - **[Get Context Data Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_get_context_data.htm)** Retrieves the context data that is passed as an input to a prompt template that generates a summary of the data. - **[Get Life Sciences Configuration Field Names and Values](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_get_ls_config_key_values.htm)** Gets key-value pairs of field names and their values for Life Sciences configuration records of a given category. - **[Get Qualified Products Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_get_qualified_products.htm)** Retrieves the PricebookEntry IDs for products that a user is authorized to use for a given account and territories. When productPurpose isn’t specified, the action defaults to Quote. Allowed purpose values are Quote, Visit, and Order. - **[Process Criteria Matching Response](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/actions_obj_process_criteria_matching_response.htm)** Parses a GPT-generated JSON response to evaluate each inclusion and exclusion criterion for a given Research Study Candidate, determining whether each criterion is matched or not. This action stores the GPT response in the Care Program Enrollment Evaluation Result entity and computes the number of matched inclusion criteria and exclusion criteria, returning these counts as output. - **[Serialize Hierarchical Context Data](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_serialize_hierarchical_context_data.htm)** Serializes the hierarchical context data from the Apex embeddedai\_\_RecordApexRepresentation records that are passed as input to a prompt template that generates a summary of the data. - **[Set Life Sciences Quote Document Defaults Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_set_quote_document_defaults.htm)** Sets default attributes on document recipients for a specified quote document based on its attached Lightning flexipage layout. - **[Share Quote Based on Account Action](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/ls_actions_share_quote_based_on_account.htm)** Synchronizes Quote sharing with Account sharing by querying AccountShare records for the specified Quote account ID and upserting the corresponding QuoteShare records. # Life Sciences Cloud Standard Objects Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform. The topics in this section describe the standard objects documented in this guide. To verify the complete list of fields for an object, use a describe call from the API, or inspect the WSDL or a schema viewer. Life Sciences Cloud also uses these platform objects. They’re documented in the Object Reference for the Salesforce Platform. - [Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_address.htm "HTML (New Window)") Represents a mailing, billing, or home address. - [RecordAction](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_recordaction.htm "HTML (New Window)") Represents a relationship between a record and an action, such as a flow. Create a RecordAction for every action that you want to associate with a particular record. This object is available in API version 42.0 and later. #### See Also - [_Object Reference for the Salesforce Platform_: Overview of Salesforce Objects and Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_concepts.htm "Object Reference for the Salesforce Platform: Overview of Salesforce Objects and Fields - HTML (New Window)") - [_SOAP API Developer Guide_: Introduction to SOAP API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/sforce_api_quickstart_intro.htm "SOAP API Developer Guide: Introduction to SOAP API - HTML (New Window)") - [_Industries Common Resources Developer Guide_: Discovery Framework Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/discovery_framework_standard_objects.htm "Industries Common Resources Developer Guide: Discovery Framework Standard Objects - HTML (New Window)") - [_Industries Common Resources Developer Guide_: Intelligent Form Reader Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/form_reader_standard_objects_overview.htm "Industries Common Resources Developer Guide: Intelligent Form Reader Standard Objects - HTML (New Window)") # Life Sciences Cloud Tooling API Objects Tooling API exposes metadata used in developer tooling that you can access through REST or SOAP. Tooling API’s SOQL capabilities for many metadata types allow you to retrieve smaller pieces of metadata. For more information about Tooling API objects and to find a complete reference of all the supported objects, see [Introducing Tooling API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/intro_api_tooling.htm "HTML (New Window)"). #### See Also - [_Tooling API Developer Guide_: Introducing Tooling API](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_tooling.meta/api_tooling/intro_api_tooling.htm "Tooling API Developer Guide: Introducing Tooling API - HTML (New Window)") # LifeSciAccountListColumn Represents the information of the columns selected from accounts or its supported direct relationship objects in account filters. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() LifeSciAccountListColumn isn't available in the Object Manager and can't be customized. ## Fields ### ColumnApiName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of Life Science Account List Object field. ### DisplayOrder - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The display order of the Life Science Account List Column in Life Science Account List. ### LifeSciAccountListObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Stores the Life Science Account List Object associated with Life Science Account List Column. This is a relationship field. - **Relationship Name**: LifeSciAccountListObject - **Relationship Type**: Master-detail - **Refers To**: LifeScienceAccountListObject (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of Life Science Account List Column. ### SortOrderType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The sort order of the Life Science Account List Column. - **Possible values**: - ASC - DESC ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. # LifeSciAccountListMember Represents information about account static lists and routine. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() LifeSciAccountListMember isn't available in the Object Manager and can't be customized. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the identifier for the account associated with the static list or route. This is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ContactPointAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the location details of an event in a route. This is a relationship field. - **Relationship Name**: ContactPointAddress - **Refers To**: ContactPointAddress ### DurationInMinutes - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the duration of the route event in minutes. ### LifeScienceAccountListId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Stores the provider account list, which is a static list or a route. This is a relationship field. - **Relationship Name**: LifeScienceAccountList - **Relationship Type**: Master-detail - **Refers To**: LifeScienceAccountList (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Life Science Account List Member. ### ProviderVisitOffsetDay - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the duration between the start date of the route and the date of the visit, in days. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### VisitStartTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start time of an event in a route in the 24-Hour format. # LifeSciAcctGrpAssignment Represents a junction between an account and actionable list. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionableListId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The actionable list associated with the group assignment. This field is a relationship field. - **Relationship Name**: ActionableList - **Refers To**: ActionableList ### AssignmentReferenceRecId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The assortment or provider sample limit template associated with the group assignment. This field is a polymorphic relationship field. - **Relationship Name**: AssignmentReferenceRec - **Refers To**: ProviderSampleLimitTemplate ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the life sciences account group assignment. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ## 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. [LifeSciAcctGrpAssignmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciAcctGrpAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciAcctGrpAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciAcctGrpAssignmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [LifeSciAcctGrpAssignmentShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciAcctListFilterCrit Stores the rules and conditions derived from the Account object or its supported direct relationship objects to filter Life Sciences accounts. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() LifeSciAcctListFilterCrit isn't available in the Object Manager and can't be customized. ## Fields ### ColumnApiName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of Life Science Account List Object field. ### ColumnDataType - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of the Life Science Account List object field. ### ColumnValue - **Type**: textarea - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Stores the value against which the Life Science Account List object field is evaluated. ### LifeSciAccountListObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Stores the Life Science Account List object associated with the filter criteria. This field is a relationship field. - **Relationship Name**: LifeSciAccountListObject - **Relationship Type**: Master-detail - **Refers To**: LifeScienceAccountListObject (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of Life Science Account List Filter Criteria. ### OperatorType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Stores the information about an operator that will be used to evaluate a criteria. - **Possible values**: - Contains - DoesNotContain—Does Not Contain - Equals - GreaterOrEqual—Greater Or Equal - GreaterThan—Greater Than - In - LessOrEqual—Less Or Equal - LessThan—Less Than - NotEqualTo—Not Equal To ### SequenceNumber - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The sequence number of the Life Science Account List Filter Criteria in the filter logic of the related account list. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. # LifeSciConfigAssignment Represents the assignments for a Life Sciences configuration record. This object is a child of LifeSciConfigRecord. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### AssignedToId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The profile or user associated with the record. This field is a polymorphic relationship field. - **Relationship Name**: AssignedTo - **Relationship Type**: Lookup - **Refers To**: Profile, User ### AssignmentLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies the level of the assignment. - **Possible values**: - Profile - User ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the LifeSciConfigAssignment. ### LifeSciConfigRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The configuration record associated with the assignment. This field is a relationship field. - **Relationship Name**: LifeSciConfigRecord - **Refers To**: LifeSciConfigRecord ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the configuration assignment. In the UI, this field is **Label**. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The prefix is limited to a maximum of 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. # LifeSciConfigCategory Represents the category that Life Sciences configuration records are organized into. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location LifeSciConfigCategory components have the suffix .lifeSciConfigCategory and are stored in the lifeSciConfigCategories folder. ## Version LifeSciConfigCategory components are available in API version 65.0 and later. ## Fields ### category - **Field Type**: LifeSciConfigCategoryType (enumeration of type string) - **Description**: Required Defines the category for the configuration. - **Possible values**: - AccountProviderVisitRecordTypeMapping - AccountSearchSettings - ActivityHistoryAdministration - ActivityHistoryRelatedLabel - ActivityPlanConfiguration - ActivityPlanSettings - AddressSettings - AffiliationReverseRoleMapping - AffiliationSettings - ApplicationSettings - BestTimeSettings - BulkUpdateRestrictedEntity - BusinessHoursHolidayMapping - CalendarEvent - CallCustomDiscussionRecordType - CallDiscussionRecordType - ConcurOrgLevelConfig - CustomAction - CustomerMergeSettings - DbSchema - DEASettings - DTVComponentConfig - DTVObjectConfig - EnablementCoachingSettings - EnablementCoachingOrgLevelSettings - ExternalSearchPreferences - ExternalSearchUserSettings - FieldSetMapping - InsDocSettings - InsightSettings - InventoryManagementSettings - KAM - KAMSettings - LogSettings - ManagedEventRecordTypeMapping - NavigationIcons - NextBestCustomerSettings - ObjectRecordTypeRoutingConfiguration - OptAdministration - PlannerAdministration - ProductAdminSettings - ProfileBasedAppSettings - ProviderSummarization - PrvdEngmtComplianceSettings - QuickAction - QuoteSettings - ReportsAndDashboardsSync - SearchBeforeCreate - SprintSettings - StateDistributorLicenseSettings - StateLicenseNumberSettings - SyncProcessorConfiguration - SyncTransactionAdminView - SyncTransactionConfig - SyncTransactionFieldBehaviour - TerritoryManagement - TimeOffTerritoryDynamicRule - TimeOffTerritoryOrgLevelSettings - TimeOffTerritoryRule - TimeOffTerritorySettings - TimeOffTerritorySlots - TimeOffTerritoryWorkingDaySettings - TimelineActivitySetting - TransferOrderSettings - UISchema - VideoCallPhoneNumber - VideoCallSettings - VideoCallSettingsCommon–Reserved for future use. - VideoCallSettingsMsTeams - WorkingDaysConfig ### categoryLabel - **Field Type**: String - **Description**: The label for the categories. ### isProtected - **Field Type**: Boolean - **Description**: Indicates whether the field is protected (true) or not (false). ### masterLabel - **Field Type**: String - **Description**: Required The main label for the configuration. ### type - **Field Type**: LifeSciCategoryType (enumeration of type string) - **Description**: Type of configuration category. - **Possible values**: - Hierarchical - List ## Declarative Metadata Sample Definition The following is an example of a LifeSciConfigCategory component. ApplicationSettings ApplicationSettings The following is an example package.xml that references the previous definition. \* LifeSciConfigCategory 65.0 # LifeSciConfigCategory Represents the category that Life Sciences configuration records are organized into. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The category used to organize the Life Sciences configuration records. Possible values are: - AccountProviderVisitRecordTypeMapping - AccountSearchSettings - ActivityHistoryAdministration - ActivityHistoryRelatedLabel - ActivityPlanConfiguration - ActivityPlanSettings - AddressSettings - AffiliationReverseRoleMapping - AffiliationSettings - ApplicationSettings - BestTimeSettings - BulkUpdateRestrictedEntity - BusinessHoursHolidayMapping - CalendarEvent - CallCustomDiscussionRecordType - CallDiscussionRecordType - ConcurOrgLevelConfig - CustomAction - CustomerMergeSettings - DEASettings - DTVComponentConfig - DTVObjectConfig - DbSchema - EnablementCoachingOrgLevelSettings - ExternalSearchPreferences - ExternalSearchUserSettings - FieldSetMapping - InventoryManagementSettings - KAM - KAMSettings - LogSettings - ManagedEventRecordTypeMapping - NavigationIcons - OptAdministration - PlannerAdministration - ProductAdminSettings - ProfileBasedAppSettings - ProviderSummarization - QuickAction - ReportsAndDashboardsSync - SearchBeforeCreate - SprintSettings - StateDistributorLicenseSettings - StateLicenseNumberSettings - SyncProcessorConfiguration - SyncTransactionAdminView - SyncTransactionConfig - SyncTransactionFieldBehaviour - TerritoryManagement - TimeOffTerritoryDynamicRule - TimeOffTerritoryRule - TimeOffTerritoryOrgLevelSettings - TimeOffTerritorySettings - TimeOffTerritorySlots - TimeOffTerritoryWorkingDaySettings - TimelineActivitySetting - UISchema - VideoCallPhoneNumber - VideoCallSettings - WorkingDaysConfig ### CategoryLabel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The custom label for the category. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the LifeSciConfigCategory. ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the configuration category. In the UI, this field is **Label**. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The prefix is limited to a maximum of 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. # LifeSciConfigFieldValue Represents a field value for a Life Sciences configuration record. This object is a child of LifeSciConfigRecord. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DataType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The data type of the field. - **Possible values**: - BOOLEAN - DATE - DATETIME - FIELD - INTEGER - LONGTEXT - MULTIPICKLIST - NUMBER - OBJECT - PHONE - PICKLIST - RECORDREFERENCE - TEXT - URL ### DateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time value for the field. ### DateValue - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date value for the field. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ### FieldName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The name of the field. ### FieldValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field reference value for the field. ### HasBooleanValue - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Boolean value of the field is true or false. - **Default value**: false ### IntegerValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The integer value for the field. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the LifeSciConfigFieldValue. ### LifeSciConfigRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The configuration record associated with the field value. This field is a relationship field. - **Relationship Name**: LifeSciConfigRecord - **Refers To**: LifeSciConfigRecord ### LongTextValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The long text value for the field. ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the configuration category. In the UI, this field is **Label**. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The prefix is limited to a maximum of 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. ### NumberValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number value for the field. ### ObjectValue - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The object reference value for the field. ### PhoneValue - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The phone value for the field. ### PicklistValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The picklist value for the field. ### TextValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The text value for the field. ### UrlValue - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL value for the field. # LifeSciConfigRecord Represents the configuration records used in Life Sciences Cloud. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location LifeSciConfigRecord components have the suffix .lifeSciConfigRecord and are stored in the lifeSciConfigRecords folder. For profile-level and user-level configuration records in hierarchical categories, the file name includes the category name and the assignment level. - Standard profile: {Category}-{ProfileName}.lifeSciConfigRecord - Custom profile: {Category}-Custom-{ProfileName}.lifeSciConfigRecord - User-level: {Category}-User-{Username}.lifeSciConfigRecord Characters that aren't valid in file names (/ \\ : \* ? " < > |) are encoded as \_xNN, where NN is the hexadecimal character code. For example, / is encoded as \_x2F. During deploy, Salesforce resolves profile and user names in file names and assignment tags to the correct IDs on the target org. If a record for the same category and profile or user already exists, it's updated. Otherwise, a new record is created. This naming convention doesn't apply to org-level configuration records. ## Version LifeSciConfigRecord components are available in API version 65.0 and later. ## Fields ### assignments - **Field Type**: [LifeSciConfigAssignment](#LifeSciConfigAssignment) - **Description**: Profiles or users assigned to a configuration record. ### fieldValue - **Field Type**: [LifeSciConfigFieldValue](#LifeSciConfigFieldValue) - **Description**: The value when it represents a field’s name. ### isActive - **Field Type**: Boolean - **Description**: Indicates whether the configuration record is active. Supported values are true or false. ### isOrgLevel - **Field Type**: Boolean - **Description**: Indicates whether the configuration record is at the organization level. Supported values are true or false. ### isProtected - **Field Type**: Boolean - **Description**: Indicates whether the configuration record is protected. Supported values are true or false. ### lifeSciConfigCategory - **Field Type**: String - **Description**: Required Category of the life science configuration. ### masterLabel - **Field Type**: String - **Description**: Required Main label for the configuration. ### parentConfigRecord - **Field Type**: String - **Description**: Parent configuration record. ### type - **Field Type**: String - **Description**: Type of configuration record. ## LifeSciConfigAssignment The following table describes the assignment for the LifeSciConfigAssignement component. ### assignedTo - **Field Type**: String - **Description**: User or profile to which the configuration is assigned. For profile-level records, custom profiles use a Custom- prefix, for example, Custom-Medical Sales Representative. Standard profiles don't require a prefix. ### assignmentLevel - **Field Type**: LifeSciAssignmentLevel - **Description**: Required Level of assignment for the configuration. Supported values are Profile or User. ## LifeSciConfigFieldValue Fields The following table describes the fields for the LifeSciConfigFieldValue component. ### dataType - **Field Type**: LifeSciConfigFieldDataType - **Description**: Required Data type of the field. - **Possible values**: - TEXT - LONGTEXT - NUMBER - BOOLEAN - INTEGER - DATE - DATETIME - PHONE - PICKLIST - URL - OBJECT - FIELD - RECORDREFERENCE - MULTIPICKLIST ### dateTimeValue - **Field Type**: DateTime - **Description**: Date and time value of the field. ### dateValue - **Field Type**: Date - **Description**: Date value of the field. ### fieldName - **Field Type**: String - **Description**: Required The value when it represents a field’s name. ### fieldValue - **Field Type**: String - **Description**: Required Value of the field. ### hasBooleanValue - **Field Type**: Boolean - **Description**: Indicates whether the value is a Boolean. ### integerValue - **Field Type**: Int - **Description**: Integer value of the field. ### longTextValue - **Field Type**: String - **Description**: Long text value of the field. ### numberValue - **Field Type**: Double - **Description**: Number value of the field. ### objectValue - **Field Type**: String - **Description**: The value when it represents an object’s name. ### phoneValue - **Field Type**: String - **Description**: Phone value of the field. ### picklistValue - **Field Type**: String - **Description**: Picklist value of the field. ### textValue - **Field Type**: String - **Description**: Text value of the field. ### urlValue - **Field Type**: String - **Description**: URL value of the field. ## Declarative Metadata Sample Definition The following is an example of a LifeSciConfigRecord component. false true ApplicationSettings ApplicationSettings\_OrgLevel The following is an example package.xml that references the LifeSciConfigRecord component. ApplicationSettings\_OrgLevel LifeSciConfigRecord 65.0 # LifeSciConfigRecord Represents a configuration record for Life Sciences. This object is a child of LifeScienceConfigCategory. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the configuration is active (true) or not (false). - **Default value**: false ### IsOrgLevel - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the configuration applies to every user in the org (true) or not (false). - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the LifeSciConfigRecord. ### LifeSciConfigCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The category associated with the configuration. This field is a relationship field. - **Relationship Name**: LifeSciConfigCategory - **Relationship Type**: Lookup - **Refers To**: LifeSciConfigCategory ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta—Managed-Beta - deleted—Managed-Proposed-Deleted - deprecated—Managed-Proposed-Deprecated - deprecatedEditable—SecondGen-Installed-Deprecated - installed—Managed-Installed - installedEditable—SecondGen-Installed-Editable - released—Managed-Released - unmanaged—Unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the configuration assignment. In the UI, this field is **Label**. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. The prefix is limited to a maximum of 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. ### ParentConfigRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The configuration’s parent record. This field is a relationship field. - **Relationship Name**: ParentConfigRecord - **Relationship Type**: Lookup - **Refers To**: LifeSciConfigRecord ### Type - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the configuration. Type defines a relationship between related or similar configurations. # LifeSciDataChangeDef Represents the object for which the data change request is configured. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the configuration record for the data change request is active (true) or not (false). - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the data change definition value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. ### ObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The object associated with the data change definition. - **Possible values**: - Account - BusinessLicense—Business License - ContactPointAddress—Contact Point Address - ContactPointEmail—Contact Point Email - ContactPointPhone—Contact Point Phone - ContactPointSocial—Contact Point Social - HealthcareProvider—Healthcare Provider - Identifier - ProviderAffiliation—Provider Affiliation # LifeSciDataChangeRequest Represents the data change requests for the all objects. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The comments added by the user. The comments are included in the external validation request. ### DataChangeInformation - **Type**: textarea - **Properties**: Create, Update - **Description**: The information related to the old and the new data change in JSON format. ### DataChangeRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record identifier for the related data change, for example, Account Id and Account Address Id. ### DataChgExtlRecIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external identifier of the source record for which the data change request was created. ### ExternalValidationSysName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the system used for external validation, for example, OneKey and LEXI. ### ExtlValidationReqIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the identifier of the data change validation received from an external system. ### ExtlValidationSysResponse - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The response received for an external data change request validation. ### FailureReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The exception messages for an unsuccessful create or update action. Also, stores the exception message for a failed request to an external system. ### IsNewRecApprovalRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the data change request for a new restricted record requires an approval (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### LifeSciDataChgRqstDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The data change definition record associated with the data change request. This field is a relationship field. - **Relationship Name**: LifeSciDataChgRqstDef - **Refers To**: LifeSciDataChangeDef ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the data change record. ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the change request is to update or create data. - **Possible values**: - Create - Update ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentDataChangeRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent data change request associated with the object. For example, this field stores the Account data change associated with the Affiliation data change request. This field is a relationship field. - **Relationship Name**: ParentDataChangeRequest - **Refers To**: LifeSciDataChangeRequest ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the status of a data change request. - **Possible values**: - Approved - Failed - NotProcessed—Not Processed - NotQualified—Not Qualified - Processed - Qualified - Rejected ### ValidationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the validation type is internal or external for the data change request. - **Possible values**: - External - Internal ## Associated Object This object has the following associated object. If the API version isn’t specified, it's available in the same API versions as this object. Otherwise, it's available in the specified API version and later. [LifeSciDataChangeRequestShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciDataChgDefMngFld Represents the fields for which the data change request is configured for all objects. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### CountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country associated with the object. This field is a relationship field. - **Relationship Name**: Country - **Refers To**: LifeSciCountry ### FieldApiName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of the data change request definition field. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### LifeSciDataChgDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The data change request definition associated with the object. This field is a relationship field. - **Relationship Name**: LifeSciDataChgDef - **Refers To**: LifeSciDataChangeDef ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The identifier assigned to the data change record by an external data source. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ShouldApplyChngImmediately - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether changes to this field must be applied immediately. - **Default value**: false ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### ValidationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the validation type for the data change request is internal or external. - **Possible values**: - External - Internal ## Associated Object This object has the following associated object. If the API version isn’t specified, it's available in the same API versions as this object. Otherwise, it's available in the specified API version and later. [LifeSciDataChgDefMngFldShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciDataChgDefRecType Represents the management of data validation for the object by record type. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ExternalValidationSysName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the system used for external validation, for example, OneKey and LEXI. ### IsNewRecApprovalRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the object record must be created only after the data change request is approved (true) or not (false). - **Default value**: false ### LifeSciDataChgRqstDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The data change definition associated with the object. This field is a relationship field. - **Relationship Name**: LifeSciDataChgRqstDef - **Relationship Type**: Master-detail - **Refers To**: LifeSciDataChangeDef (the master object) ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record type identifier for the validation system for the data change definition. This field is a relationship field. - **Relationship Name**: RecordType - **Refers To**: RecordType ### ValidationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the validation type is internal or external for the data change request. - **Possible values**: - External - Internal # LifeSciDataChgPersonaDef Represents the configuration of data updates for the object by persona. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ChangeUpdateType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the requested changes are applied immediately at the field level, to all managed fields, or if the changes don’t apply until the request is approved. - **Default value**: DoNotApplyChangesImmediately - **Possible values**: - ApplyChangesByField—Apply Changes By Field - ApplyChangesImmediately—Apply Changes Immediately - DoNotApplyChangesImmediately—Do Not Apply Changes Immediately ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the configuration record for the data change request is active (true) or not (false). - **Default value**: false ### LifeSciDataChgRqstDefId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The data change definition associated with the object. This field is a relationship field. - **Relationship Name**: LifeSciDataChgRqstDef - **Relationship Type**: Master-detail - **Refers To**: LifeSciDataChangeDef (the master object) ### ProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The user profile associated with the data change definition. This field is a relationship field. - **Relationship Name**: Profile - **Refers To**: Profile # LifeSciDocTemplateVersion Stores version-specific template information. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### FileIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Key of the file that's stored in Amazon s3. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether a template version is active. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeScienceDocumentTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The Life Science document template for which this version record is created. This field is a relationship field. - **Relationship Name**: LifeScienceDocumentTemplate - **Relationship Type**: Master-detail - **Refers To**: LifeScienceDocumentTemplate (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Life Science document template version. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### VersionNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Indicates which order template versions were loaded. # LifeSciEmailTemplate Represents a collection of pre-designed and approved email templates that end users send to healthcare professionals (HCPs). These templates help users create and send consistent, professional emails quickly and efficiently. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AttachmentObjectType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the parent objects associated with the record. To configure this field, add the Account picklist value. A sales representative selects which object-level attachments, such as Account, are available for the email template. The values configured for this field enable additional attachments from the selected objects to be included when sending the email. ### BccEmailIdList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A list of email addresses to include in the BCC list on emails sent from this template. ### CanAttachiCalendarFile - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an iCalendar (.ics) file is generated and attached to the email. - **Default value**: false ### CanSendPresentationLinks - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether sales representatives can share presentations as unique links in email content. - **Default value**: false ### CommunicationSubscriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the communication subscription associated with the email template. This field is a relationship field. - **Relationship Name**: CommunicationSubscription - **Refers To**: CommSubscription ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A brief description of the purpose or content of the email template. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the email template is no longer available for use by sales representatives. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The date when the email template becomes available for use by sales representatives. ### EmailInvitationActionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the type of action for which the template is used when sending invitations. - **Possible values**: - Cancel - Create - Update ### EmailInvitationContextType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the context in which the email template can be used, such as for provider visits. - **Possible values**: - ProviderVisit ### HasSendConsentAcknowledgement - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: When selected, allows the template to be used for sending customizable emails based on captured consent. Used for custom reporting. - **Default value**: false ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the email template is active or inactive. - **Default value**: false ### IsDefaultAutoEmailTemplate - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies whether this template is the default for sending invitations automatically. - **Default value**: false ### IsSubjectLineEditable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Allows the sender to modify the email subject before sending. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The title or name of the email template. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the product related to the email template. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ReplyToEmailAddress - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The email address where recipients can send replies. ### ReplyToType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of email address used for replies. Create these picklist values: - Sales Rep Email Address: Uses the sales representative's email address as the Reply to email in the delivered message. - Reply To Email Address: Uses the email address specified in the **Reply To Email Address** field instead of the sales representative's email. ### SenderEmailFieldApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the API name of custom fields that customers create to store the sender’s email address. Enables customers to use a predefined sender email for specific email templates, rather than using the sales representative's email. ### SenderType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the type of sender for the email. Create these picklist values: - Sales Rep Email Address: Uses the sales representative's email address as the sender. - Sender Email Field API Name: Uses the email address specified in the Sender Email Field API Name field instead of the sales representative's email. To configure this field, add picklist values to control the sender information used for email transactions created with this template. By default, the picklist includes "Sales Rep," but you can customize it by adding field API names that contain different sender email addresses. ### ShouldIgnoreEmailConsent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Ignores email consent preferences for this template and sends the email regardless of the recipient's opt-in status. - **Default value**: false ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### SurveyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links a survey to the email template. To add the survey invitation link to the email, populate the Account field in the Survey Invitation record. This field is a relationship field. - **Relationship Name**: Survey - **Refers To**: Survey ## 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. [LifeSciEmailTemplateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciEmailTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciEmailTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeSciEmailTemplate Methods These are the LifeSciEmailTemplate methods for Life Sciences Cloud. - **[createEmailTemplate(emailTemplateInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciEmailTemplate_createEmailTemplate.htm)** Create an email template with the provided metadata. - **[updateEmailTemplate(emailTemplateInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciEmailTemplate_updateEmailTemplate.htm)** Update an existing email template with the provided metadata. # LifeSciEmailTmplFragment Represents a collection of reusable components that can be inserted into email templates, allowing end users to create custom and modular emails tailored to their needs. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Provides a brief summary or explanation of the content and purpose of the fragment. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The title or name of the email template fragment. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ## 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. [LifeSciEmailTmplFragmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciEmailTmplFragmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciEmailTmplFragmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciEmailTmplFragmentShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciEmailTmplRelaFrgmt Represents the connectors that link email templates and fragments together. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeSciEmailTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates which life science email template is associated with the record. This field is a relationship field. - **Relationship Name**: LifeSciEmailTemplate - **Relationship Type**: Master-detail - **Refers To**: LifeSciEmailTemplate (the detail object) ### LifeSciEmailTmplFragmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates which life science email template fragment is associated with the record. This field is a relationship field. - **Relationship Name**: LifeSciEmailTmplFragment - **Relationship Type**: Master-detail - **Refers To**: LifeSciEmailTmplFragment (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. An automatically generated unique identifier for the record in the format ETF-{0000000000}. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ## 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. [LifeSciEmailTmplRelaFrgmtChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciEmailTmplRelaFrgmtFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciEmailTmplRelaFrgmtHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeSciEmailTmplSnapshot Stores the different versions of an email template for tracking purposes. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ActivatedDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The date when the template version is activated. Template version becomes active immediately after uploading. ### CalendarFileDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description to include in the .ics attachment that's sent with the email. ### DeactivatedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the template version is deactivated. The template version becomes inactive when a new version is uploaded. ### EmailBody - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The body of the email template, when the email is an invitation. ### EmailSubject - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The email subject. ### EmailTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The related email template. This field is a relationship field. - **Relationship Name**: EmailTemplate - **Relationship Type**: Master-detail - **Refers To**: LifeSciEmailTemplate (the master object) ### FileIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique key that identifies email templates files for retrieval when stored in Content Document records. ### FileName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The email template .zip file name. ### Language - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The combined language and locale ISO code, which controls the language of the LifeSciEmailTmplSnapshot. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. An automatically generated unique identifier for the record in the format ET-{0000000000}. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Determines if the email template version is active or inactive. - **Possible values**: - Active - Inactive ### VersionNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The version of the email template. ## 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. [LifeSciEmailTmplSnapshotChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciEmailTmplSnapshotFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciEmailTmplSnapshotHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeScienceAccountList Represents the type of account lists, such as filter, static list, and routine. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() LifeScienceAccountList isn't available in the Object Manager and can't be customized. ## Fields ### CurrentTimeZone - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The timezone of the user who creates or updates a route. ### IsMultiDayRoute - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the end date of the route is later than the start date, and the duration is more than a day (true) or not (false). - **Default value**: false ### IsRoute - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a set of visits for the provider accounts is a Route to be reused to quickly reschedule visits (true) or not (false). - **Default value**: false ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Life Science Account list. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ReportIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the report associated with the advanced filter. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which the data is loaded into the object. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of the Life Science account list. - **Possible values**: - AdvancedFilter—Advanced Filter - Filter - List ## Associated Object This object has the following associated object. If the API version isn’t specified, it's available in the same API versions as this object. Otherwise, it's available in the specified API version and later. [LifeScienceAccountListShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeScienceAccountListObject Represents the object that is referenced in the provider account list. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() LifeScienceAccountListObject isn't available in the Object Manager and can't be customized. ## Fields ### LifeScienceAccountListId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Stores the provider account list which is of filter Type. This field is a relationship field. - **Relationship Name**: LifeScienceAccountList - **Relationship Type**: Master-detail - **Refers To**: LifeScienceAccountList (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the Life Science Account List object. ### ObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Stores the information about the object used in the filter. - **Possible values**: - Account - ContactPointAddress —Contact Point Address - ProviderAcctProductInfo—Provider Account Product Information - ProviderAcctTerritoryInfo—Provider Account Territory Information ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. # LifeScienceCustomScript Represents a custom script associated with a Life Science stage object within a workflow. Use a custom script to implement the validation logic for the stage object. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CodeText - **Type**: textarea - **Properties**: Nillable - **Description**: The JavaScript code associated with a Lightning web component. ### ComponentName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The name of the Lightning web component that contains the custom script. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Life Science custom script record. ### ObjectName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: For a Mobile Page Layout Validation script, the name of the object associated with the custom script. ### OperationEventType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: For a Mobile Page Layout Validation script, the type of operation that the custom script supports. - **Possible values**: - OnCreate - OnDelete - OnUpdate ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The type of custom script. - **Possible values**: - Checklist - MobilePageLayoutDataValidation - OrderValidation - Validation ## 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. [LifeScienceCustomScriptShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeScienceDocument Represents a signed document and stores document fields. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account for which the document is created. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the life science document. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeSciDocTemplateVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Indicates the document template version that was used to generate this document. This field is a relationship field. - **Relationship Name**: LifeSciDocTemplateVersion - **Refers To**: LifeSciDocTemplateVersion ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the Life Science document. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RelatedObjectRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related record for the document. This field is a polymorphic relationship field. - **Relationship Name**: RelatedObjectRecord - **Refers To**: AccountPlan, ProviderVisit ### SignatureGeolc - **Type**: location - **Properties**: Nillable - **Description**: The Location where the document was signed. ### SignatureGeolcLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude where the document was signed. ### SignatureGeolcLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude where the document was signed. ### SignatureGeolcMissingReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The reason why location retrieve failed. - **Possible values**: - DeviceRestricted - Offline - UserRestricted ### SignatureGeolcTimestamp - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last time when location was acquired. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The status of the document. - **Possible values**: - Draft - Submitted ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The type of the document. # LifeScienceDocumentTemplate Stores the template name and general information about the template. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AvailableObjectType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Determines where the template is shown for document generation. - **Possible values**: - Account - AccountPlan - Call ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Document template description. ### DocumentRecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Record Type used for LifeScienceDocument records created from this template. This field is a relationship field. - **Relationship Name**: DocumentRecordType - **Refers To**: RecordType ### DocumentTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. This field is unique within your organization. This field is a relationship field. - **Relationship Name**: DocumentTemplate - **Refers To**: DocumentTemplate ### FilterTypes - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Targets the document template to specific accounts or segments. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the Life Science document template. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SignatureType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Signature type for a template. - **Possible values**: - Electronic - Physical ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. # LifeScienceEmail Represents a collection of sendable messages that manages the creation, sending, and tracking of email communications. This object stores the details of each email, including the content, the status of sending attempts, and any responses received. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AttachmentIdentifiers - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A semicolon-separated list of IDs for attachments that need to be sent with the email transaction. This denormalized field displays the attachment names from the content document, allowing for additional attachments to be tracked and sent along with the email. ### AttachmentNames - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A list of attachment names that were selected for the email template. This is a denormalized field (simplified view) that pulls data from the content document to display the names of the attachments included with the email. ### BccEmailAddressList - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A list of email addresses in .csv format that are copied from the email template and included in the bcc field of the email. ### BodyAttachmentIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Stores the Salesforce ID of the standard attachment or content version record that contains the formatted content of the email body. This ensures the email body is properly linked and formatted when the email is sent. ### BouncedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the email is marked as bounced, indicating that it couldn’t be delivered to the recipient. ### BouncedReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the email bounced, providing insight into the delivery failure (for example, invalid email address, mailbox full, or server issues). ### CancelledDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the email is canceled. ### CcEmailAddressList - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A list of email addresses to be included in the cc field when sending the email. These recipients will receive a copy of the email but aren’t the primary recipients. ### CommSubscriptionConsentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links the email transaction to the consent record that indicates whether the recipient opted into or out of receiving emails. This field is a relationship field. - **Relationship Name**: CommSubscriptionConsent - **Refers To**: CommSubscriptionConsent ### EmailLanguage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the language in which the linked email template is written. ### EmailStatus - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Displays the status of the email based on recipient actions or system updates (Sent, Scheduled, Cancelled, Opened, Bounced). This field is a calculated field. ### EmailTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links the email transaction to the related email template used for the communication. This field is a relationship field. - **Relationship Name**: EmailTemplate - **Refers To**: LifeSciEmailTemplate ### ErrorMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The error message generated if there was an issue sending the email. ### FailedAttemptCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of failed attempts made to send the email. ### FirstOpenedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the email is first opened by the recipient. ### FromUserEmailAddress - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user email address from which the email is sent. If you use an org-wide email address, emails are sent from that address instead. ### IsBounced - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an email has bounced. - **Default value**: false ### IsConsentIgnored - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that recipient consent preferences are ignored when the email is sent. - **Default value**: false ### IsHtmlBody - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Required. Indicates whether the email body is in HTML format. - **Default value**: false ### LastEventDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the status information related to the email was last updated. ### LastOpenedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the email is last opened by the recipient. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. An automatically generated unique identifier for the record in the format ET-{0000000000}. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PresentationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links the email transaction to a specific presentation that the sales representative attaches as an email attachment. This field stores the reference to the presentation that must be included in the email as an attachment, ensuring the correct presentation is sent with the email. This field is a relationship field. - **Relationship Name**: Presentation - **Refers To**: Presentation ### ResponseStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Tracks the recipient's response to an RSVP request from the .ics (iCalendar) tracking service. - **Possible values**: - Accepted - Declined - Tentative ### ScheduledDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when the email is scheduled to be sent. This allows the email to be delivered at the most appropriate or strategic timing, ensuring better engagement and relevance for the recipient. ### SenderEmailAddress - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field stores the final sender's email address after evaluating different possible sources. It can be either the user's email or an organization-wide email address, depending on the scenario. Unlike FromEmail, which might be directly associated with the individual user, SenderEmailAddress can be a standard organizational email (for example, no-reply) if configured. ### SenderTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links to the territory of the user who sent the email. This field is a relationship field. - **Relationship Name**: SenderTerritory - **Refers To**: Territory2 ### SenderUserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links to the user who sent the email. This field tracks the specific individual responsible for sending the email. This field is a relationship field. - **Relationship Name**: SenderUser - **Refers To**: User ### SenderUserName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the final sender's name after evaluating various potential sources. The value is determined based on the FromUser and the email settings, and is populated in the system code (EmailQueueSenderHandler.cls). The sender’s name can be derived from either the user’s details or an organization-wide email configuration, depending on the email context. ### SentDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The exact date and time when the email was sent. ### SentToContactPointEmailId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact point email address that the email was sent to. Derived from the associated contact point email (ContactPointEmail object). Opt information is derived from the associated communication subscription consent (CommSubscriptionConsent object). This field is a relationship field. - **Relationship Name**: SentToContactPointEmail - **Refers To**: ContactPointEmail ### SentToEmailAddress - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The email address where the email is sent. This field captures the recipient's email address. For automated emails, the recipient's email is stored in this field. ### SourceReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A polymorphic lookup field that links the email transaction to a specific record from various objects, such as Provider Visit or Task. This allows the email transaction to be associated with the relevant event or task, providing context and traceability for the communication. This field is a polymorphic relationship field. - **Relationship Name**: SourceReferenceRecord - **Refers To**: DigitalSignatureRequest, ProviderVisit, Task ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Indicates the status of the email request. - **Possible values**: - Cancelled - Failed - New - Preparing - Retry - Success ### SubjectText - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The subject line of the email, providing a summary of the content or purpose of the message. The subject is visible to recipients in their inbox. ### ToAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. A reference to the account as the message recipient. This field is a relationship field. - **Relationship Name**: ToAccount - **Refers To**: Account ### ToContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that references the contact as the email recipient. This field is necessary to track recipient-specific events, such as bounced emails, based on the contact’s information. This field is a relationship field. - **Relationship Name**: ToContact - **Refers To**: Contact ### UrgencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the urgency of the email, determining when it should be sent. - **Possible values**: - Immediate - Scheduled ## 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. [LifeScienceEmailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeScienceEmailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeScienceEmailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeScienceEmailShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeScienceEmailFragment Represents a record of an email template fragment that a user selected and included in a sent life science email, capturing the content version at send time. This object is available in API version 68.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ContentVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The content version record that stores the content of the fragment the user selected and inserted into the email. This field is a relationship field. - **Relationship Name**: ContentVersion - **Refers To**: ContentVersion ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate is not null, the user accessed this record or list view indirectly. ### LifeSciEmailTmplFragmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The fragment that the user selected and inserted into the email. This field is a relationship field. - **Relationship Name**: LifeSciEmailTmplFragment - **Refers To**: LifeSciEmailTmplFragment ### LifeScienceEmailId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The sent email that contains the fragment the user selected. This field is a relationship field. - **Relationship Name**: LifeScienceEmail - **Relationship Type**: Master-detail - **Refers To**: LifeScienceEmail (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An automatically generated unique identifier for the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ## 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. [LifeScienceEmailFragmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeScienceEmailFragmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeScienceMobileApp Represents information about a mobile device associated with a user. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApplicationVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the mobile app. ### DeviceLastLocation - **Type**: location - **Properties**: Nillable - **Description**: The latitude and longitude coordinates of the most recent sync location. ### DeviceMetadataVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the metadata that's used by the mobile app. ### IsDownloadSyncSuccessful - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the most recent download succeeded (true) or not (false). - **Default value**: false ### IsFullSyncEnforced - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to force a full synchronization for the mobile app (true) or not (false). - **Default value**: false ### IsUploadSyncSuccessful - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the most recent upload succeeded (true) or not (false). - **Default value**: false ### LastDownloadSyncDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp of the most recent download. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastUploadSyncDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The timestamp of the most recent upload. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the mobile app record. ### UserDeviceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The user device associated with the mobile app. This field is a relationship field. - **Relationship Name**: UserDevice - **Relationship Type**: Master-detail - **Refers To**: UserDevice (the master object) ## 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. [LifeScienceMobileAppFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeScienceMobileAppHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeScienceTriggerHandler Represents a collection of fields to set up the trigger handlers to run for each Life Sciences object. This object is available in API version 65.0 and later. ## Supported Calls create(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: Describes the behavior of the concrete trigger handler. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the trigger handler is active (true) or not (false). - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language used in the trigger handler. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for this object value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix with a 15 character limit. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. - **Possible values**: The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. NamespacePrefix is null if the publisher is Salesforce. ### ObjectApiName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the object associated with the handler. # LifeSciMarketableProduct Represents information about all products a Life Science company manufactures, markets, sells, or competes with, including brands, indications, and therapeutic areas. It also represents additional information on physical products that are sampled, ordered, or distributed as promotional items. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BoxQuantityInner - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of product units within each pack inside a box. ### BoxQuantityOuter - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of product units inside a box. ### BusinessGroup - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the business group within which a product is marketed. ### DefaultDistributionQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the default quantity of the product that is distributed. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the product. ### DistributionMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the way in which a product is distributed to a provider. - **Possible values**: - Drop - DropAndShip - Ship ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the product expires. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is active (true) or not (false). - **Default value**: false ### IsAvlForSamplingAllocation - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is available to be allocated for sampling to healthcare providers (true) or not (false). - **Default value**: false ### IsCompetitorProduct - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the life sciences marketable product is a competitor product (true) or not (false). - **Default value**: false ### IsControlledSubstance - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a product is classified as a controlled substance (true) or not (false). - **Default value**: false ### IsMsgReqdForProvVisit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether at least one product guidance message is required when the product is being detailed to a healthcare provider during a visit (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### LaunchDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the product is available on the market. For example, the date a product is available for sampling to healthcare providers. ### Manufacturer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the company that manufactures the product. ### MaxSampleOrderQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum quantity of a sample that can be ordered. ### MinSampleOrderQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum quantity of a sample that can be ordered. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the life sciences marketable product. ### NationalDrugCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The National Drug Code of the Product. This value is a unique identifier, typically defined by a government authority. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentBrandProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent product of type Brand that the life science marketable product belongs to. Populate this field to make the product visible in the Samples, Direct to Practitioner, and Marketing Items sections of the Visit Engagement page. Products without a parent Brand product don't appear in those sections during a visit. This field is a relationship field. - **Relationship Name**: ParentBrandProduct - **Refers To**: LifeSciMarketableProduct ### ParentIndicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The indication associated with the parent brand product within the product hierarchy. This field links a Brand-Indication to its parent indication. This field is a relationship field. - **Relationship Name**: ParentIndication - **Refers To**: LifeSciMarketableProduct ### ParentProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent product that the life science marketable product belongs to. This field is a relationship field. - **Relationship Name**: ParentProduct - **Refers To**: LifeSciMarketableProduct ### ParentTherapeuticAreaId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The indication associated with the parent brand product within the product hierarchy. This field links products to a parent therapeutic area. This field is a relationship field. - **Relationship Name**: ParentTherapeuticArea - **Refers To**: LifeSciMarketableProduct ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product code, which is typically an abbreviated version of the product name. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product associated with the life sciences marketable product. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductMetadata - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional information about related products that are not aligned to a specific territory. This field helps in identifying on-label and off-label discussions. ### ProductSpecificationType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Represents the type of specification that is being created. ### ProductionCost - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The cost incurred by the manufacturer to produce the product. ### SignatureRequirementLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the product's signature requirement discussed with a healthcare provider during a visit. - **Possible values**: - Mandatory - NotRequired - Optional ### SortOrder - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The default sort order for products. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the product is valid. ### StateDstrLicenseCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the State Distributor License (SDL) category of the product. - **Possible values**: - CategoryII - CategoryIII ### TherapeuticArea - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the therapeutic area for which the product is intended, such as cardiology or dermatology. ### TherapeuticClass - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the therapeutic class for which the product is intended, such as narcotics or pain relief. This value is determined by the therapeutic area. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the life sciences marketable product. - **Possible values**: - Brand - BrandIndication - Indication - Market - Product - TherapeuticArea ## 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. [LifeSciMarketableProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciMarketableProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMarketableProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciMarketableProductShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciMetadataAssignment Represents the assignments for a Life Sciences configuration record. This object is a child of LifeSciMetadataRecord. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignedToId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The profile or user associated with the record. This field is a polymorphic relationship field. - **Relationship Name**: AssignedTo - **Relationship Type**: Lookup - **Refers To**: Profile, User ### AssignmentApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Required. The API name of the assignment record. ### AssignmentLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies the level of the assignment. - **Possible values**: - Profile - User ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeSciMetadataRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The configuration record associated with the assignment. This field is a relationship field. - **Relationship Name**: LifeSciMetadataRecord - **Relationship Type**: Master-detail - **Refers To**: LifeSciMetadataRecord (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the assignment record. ## 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. [LifeSciMetadataAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for tracked fields of the object. [LifeSciMetadataAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeSciMetadataCategory Represents the category that Life Sciences configuration records are organized into. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The category used to organize the Life Sciences configuration records. - **Possible values**: - AccountDynamicListConfiguration - AccountFilterConfig - AccountListActions - AccountSearchPreferences - ActivityPlanJob - EmailSettings - ExternalSearchSettings - InventoryManagementProfileSettings - PresentationSettings - ProviderVisitSettings - SampleLimitSettings ### CategoryLabel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The custom label for the category. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the category record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The category type. - **Possible values**: - Hierarchical - List ## 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. [LifeSciMetadataCategoryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMetadataCategoryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciMetadataCategoryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciMetadataFieldValue Represents a field value for a Life Sciences configuration record. This object is a child of LifeSciMetadataRecord. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DataType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The data type of the field. - **Possible values**: - BOOLEAN - DATE - DATETIME - DOUBLE - FIELD - LONGTEXT - NUMBER - OBJECT - PHONE - PICKLIST - TEXT - URL ### DateTimeValue - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time value for the field. ### DateValue - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date value for the field. ### FieldName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The name of the field. ### FieldValueApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Required. The API name of the field value record. ### HasBooleanValue - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Boolean value of the field is true or false. - **Default value**: false ### IntegerValue - **Type**: long - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The integer value for the field. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeScienceMetadataRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The configuration record associated with the field value. This field is a relationship field. - **Relationship Name**: LifeScienceMetadataRecord - **Relationship Type**: Master-detail - **Refers To**: LifeSciMetadataRecord (the master object) ### LongTextValue - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The long text value for the field. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the field value record. ### NumberValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number value for the field. ### PhoneValue - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The phone value for the field. ### PicklistValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The picklist value for the field. ### TextValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The text value for the field. ### UrlValue - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL value for the field. ## 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. [LifeSciMetadataFieldValueFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMetadataFieldValueHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # LifeSciMetadataRecord Represents a configuration record for Life Sciences. This object is a child of LifeSciMetadataCategory. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the configuration is active (true) or not (false). - **Default value**: false ### IsOrgLevel - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the configuration applies to every user in the org (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeScienceMetadataCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The category associated with the configuration. This field is a relationship field. - **Relationship Name**: LifeScienceMetadataCategory - **Relationship Type**: Lookup - **Refers To**: LifeSciMetadataCategory ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the configuration record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentMetadataRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The configuration’s parent record. This field is a relationship field. - **Relationship Name**: ParentMetadataRecord - **Relationship Type**: Lookup - **Refers To**: LifeSciMetadataRecord ### RecordApiName - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Required. The API name of the configuration record. ### Type - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the configuration. Type defines a relationship between related or similar configurations. ## 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. [LifeSciMetadataRecordFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMetadataRecordHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciMetadataRecordShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciMktProdtCodeSet Represents the relationship between a life science marketable product and a code set for a specific jurisdiction. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The schedule from the code set to which the jurisdiction and product apply. This field is a relationship field. - **Relationship Name**: CodeSet - **Refers To**: CodeSet ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the life science marketable product code set. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### Jurisdiction - **Type**: address - **Properties**: Filter, Nillable - **Description**: The compound form of the jurisdiction address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.api.meta/api/compound_fields_address.htm) for details on compound address fields. ### JurisdictionCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the jurisdiction to which the relationship applies. ### JurisdictionCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the jurisdiction to which the relationship applies. ### JurisdictionCountryCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The country code of the jurisdiction to which the relationship applies. ### JurisdictionGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The geocode accuracy of the jurisdiction to which the relationship applies. - **Possible values**: - Address - Block - City - County - ExtendedZip—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip ### JurisdictionLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude of the jurisdiction to which the relationship applies. ### JurisdictionLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude of the jurisdiction to which the relationship applies. ### JurisdictionPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the jurisdiction to which the relationship applies. ### JurisdictionState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the jurisdiction to which the relationship applies. ### JurisdictionStateCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The state code of the jurisdiction to which the relationship applies. ### JurisdictionStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street address of the jurisdiction to which the relationship applies. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### LifeSciMarketableProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The life science marketable product to which the jurisdiction and code set apply. This field is a relationship field. - **Relationship Name**: LifeSciMarketableProduct - **Relationship Type**: Master-detail - **Refers To**: LifeSciMarketableProduct (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the life science marketable product code set. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the life science marketable product code set. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ## 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. [LifeSciMktProdtCodeSetFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMktProdtCodeSetHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciMktProdtCodeSetShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciMobileMetadataRecord Represents the metadata created for the mobile application. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApplicationVersionName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the version name for the mobile application. ### ApplicationVersionNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the version number for the mobile application. ### ErrorLog - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the error log. ### IntegrationErrorCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the error code that occurs while intergation. ### IntegrationErrorMessage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the error message that occurs while intergation. ### IntegrationStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the status of the integration. - **Default value**: New - **Possible values**: - Error - New - Ok - Pending ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MetadataDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the content document associated with the metadata. This field is a relationship field. - **Relationship Name**: MetadataDocument - **Refers To**: ContentDocument ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the metadata. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentMobileMetadataRecId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the parent metadata. This field is a relationship field. - **Relationship Name**: ParentMobileMetadataRec - **Refers To**: LifeSciMobileMetadataRecord ### ProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the profile associated with metadata. This field is a relationship field. - **Relationship Name**: Profile - **Refers To**: Profile ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the system from which data is loaded into the object. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Represents the status of metadata. - **Default value**: New - **Possible values**: - Active - InProgress - Inactive - Loading - New - Processing - Published - Queued - Validating - Validated ### UpdateAvailableAlertDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the alert date to update the metadata. ### UpdateDueDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the due date to update the metadata. ## 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. [LifeSciMobileMetadataRecordFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [LifeSciMobileMetadataRecordHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [LifeSciMobileMetadataRecordShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciPresentation Methods These are the LifeSciPresentation methods for Life Sciences Cloud. - **[createPresentationContent(presentationContentInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciPresentation_createPresentationContent.htm)** Create new presentation content with the provided metadata. - **[updatePresentationContent(presentationContentInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciPresentation_updatePresentationContent.htm)** Update existing presentation content with the provided metadata. # LifeSciPresPageProductGuidance Methods These are the LifeSciPresPageProductGuidance methods for Life Sciences Cloud. - **[createPresPageProductGuidance(pageProductInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciPresPageGuidance_createProductGuidance.htm)** Create a new association between products and guidance with a presentation page. - **[deletePresPageProductGuidance(pageProductInput)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_LifeSciPresPageGuidance_deleteProductGuidance.htm)** Delete the association between a presentation page and products or guidances. # LifeSciProductAcctRstrc Represents information about product use limitations for an account. Product restrictions help facilitate compliance with product detailing and sampling regulations and company policies. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account to which the product restriction applies. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product account restriction. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product being restricted for an account. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory for which the restriction applies. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. [LifeSciProductAcctRstrcChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [LifeSciProductAcctRstrcShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciStageAction Represents the configuration of an action performed as part of a workflow. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### FieldApiName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field that the stage action operates on. ### FieldValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value to assign to the field specified for Field API Name. ### Label - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A custom label to display on the stage action button. ### LifeSciStageObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The stage object associated with the stage action. This field is a relationship field. - **Relationship Name**: LifeSciStageObject - **Relationship Type**: Lookup - **Refers To**: LifeSciStageObject ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage action record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Parameters - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional parameters that apply to the stage action. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The type of action performed. - **Possible values**: - Component - CustomAction - PlatformEvent - RecordUpdate ## 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. [LifeSciStageActionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciStageObject Represents an object associated with a workflow. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ChecklistCustomScriptId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The custom script that provides a checklist. This field is a relationship field. - **Relationship Name**: ChecklistCustomScript - **Relationship Type**: Lookup - **Refers To**: LifeScienceCustomScript ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the object. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### IsControlledByStagePath - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the object permissions are determined by a stage path (true) or not (false). - **Default value**: false ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage object. ### ObjectName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The object associated with the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentObjRelaFieldName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field that links the object to a parent object. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### ValidationCustomScriptId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The custom script that enforces validation rules. This field is a relationship field. - **Relationship Name**: ValidationCustomScript - **Relationship Type**: Lookup - **Refers To**: LifeScienceCustomScript ## 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. [LifeSciStageObjectShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # LifeSciStageOperation Represents the criteria to evaluate in determining the applicable permissions and available actions for a specific step in a workflow. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CanCreate - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user can create a record for the object associated with the workflow (true) or not (false) based on the evaluation of condition operations. - **Default value**: false ### CanDelete - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user can delete an existing record for the object associated with the workflow (true) or not (false) based on the evaluation of condition operations. - **Default value**: false ### CanEdit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user can edit an existing record for the object associated with the workflow (true) or not (false) based on the evaluation of condition operations. - **Default value**: false ### CompoundRelationshipName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the object that the stage operation is configured for. For example, Attachment for an operation that applies to attachment records. ### LifeSciStageObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The stage object associated with the stage path. This field is a relationship field. - **Relationship Name**: LifeSciStageObject - **Relationship Type**: Lookup - **Refers To**: LifeSciStageObject ### LifeSciStageValueId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The value of the stage path associated with the stage operation. This field is a relationship field. - **Relationship Name**: LifeSciStageValue - **Relationship Type**: Master-detail - **Refers To**: LifeSciStageValue (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage operation record. ### ParentStageOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the parent stage operation that this stage operation is a child of. This field is a relationship field. - **Relationship Name**: ParentStageOperation - **Relationship Type**: Lookup - **Refers To**: LifeSciStageOperation ### Priority - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the stage operation in relation to other stage operations that can apply. A Priority of 1 indicates this operation is applied first. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of the stage operation record. - **Possible values**: - CompoundRelationship - WorkflowPath # LifeSciStageOperationAction Represents a junction between a stage operation and a stage action. This object defines a set of available stage actions in the context of a specific stage operation. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DisplayOrder - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The order in which the stage operation action is displayed within the list of available stage operation actions. ### LifeSciStageActionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The stage action that the stage operation action is configured for. This field is a relationship field. - **Relationship Name**: LifeSciStageAction - **Relationship Type**: Lookup - **Refers To**: LifeSciStageAction ### LifeSciStageOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The stage operation associated with the stage operation action. This field is a relationship field. - **Relationship Name**: LifeSciStageOperation - **Relationship Type**: Master-detail - **Refers To**: LifeSciStageOperation (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage operation action record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. # LifeSciStageOperationCondn Represents a logical expression for applying an operation in a workflow. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LifeSciStageOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The stage operation associated with the stage operation condition. This field is a relationship field. - **Relationship Name**: LifeSciStageOperation - **Relationship Type**: Master-detail - **Refers To**: LifeSciStageOperation (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage operation condition record. ### ObjectFieldName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The field to evaluate. ### ObjectFieldValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value evaluated by the condition. ### Operator - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The operator for the condition. - **Possible values**: - Equals - EqualsNull - In - NotEquals - NotEqualsNull - NotIn ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. # LifeSciStagePath Represents information about the steps associated with a workflow and the path from one step in the workflow to the next. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### FieldApiName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The field that specifies the steps in a workflow. This field tracks a record’s progress through a workflow. ### LifeSciStageObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The stage object associated with the stage path. This field is a relationship field. - **Relationship Name**: LifeSciStageObject - **Relationship Type**: Master-detail - **Refers To**: LifeSciStageObject (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage path record. ### Parameters - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional parameters in JSON format. ### ScopeType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The scope of the stage path. Specifies how the stage path applies to stage object records. - **Default value**: Default - **Possible values**: - Default—The stage path applies to all stage object records automatically. - Explicit—The stage path applies only to records that are explicitly assigned. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### StageObjectRecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record type associated with the stage path. This field is a relationship field. - **Relationship Name**: StageObjectRecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. The status of the stage path. - **Default value**: Active - **Possible values**: - Active - Inactive # LifeSciStageValue Represents an individual step within a workflow. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### FieldValue - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. A specific step in a workflow. This value corresponds to a field value in the related stage path's Field API Name field. ### LifeSciStagePathId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The stage path associated with the stage value. This field is a relationship field. - **Relationship Name**: LifeSciStagePath - **Relationship Type**: Master-detail - **Refers To**: LifeSciStagePath (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The name of the stage value record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. # Lists and Filters Quickly identify a target group of accounts by using Lists and Filters. Static lists are manually-curated lists of accounts that remain fixed. Users can add or remove accounts individually. Dynamic filters apply to a list of accounts that updates based on user pre-defined criteria, and show sortable relevant fields that users add. By using dynamic filters, users can quickly associate the group of accounts with tailored actions, saving time and efforts by removing the need for repetitive manual updates. Lists and Filters streamline workflows by enabling users to identify, interact with, and act on relevant accounts. ![Lists and Filters entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_lists_and_filters_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/lists-and-filters.html "HTML (New Window)"). ## Lists and Filters Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Life Science Account List](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceaccountlist.htm) - [Life Science Account List Column](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciaccountlistcolumn.htm) - [Life Science Account List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctlistfiltercrit.htm) - [Life Science Account List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciaccountlistmember.htm) - [Life Science Account List Object](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceaccountlistobject.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Location Standard and custom fields extend the standard Location object to represent information about a user responsible for the location. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: Location](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_location.htm) ## Fields ### PrimaryUserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the primary user responsible for the location. This field is a relationship field. - **Relationship Name**: PrimaryUser - **Refers To**: User # Location The Location FHIR resource maps to the Healthcare​Facility and Location objects in Salesforce​. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## FHIR V4​.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [Location](https://www.hl7.org/fhir/location.html) map to the fields in the Salesforce​.
Table 1. Location - Salesforce
Location Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for a facility is represented as Identifier records that reference the facility record using their Identifier​.Parent​RecordId field​.
status Account​.IsActive Boolean 0​.1 While FHIR defines location​.status as a code, the salesforce implementation is a boolean field in the referenced account record​.
operational​Status N/A N/A N/A Not supported
name Healthcare​Facility​.Name String 0​.1 N/A
alias N/A N/A N/A Not supported
description Location​.Description String 0​.1 N/A
mode N/A N/A N/A Not supported
type Healthcare​Facility​.​Facility​TypeId Lookup: CodeSet​Bundle 0​.1 While FHIR defines location​.type as a zero-to-many resource, Salesforce implements Healthcare​Facility​.​Facility​TypeId as a zero-to-one field​.
telecom Contact​Point​Phone Object 0​.M The telecom information of the facility is stored as Contact​Point​Phone records that reference the account referenced by the facility record​.
address Contact​Point​Address Object 0​.M The address information of the facility is stored as Contact​Point​Address records that reference the account referenced by the facility record​.
physical​Type Healthcare​Facility​.Location​Type Picklist 0​.1 While FHIR defines location​.physical​Type as a code set bundle, Salesforce implements Healthcare​Facility​.Location​Type as a picklist​.
position Location​.Location Geolocation 0​.1

The location​.position FHIR resource is mapped to the Location​.Location salesforce field​. This location (Salesforce object) record is referenced by the healthcare facility record using its Healthcare​Facility​.LocationId lookup field​.

position​.altitude is not supported in Location​.Location​.

managing​Organization Account​Account​Relation__c Junction Object 0​.1 The junction object that connects the facility account with the parent organization’s business account​.
partOf Healthcare​Facility​.Parent​FacilityId Lookup: Healthcare​Facility 0​.1 N/A
hoursOf​Operation​.daysOf​Week ​TimeSlot​.DayOf​Week Picklist 0​.1

While FHIR defines location​.hoursOf​Operation​.daysOf​Week as a code set bundle, Salesforce implementation is a picklist​.

While the ​TimeSlot​.DayOf​Week field is a zero-to-one field, multiple time slot records can reference the same operating hours record, thereby supporting a zero-to-many reference for location​.hoursOf​Operation​.daysOf​Week in the Salesforce implementation​.

The time slot record references the operating hours record using its ​TimeSlot​.Operating​HoursId master-detail reference field​. This operating hours record is referenced by the facility’s account record using its Account​.Operating​HoursId lookup field​. And finally, this account record is referenced by the facility record using its Healthcare​Facility​.AccountId master-detail reference field​.
hoursOf​Operation​.allDay N/A N/A N/A Not supported
hoursOf​Operation​.opening​​Time ​TimeSlot​.Start​​Time ​Time 0​.1

The time slot record references the operating hours record using its ​TimeSlot​.Operating​HoursId master-detail reference field​. This operating hours record is referenced by the facility’s account record using its Account​.Operating​HoursId lookup field​. And finally, this account record is referenced by the facility record using its Healthcare​Facility​.AccountId master-detail reference field​.
hoursOf​Operation​.closing​Time ​TimeSlot​.​End​Time ​Time 0​.1

The time slot record references the operating hours record using its ​TimeSlot​.Operating​HoursId master-detail reference field​. This operating hours record is referenced by the facility’s account record using its Account​.Operating​HoursId lookup field​. And finally, this account record is referenced by the facility record using its Healthcare​Facility​.AccountId master-detail reference field​.
availability​Exceptions Healthcare​Facility​.Availability​Exceptions String 0​.1 N/A
end​Point N/A N/A N/A Not supported
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how the location resource for a location is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_location.png) #### See Also - [HealthcareFacility](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_HealthCareFacility.htm "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.") # 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 work seamlessly together enhancing their interoperability. The 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. - **[Considerations for Integration](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_considerations.htm)** The Salesforce implementation of FHIR resources differs from the FHIR specification. Built on the core Salesforce platform, the FHIR-aligned clinical data model comes with field mappings that help you integrate with the FHIR R4 specification. - **[Address](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Address.htm)** The Address FHIR resource maps to the Contact​Point​Address​ object in Salesforce. - **[AdverseEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_adverseevents.htm)** The AdverseEvent FHIR resource maps to the AdverseEvent objects in Salesforce. - **[Allergy​Intolerance](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_AllergyIntolerance.htm)** The allergy​Intolerance FHIR resource maps to the Allergy​Intolerance and PatientHealthReaction objects in Salesforce. - **[Annotation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_annotation.htm)** The Annotation FHIR resource maps to the AuthorNote​ object in Salesforce. - **[Attachment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Attachment.htm)** The Attachment FHIR resource maps to the Attachment object in Salesforce. - **[Care​Plan](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_careplan.htm)** The Care​Plan FHIR resource maps to the Care​Plan​, Care​PlanDetail​, Care​Plan​Activity, and Care​PlanActivityDetail​ objects in Salesforce. - **[Codeable​Concept](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_CodeableConcept.htm)** The Codeable​Concept FHIR resource maps to the CodeSet​BundleBundle object in Salesforce. - **[Coding](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Coding.htm)** The Coding FHIR resource maps to the CodeSet object in Salesforce. - **[CommunicationRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_communicationrequest.htm)** The CommunicationRequest FHIR resource maps to the TrackedCommunication and TrackedCommunicationDetail objects in Salesforce. - **[Condition](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Condition.htm)** The Condition FHIR resource maps to the Health​Condition object in Salesforce. - **[ContactPoint](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_ContactPoint.htm)** The ContactPoint FHIR resource maps to the Contact​Point​Phone​ object in Salesforce. - **[Device](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_device.htm)** The Device F​HI​R resource maps to the Asset and ​​Care​Registered​Device​ objects in Salesforce​. - **[DiagnosticReport](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_diagnosticReport.htm)** The diagnostic​Report FHIR resource maps to the Diagnostic​Summary​ object in Salesforce. - **[Document​Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_documentreference.htm)** The Document​Reference F​HI​R resource maps to the Diagnostic​Summary and Diagnostic​SummaryDetail objects in Salesforce​. - **[Dosage](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_dosage.htm)** The Dosage FHIR resource maps to the Patient​Medication​Dosage​ object in Salesforce. - **[Encounter](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Encounter.htm)** The Encounter F​HI​R resource maps to the ​​Clinical​Encounter​, ​​Clinical​Encounter​​Diagnosis, ​​Clinical​Encounter​​Facility, ​​Clinical​Encounter​Identifier, ​​Clinical​Encounter​​Provider, ​​Clinical​Encounter​​Reason, and ​​Clinical​Encounter​Svc​Request objects in Salesforce​. - **[EpisodeOfCare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_episodeofcare.htm)** The episodeOfCare FHIR resource maps to the Care​Episode​ and Care​EpisodeDetail​ objects in Salesforce. - **[​Flag](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Flag.htm)** The ​Flag ​FHI​R resource maps to the Clinical​Alert object in Salesforce​. - **[Goal](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_goal.htm)** The Goal FHIR resource maps to the Goal​Assignment​ and Goal​AssignmentDetail​ objects in Salesforce. - **[Human​Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_HumanName.htm)** The Human​Name FHIR resource maps to the Person​Name object in Salesforce​. - **[Identifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Identifier.htm)** The Identifier FHIR resource maps to the Identifier object in Salesforce. - **[​Immunization](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Immunization.htm)** The ​Immunization FHIR resource maps to the Patient​Immunization and PatientHealthReaction objects in Salesforce​. - **[InformationOrigin](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_informationorigin.htm)** The CRDMetricData FHIR resource maps to the AssessmentQuestionResponse object. - **[Location](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Location.htm)** The Location FHIR resource maps to the Healthcare​Facility and Location objects in Salesforce​. - **[​Medication](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Medication.htm)** The medication FHIR resource maps to the ​Medication object in Salesforce​. - **[​Medication​​Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_MedicationRequest.htm)** ​The ​Medication​​Request FH​I​R resource maps to the ​Medication​​Request object in ​Salesforce​. - **[Medication​Statement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_MedicationStatement.htm)** The medication​Statement FHIR resource maps to the Medication​Statement object in Salesforce​. - **[​Observation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_observation.htm)** The observation FHIR resource maps to the Care​Observation and Care​Observation​Component objects in Salesforce​. - **[Organization](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_organization.htm)** The Organization FHIR resource maps primarily to the Account object in Salesforce​. - **[Patient](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Patient.htm)** The Patient FHIR resource maps to the Account and Contact objects in Salesforce​. Patients are modeled using Person Accounts. - **[Practitioner](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_practitioner.htm)** The Practitioner FHIR resource maps to the HealthcareProvider object and person accounts in Salesforce​. - **[PractitionerRole](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_practitionerrole.htm)** The practitionerRole FHIR resource maps to the HealthcarePractitionerFacility and CareProviderFacilitySpecialty objects in Salesforce​. - **[​Procedure](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_Procedure.htm)** The procedure FHIR resource maps to the Patient​Medical​​Procedure and Patient​Medical​​Procedure​Detail objects in Salesforce​. - **[RelatedPerson](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_related_person.htm)** The relatedPerson FHIR resource maps to the Account and Contact objects in Salesforce, and is connected to the person that person’s related to using the ContactContactRelation\_\_c object​. - **[ResearchStudy](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_researchstudy.htm)** The ResearchStudy FHIR resource maps to the ResearchStudy objects in Salesforce. - **[Service​Request](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_ServiceRequest.htm)** The service​Request FH​IR resource maps to the Clinical​Service​Request and Clinical​Service​Request​Detail objects in Salesforce​. - **[Timing](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/map_fhir_timing.htm)** The Timing FHIR resource maps to the ActivityTiming​ object in Salesforce. #### See Also - [Clinical Data Model](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_clinical_data_model.htm "Patient data and healthcare records are important in the healthcare industry. Without accurate information, performing and managing care becomes difficult. These records are readily available if a patient seeks care from the same provider every time. However, in reality, a patient’s healthcare journey takes them to multiple providers and hospitals at different times. Because the patient’s health hinges on the accuracy of their medical records, it’s crucial for the systems used by different providers and hospitals to be interoperable. And to make this interoperability 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.") # Medical Director Name of the medical director who reviewed the request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | username | String | username | Big, 46.0 | 46.0 | # Medical Director Input Name of the medical director who reviewed the request. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | username | String | Medical Director’s username. | Yes | 46.0 | # Medical Inquiries Capture critical questions from healthcare professionals such as medical inquiries, adverse events, and product quality complaints with Medical Inquiries. Inquiries can come from multiple channels such as face-to-face visits, remote engagements, or contact centers. Inquiries require a quick and compliant response by the right individuals, typically medical experts like Medical Science Liaisons and Medical Communication Specialists. Medical Science Liaisons (MSLs) are skilled professionals who can answer scientific questions about drug details, interactions, off-label usage, and clinical product information. Medical Communication Specialists work in contact center environments and partner with MSLs to resolve inquiries, including incoming patient and consumer calls about product information, side effects, and adverse reactions. ![Medical Inquiries entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_medical_inquiries_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/medical-inquiries.html "HTML (New Window)"). ## Medical Inquiries Objects in Life Sciences Customer Engagement - [Case](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_case.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Contact Point Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointemail.htm) - [Contact Point Phone](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contactpointphone.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Inquiry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiry.htm) - [Inquiry Question](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiryquestion.htm) - [Inquiry Question Answer](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inquiryquestionanswer.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Medical Insights Use Medical Insights to gather information that can help uncover patient needs, validate concepts, evaluate scientific data, identify challenges faced by healthcare providers, understand geographical differences in patient care, and identify opportunities and threats. These insights play a crucial role in informing strategies across medical, clinical, and commercial aspects to enhance patient care. Users can capture Medical Insights from various sources such as meetings, calls, and research. They can also tag, vote, and link similar insights to identify and review trending insights. ![Medical Insights entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_medical_insights_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/medical-inquiries.html "HTML (New Window)"). ## Medical Insights Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Goal Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goalassignment.htm) - [Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_goaldefinition.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Medical Insight](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsight.htm) - [Medical Insight Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightaccount.htm) - [Medical Insight Goal Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightgoaldef.htm) - [Medical Insight Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_medicalinsightproduct.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Subject](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subject.htm) - [Subject Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_subjectassignment.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [User Reaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_userreaction.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # MedicalInsight Represents the important information observed or heard through various outlets like meetings, calls, or research, which is used to inform strategies for better patient care. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ChildMedicalInsightCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of similar insights that are associated with the medical insight. ### Content - **Type**: textarea - **Properties**: Create, Update - **Description**: The description of the medical insight. ### DefaultRank - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The default rank of the medical insight that's determined based on the total number of linked insights and their upvotes. ### GoalDefinitionCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of goals linked to the medical insight. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastUpvotedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when a user last upvoted the medical insight. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the medical insight record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentMedicalInsightId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent record associated with the medical insight. This field is a relationship field. - **Relationship Name**: ParentMedicalInsight - **Refers To**: MedicalInsight ### SourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the source of the medical insight. - **Possible values**: - Account - Home Page - Medical Insights Tab - Meeting - Visit ### TopicNames - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The names of the topics that are tagged to the medical insight. ### UpvoteCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of upvotes received for the medical insight. ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider visit associated with the medical insight. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Refers To**: Visit # MedicalInsightAccount Represents the account that provided the medical insight. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the medical insight. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### MedicalInsightId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medical insight associated with the account. This field is a relationship field. - **Relationship Name**: MedicalInsight - **Relationship Type**: Master-detail - **Refers To**: MedicalInsight (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medical insight account record. ### ReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for linking the account with the medical insight. # MedicalInsightGoalDef Represents the goal needed to address the medical insight. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### GoalDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The goal linked to the medical insight. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Refers To**: GoalDefinition ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MedicalInsightId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medical insight linked to the goal. This field is a relationship field. - **Relationship Name**: MedicalInsight - **Relationship Type**: Master-detail - **Refers To**: MedicalInsight (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medical insight goal definition record. # MedicalInsightProduct Represents the product related to the medical insight. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### DisplayName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The brand name of the product. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### MedicalInsightId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medical insight associated with the product. This field is a relationship field. - **Relationship Name**: MedicalInsight - **Relationship Type**: Master-detail - **Refers To**: MedicalInsight (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medical insight product record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product or life sciences marketable product associated with the medical insight. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 # Medication Represents detailed information about different medications. 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() ## Additional Information for Medication in Other Objects In addition to creating a record using these fields, you can add more details to your Medication record by creating records in certain other objects, and referencing your Medication record as the parent record. Here’s the list of objects you can associate to Medication in this way, the type of information they add, and the field they use to reference Medication. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the medication record. | ParentRecordId | | MedicinalIngredient | Adds information about the different ingredients used in the medication. | ParentRecordId | ## Fields ### BatchNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the batch number of the medication. ### BrandNameAlternative - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The branded alternative for a generic medication. This field is available in API version 56.0 and later. ### ExpirationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the expiration date of the medication. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### ManufacturerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The company that makes the medicine. - **Referenced Objects**: - Account ### MedicationCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of the medication. This field is available in API version 56.0 and later. - **Possible values**: - Branded Product - Generic Product - Innovator Product - Therapeutic Moeity ### MedicationCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that identifies a medication. - **Referenced Objects**: - CodeSetBundle ### MedicationFormId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code for the dosage form this medication is manufactured in. - **Referenced Objects**: - CodeSetBundle ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the medication. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns the medication record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product that's associated with the medication. This field is a relationship field. This field is available in API version 61.0 and later with the Manage Financial Assistance Program permission set. ### QuantityDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total volume of the medication contained in the packaged product. ### QuantityNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of the medication contained in the packaged product. ### QuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The measurement unit for the quantity. - **Referenced Objects**: - UnitOfMeasure ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed on the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the medication. - **Possible values**: - Active - Entered in error - Inactive ## 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. [MedicationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # ​Medication The medication FHIR resource maps to the ​Medication object in Salesforce​. ## FHIR V4​.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [medication](https://www.hl7.org/fhir/medication.html) map to the fields in Salesforce​. Table 1. medication - Salesforce | ​Medication Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.M | The identifier information for a medication is represented as Identifier records that reference the medication record using their Identifier​.Parent​RecordId field​. | | code | Medication​.​Medication​CodeId | Lookup: CodeSet​​Bundle | 0​.1 | N/A | | status | Medication​.​Status | Picklist | 1​.1 | While FHIR defines medication​.status as a code set bundle, the Salesforce implementation of Medication​.​Status is picklist​. | | manufacturer | Medication​.​ManufacturerId | Lookup: Account | 0​.1 | N/​A | | form | Medication​.Medication​FormId | Lookup: CodeSet​​Bundle | 0​.1 | N/A | | amount | Medication​.​Quantity​Numerator | Double | 0​.1 | Because Salesforce doesn’t support a native quantity data type, the medication.amount field is flattened into a set of numerator, denominator, and unit fields. | | amount | Medication​.​Quantity​Denominator | Double | 0​.1 | Because Salesforce doesn’t support a native quantity data type, the medication.amount field is flattened into a set of numerator, denominator, and unit fields. | | amount | Medication​.​Quantity​UnitId | Lookup: ​UnitOfMeasure | 0.1 | Because Salesforce doesn’t support a native quantity data type, the medication.amount field is flattened into a set of numerator, denominator, and unit fields. | | ingredient​.item | Medicinal​Ingredient​.IngredientId | Lookup: CodeSet​Bundle, Medication | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | ingredient​.isActive | Medicinal​Ingredient​.IsActive | Boolean | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | ingredient​.strength | Medicinal​Ingredient​.Strength​Numerator | Double | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | ingredient​.strength | Medicinal​Ingredient​.Strength​Numerator​UnitId | Lookup: UnitOfMeasure | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | ingredient​.strength | Medicinal​Ingredient​.Strength​Denominator | Double | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | ingredient​.strength | Medicinal​Ingredient​.Strength​Denominator​UnitId | Lookup: UnitOfMeasure | 0.1 | Zero-to-many value for medication.ingredient is implmeneted using the child object MedicinalIngredient. Each ingredient record references the parent Medication record using the ParentRecordId field. | | batch​.lotNumber | Medication​.Batch​Number | Int | 0.1 | N/A | | batch​.expiration​Date | Medication​.Expiration​DateTime | DateTime | 0.1 | N/A | #### See Also - [Medication](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_Medication.htm "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 the instructions for how the medication is to be administered This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for MedicationStatement in Other Objects In addition to creating a record using these fields, you can add more details to your MedicationDispense record by creating records in certain other objects, and referencing your MedicationDispense record as the parent record. Here’s the list of objects you can associate to MedicationStatement in this way, the type of information they add, and the field they use to reference MedicationStatement. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the medication dispense. | ParentRecordId | ## Fields ### CollectedBy - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact, account, or a healthcare provider who collected the dispensed medication. This field is available in API version 55.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: CollectedBy - **Relationship Type**: Lookup - **Refers To**: Account, Contact, HealthcareProvider ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter that establishes the context for the dispense of a medication. - **Refers To**: - ClinicalEncounter ### DeliveryLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the dispensed medication will be delivered. This field is available in API version 55.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: DeliveryLocation - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, Location ### DispenseTypeCodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that identifies the dispense event type. For instance, a first fill, trial fill, or refill. - **Refers To**: - CodeSet - CodeSetBundle ### DispensedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication was handed over. ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the dispense occurred. - **Refers To**: - HealthcareFacility ### IsSubstituted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a substitute medication was dispensed. This field is available in API version 55.0 and later. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### MedAdministrationSettingCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the setting in which the medication is expected to be administered to the patient. - **Possible values**: - Inpatient - Outpatient - Community - Discharge ### MedicationCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that identifies the medication that's dispensed. - **Refers To**: - CodeSet - CodeSetBundle ### MedicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication that's dispensed. - **Relationship Name**: Medication - **Relationship Type**: Lookup - **Refers To**: - Medication ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient for whom the medication is dispensed. - **Refers To**: - Account ### PreparedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication was prepared for dispense. ### PrimaryDetectedIssueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary clinical issue associated with the medication dispensation. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: PrimaryDetectedIssue - **Relationship Type**: Lookup - **Refers To**: ClinicalDetectedIssue ### PrimaryMedicationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary medication request that authorized the dispense of the medication. - **Refers To**: - MedicationRequest ### PrimaryProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary medical procedure associated with the medication dispensation. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: PrimaryProcedure - **Relationship Type**: Lookup - **Refers To**: PatientMedicalProcedure ### Quantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of medication that was dispensed. ### QuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the quantity of medication that was dispensed. - **Refers To**: - UnitOfMeasure ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record in its source system. ### SourceSystemModifiedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when this item was last changed in the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the dispense event. - **Possible values**: - Cancelled - Completed - Declined - Entered-In-Error - In-Progress - On-Hold - Preparation - Stopped - Unknown ### StatusReasonCodeId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason for the specified status. - **Refers To**: - CodeSet - CodeSetBundle ### StatusReasonRelatedIssueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies clinical issue that resulted in the status of the medication dispensation. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: StatusReasonRelatedIssue - **Relationship Type**: Lookup - **Refers To**: ClinicalDetectedIssue ### SubstitutedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the user or healthcare provider who substituted the medication. This field is available in API version 55.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: SubstitutedBy - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider, User ### SubstitutionReason - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the reason for substituting the medication. This field is available in API version 55.0 and later. - **Possible values**: - Continuing therapy - Formulary policy - Out of stock - Regulatory requirement ### SubstitutionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of substitution done for the medication. This field is available in API version 55.0 and later. - **Possible values**: - Brand composition - Equivalent - Equivalent composition - Formulary - Generic composition - None - Therapeutic alternative - Therapeutic brand - Therapeutic generic ### SupplyDaysCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of days that the dispensed supply is expected to last. ## 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. [MedicationDispenseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [MedicationDispenseFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MedicationDispenseHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # MedicationRequest Represents a request or order for the supply of medication, along with information about how it should be administered. 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() ## Additional Information for MedicationRequest in Other Objects In addition to creating a record using these fields, you can add more details to your MedicationRequest record by creating records in certain other objects, and referencing your MedicationRequest record as the parent record. Here’s the list of objects you can associate to MedicationRequest in this way, the type of information they add, and the field they use to reference MedicationRequest. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the medication request. | ParentRecordId | | PatientMedicationDosage | Associates dosage-related information for the medication in the medication request record. | ParentRecordId | ## Fields ### AllowedSubstitutionTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of substitution that's allowed. This field can’t be used if the CanSubstitute field is set to true. - **Referenced Objects**: - CodeSetBundle ### CanSubstitute - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether substitution is acceptable. If the value for this field is set to true, then the AllowedSubstitutionTypeCodeId field can’t be selected. ### CarePlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care plan related to this medication request. This field is a relationship field. - **Relationship Name**: CarePlan - **Relationship Type**: Lookup - **Referenced Objects**: - CarePlan ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the medication request. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter related to the medication request. - **Referenced Objects**: - ClinicalEncounter ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the service request related to the medication request. - **Referenced Objects**: - ClinicalServiceRequest ### DispenseInterval - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum interval required between refills. ### DispenseIntervalUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit for that interval. - **Referenced Objects**: - UnitOfMeasure ### DispenserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who provides the medication. - **Referenced Objects**: - Account ### FillDurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit for the fill duration. - **Referenced Objects**: - UnitOfMeasure ### FillQuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the fill quantity. - **Referenced Objects**: - UnitOfMeasure ### InitialFillDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The length of time the first fill is expected to last. ### InitialFillQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity to be filled in the first dispense. ### IsIgnored - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the request should be ignored. ### IsSecondaryInformation - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the request is based on information from a secondary source instead of a primary one. If this field is set to true, then the SecondarySourceId field can’t be selected. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MedicationAdministrationContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the setting in which the medication is administered. - **Referenced Objects**: - CodeSetBundle ### MedicationCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the medication requested. A record can select either a MedicationId or a MedicationCodeId, but not both. - **Referenced Objects**: - CodeSetBundle ### MedicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the medication record for the medicine requested. A record can select either a MedicationId or a MedicationCodeId, but not both. - **Referenced Objects**: - Medication ### MedicationRequestGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A shared identifier common to all medication requests that were authorized more or less simultaneously by a single author. - **Referenced Objects**: - Identifier ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the medication request record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the medication request record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Referenced Objects**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The person who needs the medicine. - **Referenced Objects**: - Account ### PerformerId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who administers the medicine. - **Referenced Objects**: - Account - HealthcareProvider - CareRegisteredDevice ### PerformerTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the performer's role. For instance, the cardiologist, neurosurgeon, and so on. - **Referenced Objects**: - CodeSetBundle ### PrescribedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and optionally the time when the prescription was initially written or authored on. ### PrescriptionPeriodEnd - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date for the prescription's validity. ### PrescriptionPeriodStart - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date for the prescription's validity. ### PreviousPrescriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to previous prescriptions. - **Referenced Objects**: - MedicationRequest ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the priority of the request. - **Possible values**: - ASAP - Routine - Stat - Urgent ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code for why the medicine was requested. - **Referenced Objects**: - CodeSetBundle ### ReasonReferenceId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the condition or observation that warranted this medicine. - **Referenced Objects**: - HealthCondition - CareObservation ### RefillDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: How long the refill is expected to last. ### RefillQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity in each refill. ### RefillsAllowed - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of refills that are allowed. ### RelatedRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A plan or request that is fulfilled in whole or in part by this medication request. - **Referenced Objects**: - MedicationRequest ### RequesterId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who raised the request. - **Referenced Objects**: - Account - HealthcareProvider - CareRegisteredDevice ### SecondarySourceId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the person who gave the information for the request. This field can’t be selected if the IsSecondarySource field is set to true. - **Referenced Objects**: - Account - HealthcareProvider ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the medication request. - **Possible values**: - Active - Cancelled - Completed - Draft - Entered-in-Error - On-Hold - Stopped - Unknown ### StatusReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason for the status. - **Referenced Objects**: - CodeSetBundle ### SubstitutionReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies why a substitution is required. - **Referenced Objects**: - CodeSetBundle ### TherapyDuration - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the overall pattern of the administration of the medication to the patient. For instance, Continuous, Acute, Seasonal. - **Possible values**: - Continuous - Seasonal - Short Term ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of the request. - **Possible values**: - Filler Order - Instance Order - Option - Order - Original Order - Plan - Proposal - Reflex Order ## 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. [MedicationRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [MedicationRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MedicationRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [MedicationRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [MedicationRequestShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # ​Medication​​Request ​The ​Medication​​Request FH​I​R resource maps to the ​Medication​​Request object in ​Salesforce​. ## FH​I​R V4​.0 - Clinical ​Data ​Model ​Mapping Here’s how the fields defined by FH​I​R for [​Medication​​Request](https://www.hl7.org/fhir/medicationrequest.html) map to the fields in ​Salesforce​. Table 1. ​Medication​​Request - ​Salesforce | ​Medication ​​Request ​Resource | ​Salesforce Field | ​Type | ​Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | ​Identifier | Object | 0​.​M | ​The identifier information for a medication request is represented as ​Identifier records that reference the ​Medication​​Request record using their ​Identifier​.​Parent​Record​Id field​. | | status | ​Medication​​Request​.​Status | ​Picklist | 1​.1 | While FH​I​R defines ​Medication​​Request​.status as a code set bundle, the ​Salesforce implementation of ​Medication​​Request​.​Status is picklist​. | | status​Reason | ​Medication​​Request​.​Status​Reason​Code​Id | Lookup: ​CodeSet​​Bundle | 0​.1 | N/​A | | intent | ​Medication​​Request​.​Type | ​Picklist | 1​.1 | While FH​I​R defines ​Medication​​Request​.intent as a code set bundle, the ​Salesforce implementation of ​Medication​​Request​.​Type is picklist​. | | category | ​Medication​​Request​.​Medication​Administration​Context​Id | Lookup: ​CodeSet​Bundle | 0​.1 | While FH​I​R defines ​Medication​​Request​.category as a zero-to-many resource, the ​Salesforce implementation is zero-to-one​. | | priority | ​Medication​​Request​.​Priority | ​Picklist | 0​.1 | While FH​I​R defines ​Medication​​Request​.priority as a code set bundle, the ​Salesforce implementation of ​Medication​​Request​.​Priority is picklist​. | | doNot​Perform | ​Medication​​Request​.​Is​Ignored | Boolean | 0​.1 | N/​A | | reported​.reported​Boolean | ​Medication​​Request​.​Is​Secondary​Information | Boolean | 0​.1 | N/​A | | reported​.reported​Reference | ​Medication​​Request​.​Secondary​Source​Id | ​Polymorphic Lookup: ​Account, Healthcare​Provider | 0​.1 | N/​A | | medication​.medication​Codeable​Concept | ​Medication​​Request​.​Medication​Code​Id | Lookup: ​CodeSet​Bundle | 0​.1 | While the individual fields ​Medication​​Request​.​Medication​Code​Id and ​Medication​​Request​.​Medication​Id are zero-to-one references, the set {​Medication​​Request​.​Medication​Code​Id, ​Medication​​Request​.​Medication​Id} is a one-to-one resource​. | | medication​.medication​Reference | ​Medication​​Request​.​Medication​Id | Lookup: ​Medication | 0​.1 | While the individual fields ​Medication​​Request​.​Medication​Code​Id and ​Medication​​Request​.​Medication​Id are zero-to-one references, the set {​Medication​​Request​.​Medication​Code​Id, ​Medication​​Request​.​Medication​Id} is a one-to-one resource​. | | subject | ​Medication​​Request​.​Patient​Id | ​Master-​Detail ​Reference: ​Account | 1​.1 | Only references to patients are supported​. | | encounter | ​Medication​​Request​.Clinical​Encounter​Id | Lookup: Clinical​Encounter | 0​.1 | N/​A | | supporting​Information | N/​A | N/​A | N/​A | Not ​Supported | | authored​On | ​Medication​​Request​.​Prescribed​Date | ​Date​Time | 0​.1 | N/​A | | requester | ​Medication​​Request​.​​Requester​Id | ​Polymorphic Lookup: ​Account, Healthcare​Provider, Care​Registered​Device | 0​.1 | N/A | | performer | ​Medication​​Request​.​Performer​Id | ​Polymorphic Lookup: ​Account, Care​Registered​Device, and Healthcare​Provider | 0​.1 | ​Doesn’t support references to care teams​. | | performer​Type | ​Medication​​Request​.​Performer​Type​Id | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | recorder | N/​A | N/​A | N/​A | Not ​Supported | | reason​Code | ​Medication​​Request​.​Reason​Code​Id | Lookup: ​CodeSet​Bundle | 0​.1 | While FH​I​R defines ​Medication​​Request​.reason​Code as a zero-to-many resource, the ​Salesforce implementation is zero-to-one​. | | reason​Reference | ​Medication​​Request​.​Reason​Reference​Id | ​Polymorphic Lookup: Health​Condition, Care​Observation | 0​.1 | While FH​I​R defines ​Medication​​Request​.reason​Reference as a zero-to-many resource, the ​Salesforce implementation is zero-to-one​. | | instantiates​Canonical | N/​A | N/​A | N/​A | Not ​Supported | | instantiates​Canonical | N/​A | N/​A | N/​A | Not ​Supported | | basedOn | ​Medication​​Request​.​Related​​Request​Id | Lookup: ​Medication​​Request | 0​.1 | ​The medication​​Request​.basedOn FH​I​R resource is flattened to a set of medication request and service request fields in the ​Salesforce implementation​. | | basedOn | ​Medication​​Request​Detail​.Clinical​Service​​Request​Id | Lookup: Clinical​Service​​Request | 0​.1 | ​The medication​​Request​.basedOn FH​I​R resource is flattened to a set of medication request and service request fields in the ​Salesforce implementation​. | | group​Identifier | ​Medication​​Request​.​Medication​​Request​Group​Id | Lookup: ​Identifier | 0​.1 | N/​A | | courseOf​Therapy​Type | ​Medication​​Request​.​Therapy​Duration | ​Picklist | 0​.1 | While FH​I​R defines ​Medication​​Request​.courseOf​Therapy​Type as a code set bundle, the ​Salesforce implementation of ​Medication​​Request​.​Therapy​Duration is picklist​. | | insurance | N/​A | N/​A | N/​A | Not supported | | note | N/​A | N/​A | N/​A | Not supported | | dosage​Instruction | ​Patient​​Medication​Dosage | Object | 0​.​M | ​The dosage information for a medication request is represented as ​Patient​​Medication​Dosage records that reference the ​Medication​​Request record using their ​Patient​​Medication​Dosage​.​Parent​Record​Id field​. | | dispense​​Request​.initial​Fill​.quantity | ​Medication​​Request​.​Initial​Fill​Quantity | ​Double | 0​.1 | Because ​Salesforce doesn’t support a native quantity data type, the implementation of medication​​Request​.dispense​​Request​.initial​Fill​.quantity is flattened into a set of quantity and unit fields​. | | dispense​​Request​.initial​Fill​.quantity | ​Medication​​Request​.Fill​Quantity​Unit​Id | Lookup: ​UnitOf​​Measure | 0​.1 | Because ​Salesforce doesn’t support a native quantity data type, the implementation of medication​​Request​.dispense​​Request​.initial​Fill​.quantity is flattened into a set of quantity and unit fields​. | | dispense​​Request​.initial​Fill​.duration | ​Medication​​Request​.​Initial​Fill​Duration | ​Double | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the implementation of medication​​Request​.dispense​​Request​.initial​Fill​.duration is flattened into a set of duration and unit fields​. | | dispense​​Request​.initial​Fill​.duration | ​Medication​​Request​.Fill​Duration​Unit​Id | Lookup: ​UnitOf​Measure | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the implementation of medication​​Request​.dispense​​Request​.initial​Fill​.duration is flattened into a set of duration and unit fields​. | | dispense​​Request​.dispense​Interval | ​Medication​​Request​.​Dispense​Interval | ​Double | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the implementation of medication​​Request​.dispense​​Request​.dispense​Interval is flattened into a set of interval and unit fields​. | | dispense​​Request​.dispense​Interval | ​Medication​​Request​.​Dispense​Interval​Unit​Id | Lookup: ​UnitOf​Measure | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the implementation of medication​​Request​.dispense​​Request​.dispense​Interval is flattened into a set of interval and unit fields​. | | dispense​​Request​.validity​Period | ​Medication​​Request​.​Prescription​Period​Start | ​Date​Time | 0​.1 | Because ​Salesforce doesn’t support a native period data type, the implementation of medication​​Request​.dispense​​Request​.validity​Period is flattened into a set of start and end dates​. | | dispense​​Request​.validity​Period | ​Medication​​Request​.​Prescription​Period​End | ​Date​Time | 0​.1 | Because ​Salesforce doesn’t support a native period data type, the implementation of medication​​Request​.dispense​​Request​.validity​Period is flattened into a set of start and end dates​. | | dispense​​Request​.numberOf​Repeats​Allowed | ​Medication​​Request​.​Refills​Allowed | ​Double | 0​.1 | N/​A | | dispense​​Request​.quantity | ​Medication​​Request​.​Refill​Quantity | ​Double | 0​.1 | Because ​Salesforce doesn’t support a native quantity data type, the medication​​Request​.dispense​​Request​.quantity is flattened into a set of quantity and unit fields​. | | dispense​​Request​.quantity | ​Medication​​Request​.Fill​Quantity​Unit​Id | Lookup: ​UnitOf​Measure | 0​.1 | Because ​Salesforce doesn’t support a native quantity data type, the medication​​Request​.dispense​​Request​.quantity is flattened into a set of quantity and unit fields​. | | dispense​​Request​.expected​Supply​Duration | ​Medication​​Request​.​Refill​Duration | ​Double | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the medication​​Request​.dispense​​Request​.expected​Supply​Duration is flattened into a set of duration and unit fields​. | | dispense​​Request​.expected​Supply​Duration | ​Medication​​Request​.Fill​Duration​Unit​Id | Lookup: ​UnitOf​Measure | 0​.1 | Because ​Salesforce doesn’t support a native duration data type, the medication​​Request​.dispense​​Request​.expected​Supply​Duration is flattened into a set of duration and unit fields​. | | dispense​​Request​.performer | ​Medication​​Request​.​Dispenser​Id | Lookup: ​Account | 0​.1 | N/​A | | substitution​.allowed​.allowed​Boolean | ​Medication​​Request​.Can​Substitute | Boolean | 0​.1 | N/​A | | substitution​.allowed​.allowed​Codeable​Concept | ​Medication​​Request​.​Allowed​Substitution​Type​Code​Id | Lookup: ​CodeSet​Bundle | 0​.1 | 0​.1 | | substitution​.reason | ​Medication​​Request​.​Substitution​Reason​Code​Id | Lookup: ​CodeSet​Bundle | 0​.1 | N/​A | | prior​Prescription | ​Medication​​Request​.​Previous​Prescription​Id | Lookup: ​Medication​​Request | 0​.1 | N/​A | | detected​Issue | N/​A | N/​A | N/​A | Not supported | | event​History | N/​A | N/​A | N/​A | Not supported | #### See Also - [MedicationRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_MedicationRequest.htm "Represents a request or order for the supply of medication, along with information about how it should be administered. This object is 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 version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Additional Information for MedicationStatement in Other Objects In addition to creating a record using these fields, you can add more details to your MedicationStatement record by creating records in certain other objects, and referencing your MedicationStatement record as the parent record. Here’s the list of objects you can associate to MedicationStatement in this way, the type of information they add, and the field they use to reference MedicationStatement. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the medication statement. | ParentRecordId | | PatientMedicationDosage | Associates dosage related information for the medication in the medication statement record. | ParentRecordId | ## Fields ### AssertionDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time the medication statement was made. ### CareObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observation that warranted this medication. - **Referenced Objects**: - CareObservation ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the patient's medication statement. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter related to the medication statement. - **Referenced Objects**: - ClinicalEncounter ### DeliverySetting - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the setting in which the medication was administered. - **Possible values**: - Community - Inpatient - Outpatient - PatientSpecified ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The stated end date and time for the medication. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MedicationCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that identifies a medication. A record can select either a MedicationId or a MedicationCodeId, but not both. - **Referenced Objects**: - CodeSetBundle ### MedicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication associated with this medication statement. A record can select either a MedicationId or a MedicationCodeId, but not both. - **Referenced Objects**: - Medication ### MedicationReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason this medication was taken. - **Referenced Objects**: - CodeSetBundle ### MedicationReasonId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observation, condition, or diagnostic report that warranted the medication. - **Referenced Objects**: - HealthCondition - CareObservation ### MedicationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A medication request associated with the medication statement. - **Referenced Objects**: - MedicationRequest ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the medication statement record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the medication statement record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### ParentMedicationStatementId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent medication statement associated with the medication statement. - **Referenced Objects**: - MedicationStatement ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: A patient that the medication statement refers to. - **Referenced Objects**: - Account ### ProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The procedure associated with this medication statement. - **Referenced Objects**: - PatientMedicalProcedure ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The stated start date and time for the medication. ### StatementSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who made the medication statement. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the medication in this statement. - **Possible values**: - Active - Completed - Entered-in-error - Intended - Not-taken - On-hold - Review Pending - This picklist value is available for the Home Health feature in API version 59.0 and later. - Stopped - Unknown ### StatusReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason for the status. - **Referenced Objects**: - CodeSetBundle ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [MedicationStatementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [MedicationStatementFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MedicationStatementHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [MedicationStatementOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [MedicationStatementShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # Medication​Statement The medication​Statement FHIR resource maps to the Medication​Statement object in Salesforce​. ## FHIR V4​.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [medication​Statement](https://www.hl7.org/fhir/medicationstatement.html) map to the fields in Salesforce​.
Table 1. Medication​Statement - Salesforce
Medication ​Statement ​Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for a medication statement is represented as Identifier records that reference the Medication​Statement record using their Identifier​.Parent​RecordId field​.
basedOn Medication​Statement​.Medication​RequestId Lookup: Medication​Request 0​.1

While FHIR defines medication​Statement​.basedOn as a zero-to-many resource, the Salesforce implementation of Medication​Statement​.Medication​RequestId is zero-to-one​.

The Salesforce implementation doesn’t support references to care plan or service request records​.
partOf Medication​Statement​.Parent​Medication​Statement​Id Lookup: Medication​Statement 0​.1

The Salesforce implementation of medication​Request​.partOf is flattened into three separate references​.

​References to medication administration and medication dispense records are not supported​.

While FHIR defines medication​Statement​.partOf as a zero-to-many resource, the Salesforce implementation is zero-to-one for each of the flattened fields​.
partOf Medication​Statement​.ProcedureId Lookup: Patient​Medical​Procedure 0​.1

The Salesforce implementation of medication​Request​.partOf is flattened into three separate references​.

​References to medication administration and medication dispense records are not supported​.

While FHIR defines medication​Statement​.partOf as a zero-to-many resource, the Salesforce implementation is zero-to-one for each of the flattened fields​.
partOf Medication​Statement​.Care​Observation​Id Lookup: Care​Observation 0​.1

The Salesforce implementation of medication​Request​.partOf is flattened into three separate references​.

​References to medication administration and medication dispense records are not supported​.

While FHIR defines medication​Statement​.partOf as a zero-to-many resource, the Salesforce implementation is zero-to-one for each of the flattened fields​.
status Medication​Statement​.​Status Picklist 1​.1 While FHIR defines Medication​Statement​.status as a code set bundle, the Salesforce implementation of Medication​Statement​.​Status is picklist​.
status​Reason Medication​Statement​.​Status​Reason​CodeId Lookup: ​CodeSet​Bundle 0​.1 N/A
category Medication​Statement​.Delivery​Setting Picklist 0​.1 While FHIR defines Medication​Statement​.category as a code set bundle, the Salesforce implementation is a picklist​.
medication​.medication​Codeable​Concept Medication​Statement​.Medication​CodeId Lookup: ​CodeSet​Bundle 0​.1 While the individual fields Medication​Statement​.Medication​CodeId and Medication​Statement​.MedicationId are zero-to-one references, the set {Medication​Statement​.Medication​CodeId, Medication​Statement​.MedicationId} is a one-to-one resource​.
medication​.medication​Reference Medication​Statement​.MedicationId Lookup: Medication 0​.1 While the individual fields Medication​Statement​.Medication​CodeId and Medication​Statement​.MedicationId are zero-to-one references, the set {Medication​Statement​.Medication​CodeId, Medication​Statement​.MedicationId} is a one-to-one resource​.
subject Medication​Statement​.PatientId Master-Detail ​Reference: Account 1​.1 Only references to patients are supported​.
context Medication​Statement​.Clinical​EncounterId Lookup: Clinical​Encounter 0​.1 Only references to encounters are supported​.
effective​.effective​Date​Time Medication​Statement​.Start​Date​Time DateTime 0​.1 The Medication​Statement​.Start​Date​Time field is used as both the Salesforce counterpart for medication​Statement​.effective​.effective​Date​Time and the start date field for medication​Statement​.effective​.effective​Period​.
effective​.effective​Period Medication​Statement​.Start​Date​Time Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the implementation of medication​Statement​.effective​.effective​Period is flattened into a set of start and end dates​.
effective​.effective​Period Medication​Statement​.End​Date​Time Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the implementation of medication​Statement​.effective​.effective​Period is flattened into a set of start and end dates​.
date​Asserted Medication​Statement​.Assertion​Date​Time Date​Time 0​.1 N/A
information​Source Medication​Statement​.​Statement​SourceId Polymorphic Lookup: Account, Healthcare​Provider 0​.1 N/A
derived​From N/A N/A N/A Not supported
reason​Code Medication​Statement​.Medication​Reason​CodeId Lookup: ​CodeSet​Bundle 0​.1 While FHIR defines Medication​Statement​.reason​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​Reference Medication​Statement​.Medication​ReasonId Polymorphic Lookup: Health​Condition, Care​Observation 0​.1

While FHIR defines Medication​Statement​.reason​Reference as a zero-to-many resource, the Salesforce implementation is zero-to-one​.

Only references to condition and observation records are supported​.
note N/A N/A N/A Not supported
dosage Patient​Medication​Dosage Object 0​.M The dosage information for a medication statement is represented as Patient​Medication​Dosage records that reference the Medication​Statement record using their Patient​Medication​Dosage​.Parent​RecordId field​.
#### See Also - [MedicationStatement](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_MedicationStatement.htm "Represents a record of medication that the patient is currently taking or has taken in the past. This object is available in API version 51.0 and later.") # MedicationStatementDetail Represents additional information associated with MedicationStatement records. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailCodeId - **Type**: Polymorphic Master-Detail reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a code set or code set bundle that adds information to a MedicationStatement record. - **Referenced Objects**: - CodeSet - CodeSetBundle ### DetailRecordId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a record that adds information to a MedicationStatement record - **Refers To**: - CareObservation - ClinicalServiceRequest - DiagnosticSummary - HealthCondition - MedicationDispense - MedicationRequest - MedicationStatement - PatientMedicalProcedure ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of information added to the MedicationStatement record. - **Possible values**: - Based On - Part Of - Status Reason - Reason Code - Reason Reference - Derived From ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### MedicationStatementId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent MedicationStatement record to which additional information is being added. This is a relationship field. - **Refers To**: - MedicationStatement ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ## Usage - Use the MedicationStatementId field to reference the parent MedicationStatement record that the additional information is being associated to. - Use the DetailType picklist to specify the type of detail that’s being associated to the MedicationStatement record. Here's how the associated 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. ## 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. [MedicationStatementDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. # 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IngredientId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The substance that’s used as an ingredient in the medication. If the ingredient is another medication 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 the ingredient. - **Referenced Objects**: Medication, CodeSetBundle ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the ingredient is an active ingredient in the medication. An active ingredient affects the therapeutic action of the medication. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OwnerId - **Type**: Polymorphic reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Referenced Objects**: Group, User ### ParentRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The medication that this ingredient is a part of. This is a relationship field. - **Referenced Objects**: Medication ### StrengthDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator value of the ingredient’s strength or quantity in the medication. ### StrengthDenominatorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of StrengthDenominator - **Referenced Objects**: UnitOfMeasure ### StrengthNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator value of the ingredient’s strength or quantity in the medication. ### StrengthNumeratorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of StrengthNumerator This is a relationship field. - **Refers To**: UnitOfMeasure ## Usage Ingredients are added to a medication record by creating MedicinalIngredient records to represent each ingredient, and then referencing the medication record using the ParentRecordId field in all the MedicinalIngredient records. ## 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. [MedicinalIngredientChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [MedicinalIngredientFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MedicinalIngredientHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [MedicinalIngredientShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # MedTech Commercial Engagement These objects are available for Life Sciences Cloud for MedTech Commercial Engagement. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). - **[Intelligent Sales](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_intelligent_sales_data_model.htm)** Help your sales team plan and execute sales visits and manage field inventory with Intelligent Sales. # Member A member is a person who is the primary subscriber, a dependent, or anyone else who is covered under the insurance plan. Members are represented with an Account object record of record type Person Account. # MemberPlan Represents details about the insurance coverage for a member or subscriber. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note The primary member on the plan is called the subscriber. The other members are dependents. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### Affiliation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An affiliation to a government service, such as the army or navy. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which this member plan is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this member plan ceases to be effective. ### ExternalIDentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier used to identify the record outside the Salesforce org. ### GroupNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The group number or policy number of the primary member. ### IssuerNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference number for the issuer of the plan. ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastVerification - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this plan was last verified. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MemberId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the member’s record. ### MemberNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The member’s reference number for this plan. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name by which the member knows this plan. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes about this member plan. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PayerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the payer’s Account object record. ### PayerNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The payer insurance plan or network that is associated with the patient. This field is a relationship field. - **Relationship Name**: PayerNetwork - **Relationship Type**: Lookup - **Refers To**: HealthcarePayerNetwork ### PlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup of the Purchaser Plan ID. ### PrimaryCarePhysician - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the physician providing primary care under this plan. ### PrimarySecondaryTertiary - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Whether this plan is the primary, secondary, or tertiary plan. ### RelationshipToSubscriber - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The relationship of this member to the plan’s subscriber. Valid options are: - Self - Spouse - Child - Unknown - Other Relationship ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this plan record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this plan record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this plan record was last changed on the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the plan is active. ### SubscriberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the subscriber’s record. ### VerificationStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the plan’s verification. Valid options are: - Active - Verified - Rejected - Not Checked - Unknown - Inactive ## 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. [MemberPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 57.0) Change events are available for the object. [MemberPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MemberPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [MemberPlanOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [MemberPlanShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Merge Customer Account (POST) Merges a list of customer accounts. If any one account merge in the request fails, the entire operation is cancelled. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Resource /connect/life-sciences/commercial/customers/actions/merge ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/customers/actions/merge ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST { "customersToMerge": \[ { "winningId": "001x0000002kl8VFFV", "winningExternalId": "001x0000004op0XHHX", "losingId": "001x0000009gh6TDDT", "losingExternalId": "001x0000001ij7UEEU" }, { "winningId": "001x0000003mn9WGGW", "winningExternalId": "001x0000007uv3AKKA", "losingId": "001x0000006st2ZJJZ", "losingExternalId": "001x0000005qr1YIIY" } \], "overrideBlankValues": true }
Name Type Description Required
customers​ToMerge MergeCustomers​Input​Representation[] A list of customer merge requests. A maximum of 100 requests can be included in a single call. Required
override​BlankValues Boolean Specifies whether to override blank values in the Consolidated Account record with values from the Merged Account record. The default value is false.

If set to true, it looks for null values in the fields of the winning account and fills them with non null values from the losing account

Optional
## Response Body for POST [Customer Accounts Merged Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_merge_customer_account_output.htm "Output representation of the response for a successful account merge operation.") # Merge Customer Account with Status (POST) Merges a list of customer accounts and provides a status for each request. This API processes all valid requests and does not fail the entire operation if one request is invalid. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Resource /connect/life-sciences/commercial/customers/actions/merge-with-status ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/customers/actions/merge-with-status ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST { "customersToMerge": \[ { "winningId": "a3Lxx000000MbzxxAC", "winningExternalId": "a3Lxx000000MbzxxBC", "losingId": "001xx00001STZUxxTR", "losingExternalId": "001x0000007uv3AKKA" }, { "winningId": "001x0000007cd4RBBR", "winningExternalId": "001x0000008ef5SCCS", "losingId": "001xx00001SYtgxxUI", "losingExternalId": "001x0000001ij7UEEU" } \], "overrideBlankValues": true }
Name Type Description Required
customersToMerge MergeCustomersInputRepresentation[] A list of customer merge requests. A maximum of 100 requests can be included in a single call. Required
overrideBlankValues Boolean Specifies whether to override blank values in the Consolidated Account record with values from the Merged Account record. The default value is false.

If set to true, it looks for null values in the fields of the winning account and fills them with non null values from the losing account.

Optional
## Response Body for POST [Merge Customer Accounts with Status Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_merge_customer_account_with_status_output.htm "The response body for the merge customer account with status request.") # Merge Customer Account with Status Output The response body for the merge customer account with status request. ## JSON example { "code": "", "success": true, "message": "", "jobId": "01pxx000001T7QxxAK", "accepted": \[ "a3Lxx000000MbzxxAC", "a3Lxx000000MbzxxBC" \], "rejected": \[ { "winningId": "001xx00001STZUxxTR", "winningExternalIdField": null, "losingId": "001xx00001SYtgxxUI", "losingExternalIdField": null, "errorMessage": "Unable to find the Account with salesforce id 001xx00001STZVxxAS." } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | A code that represents the status of the operation. | Small, 65.0 | 65.0 | | success | Boolean | Indicates whether the operation was successful. | Small, 65.0 | 65.0 | | message | String | A message related to the status of the operation. | Small, 65.0 | 65.0 | | jobId | String | ID of the asynchronous job created to process the requests. | Small, 65.0 | 65.0 | | accepted | String\[\] | A list of the Consolidated Account IDs for which the merge request was successfully accepted for processing. | Small, 65.0 | 65.0 | | rejected | [RejectedMergeRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_response_rejected_merge_request_representation.htm "A merge request that was rejected due to invalid input.")\[\] | A list of merge requests that were rejected due to invalid input. | | 65.0 | # Merge Customers Input The request to merge a Consolidated Account with a Merged Account. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Properties | Property Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | winningId | String | The Salesforce ID of the Consolidated Account. Required when a Consolidated Account external ID isn't provided. Must be unique within the request. | Required | 65.0 | | winningExternalId | String | The external ID of the Consolidated Account. Required when a Consolidated Account ID isn't provided. | Required | 65.0 | | losingId | String | The Salesforce ID of the Merged Account. Required when a Merged Account external ID isn't provided. Must be unique within the request. | Required | 65.0 | | losingExternalId | String | The external ID of the Merged Account. Required when a Merged Account ID isn't provided. | Required | 65.0 | # Merge Management Maintain the integrity of your healthcare provider and healthcare organization profile information with a configurable process that removes duplicated account data. Users can either manually merge or receive merge requests from external sources to consolidate into a single winning account and remove the losing account. This capability provides organizations with a single, accurate view of the HCPs and HCOs that they work with. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # MergeRequest Represents the details related to tracking the merge history of records. It maps the losing record (deleted as result of merge) to the winning records (remains after merge). This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ErrorMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The error message displayed when the merge request processing fails. ### ExecutionJobIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the job that processed the merge request. ### ExecutionJobType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of job that processes the merge request. - **Default value**: BatchJob - **Possible values**: - BatchJob—Batch Job ### FinalWinningRecIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Salesforce ID of the final winning record. This occurs when the winning record becomes a losing record in a subsequent merge request. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LosingExtlRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external ID of the losing record in the merge request. ### LosingOfflineRecIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The offline ID of the losing record's external ID in the merge request. ### LosingRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Salesforce ID of the losing record in the merge request. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-numbered name of the merge request. ### ObjectType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of object for which the merge request is created. - **Default value**: Account - **Possible values**: - Account ### OriginType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the source of the merge request. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the merge request record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ShouldOverrideBlankValues - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to update blank values of winning account fields with losing account fields (true) or not (false). The winning account is updated only if there are values in the losing account. - **Default value**: false ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the merge request. - **Default value**: Requested - **Possible values**: - Completed - Error - InProgress—In Progress - Requested ### WinningExtlRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external ID of the winning record in the merge request. ### WinningRecordIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Salesforce ID of the winning record in the merge request. ## 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. [MergeRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [MergeRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [MergeRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [MergeRequestShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # MngEvent Represents the details of a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the account that populates when the Event Location is set to an Account. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The address that populates when Event Location Address references an Address record. This field is a relationship field. - **Relationship Name**: Address - **Refers To**: Address ### CampaignId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The campaign associated with the managed event. This field is a relationship field. - **Relationship Name**: Campaign - **Refers To**: Campaign ### Capacity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Primary participant limit for the event; up to this number, registrations are accepted as Registered. ### CapacityEnforcementType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The registration behavior when event capacity is reached. - **Possible values**: - NoCapacityCheck—No Capacity Check - NoWaitlist—No Waitlist - Overbooking - Waitlist ### CapacityStatus - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Indicates real-time registration availability based on the current participant count. This field is a calculated field. - **Possible values**: - Available—Under 80% full. - NearCapacity—Between 80% and 100% full. - Full—Capacity has been reached and registration enforcement is strict (no waitlist enabled). - WaitlistOnly—Capacity has been reached but waitlist registration is available based on enforcement settings. - Closed—Registration has ended. ### CheckinEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when event check-in closes. ### CheckinStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when event check-in begins. ### ComplianceAgreementStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the compliance agreement for the managed event. - **Possible values**: - Agreed - AgreementOptional - AgreementRequired - NotRequired ### ComplianceStatements - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The compliance statements contain the details of the policies and procedures that must be adhered to for the managed event. ### ContactPointAddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The address that populates when Event Location Address references a Contact Point Address record. This field is a relationship field. - **Relationship Name**: ContactPointAddress - **Refers To**: ContactPointAddress ### CurrentRegistrationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Live count of active participants in the event, including registered and waitlisted participants. ### CurrentUserEventRole - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The role of the current user who is viewing the record in the managed event. ### CurrentWaitlistCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Current number of waitlisted participants, derived from registrations above capacity. This field is a calculated field. ### DefaultInvitationQuota - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The default invitation quota assigned to colleagues when a managed event is created. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the managed event. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time until which the managed event is scheduled. ### EstimatedBudget - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total estimated cost for organizing the event, based on expected expenses such as venue, travel, speaker fees, logistics, and other resources. ### EstimatedParticipantCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The estimated number of participants expected to attend the managed event. ### EventLocationAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The physical address of the event. This field is a polymorphic relationship field. - **Relationship Name**: EventLocationAddress - **Refers To**: Address, ContactPointAddress ### EventLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the location or account where the event is held. This field serves as the primary source for all derived location details and geographic mapping. This field is a polymorphic relationship field. - **Relationship Name**: EventLocation - **Refers To**: Account, Location ### EventMgmtStatusId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of managed event. This field is a relationship field. - **Relationship Name**: EventMgmtStatus - **Refers To**: EventMgmtStatus ### EventPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The broader event plan to which the event belongs to. An event plan streamlines tracking, budgeting, and reporting about the planned and executed events. This field is a relationship field. - **Relationship Name**: EventPlan - **Refers To**: EventPlan ### EventStructure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The structure of the managed event. - **Possible values**: - Host - Satellite - Standalone ### HardRegistrationLimit - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Absolute maximum total registrations for the event, including registered and waitlisted participants. ### IsAutoWaitlistProcEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether waitlisted participants are automatically promoted when capacity becomes available. - **Default value**: false ### IsSatelliteRegistrationOpen - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if satellite registration is open for the host managed event. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the location where the manged event is hosted. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### LocationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the event location type, such as in-office or out-of-office. - **Possible values**: - CompanyLocation - CustomerLocation - PartnerLocation - ThirdPartyLocation ### MaximumAllowedSatellites - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum number of satellite registrations allowed for the host managed event. ### MngEventDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the managed event definition associated with the managed event. This field is a relationship field. - **Relationship Name**: MngEventDefinition - **Refers To**: MngEventDefinition ### MngEventTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the managed event type associated with the managed event. This field is a relationship field. - **Relationship Name**: MngEventType - **Refers To**: MngEventType ### Mode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the mode in which the managed event is delivered. - **Possible values**: - Hybrid - InPerson - RemoteEngagement - Virtual ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event. ### OnlineAccessCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The access code required to join the online event. ### OnlineIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the virtual event session. ### OnlineUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The web link for participants to join the online event. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The main overarching event that serves as the primary source of authority for related smaller events. This field is a relationship field. - **Relationship Name**: Parent - **Refers To**: MngEvent ### PrimaryOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the suser who is the primary owner of the managed event. This field is a relationship field. - **Relationship Name**: PrimaryOwner - **Refers To**: User ### RegistrationEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when registration closes. ### RegistrationStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when registration opens. ### SatelliteCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of related satellite managed events. ### SatelliteDiscrepancyReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The specific reason or error that explains the discrepancy detected during satellite event creation. - **Possible values**: - AddedAfterRegistrationClosed - MaxSatelliteLimitReached ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from which the managed event is scheduled. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the managed event. - **Possible values**: - Completed - New - Pending ### StatusUsedInBudgetCalculation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the managed event at the time of the last budget calculation. ### TotalActualExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The sum of actual expense amounts incurred for the event. ### TotalBudgetAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of all budgets associated with the event. This field is a calculated field. ### TotalEstimatedExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The sum of estimated expense amounts associated with the event. ### Url - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of the webpage that contains the details of the managed event. ### WaitlistProcessingEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time when waitlist processing stops. ## 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. MngEventChangeEvent Change events are available for the object. MngEventFeed Feed tracking is available for the object. MngEventHistory History is available for tracked fields of the object. MngEventShare Sharing is available for the object. # MngEventBudget Represents a junction between a managed event and the budget that's allocated for the managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AllocatedAmount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: Required. The amount that's allocated from the budget for the managed event. ### BudgetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the budget associated with the managed event budget. This field is a relationship field. - **Relationship Name**: Budget - **Refers To**: Budget ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MngEventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the managed event associated with the managed event budget. This field is a relationship field. - **Relationship Name**: MngEvent - **Relationship Type**: Master-detail - **Refers To**: MngEvent (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event budget. ### TotalActualExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount that's spent from the budget for the managed event. ### TotalEstimatedExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount estimated to be spent from the budget for the managed event. ## 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. MngEventBudgetChangeEvent Change events are available for the object. MngEventBudgetFeed Feed tracking is available for the object. MngEventBudgetHistory History is available for tracked fields of the object. # MngEventParticipant Represents a managed event participant and their participation details. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AttendanceConsent - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the managed event participant has consented to attend the managed event and includes details of the mode used to provide consent. - **Possible values**: - Denied - ESigned—E-Signed - PaperSigned—Paper Signed - Pending ### AttendanceConsentDateTime - **Type**: dateTime - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: The date and time when the managed event participant has consented to attend the managed event. ### AttendanceMode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the mode in which the participant has attended the managed event. - **Possible values**: - InPerson—In Person - Virtual ### AttendanceStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the attendance status of the participant for the managed event. - **Possible values**: - Attended - CheckInComplete—Check-In Complete - NoShow—No Show - SignUpComplete—Sign Up Complete ### Comments - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: ### CurrentInvitationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### DiscrepancyReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The reason for discrepancy identified during system validations. - **Possible values**: - AccountUtilizationLimitReachedBlock—Account Utilization Limit Reached: Block - AccountUtilizationLimitReachedWarning—Account Utilization Limit Reached: Warning - DuplicateReconciliation—Duplicate Reconciliation - ManagedEventContainsRestrictedProducts—Managed Event Contains Restricted Products - MonetaryCapLimitReachedBlock—Monetary Cap Limit Reached: Block - MonetaryCapLimitReachedWarningCreation—Monetary Cap Limit Reached: Warning at Creation - MonetaryCapLimitReachedWarningUpdation—Monetary Cap Limit Reached: Warning at Update or Recalculation - SubjectRecentlyHeardByAccount—Subject Recently Heard By Account ### DoesRequireMeal - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the managed event participant requires to be served a meal at the managed event. - **Default value**: false ### EventMgmtParticipantRoleId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field is a relationship field. - **Relationship Name**: EventMgmtParticipantRole - **Refers To**: EventMgmtParticipantRole ### EventMgmtParticipantTypeId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field is a relationship field. - **Relationship Name**: EventMgmtParticipantType - **Refers To**: EventMgmtParticipantType ### EventMgmtPtcpTypeRoleMapId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: This field is a relationship field. - **Relationship Name**: EventMgmtPtcpTypeRoleMap - **Refers To**: EventMgmtPtcpTypeRoleMap ### InvitationCntDiscrepancyRsn - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: - **Possible values**: - AdjustmentRequired—Adjustment Required - QuotaExceeded—Quota Exceeded - StaleData—Stale Data ### InvitationConsent - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the managed event participant has consented to the invitation for the managed event, and includes details of the mode used to provide consent. - **Possible values**: - Denied - ESigned—E-Signed - PaperSigned—Paper Signed - Pending ### InvitationConsentDateTime - **Type**: dateTime - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: The date and time when the managed event participant has consented to the managed event invitation. ### InvitationQuota - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### InvitationSentDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when managed event invitation was sent to the participant. ### InvitationSentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: - **Possible values**: - Bounced - Pending - Sent ### InvitedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the person who has invited the participant to the managed event. This field is a polymorphic relationship field. - **Relationship Name**: InvitedBy - **Refers To**: Account, Contact, MngEventParticipant, User ### IsCurrentUser - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: This field is a calculated field. - **Default value**: false ### IsInvitationSent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the managed event invitation is to the participant. - **Default value**: false ### InviterTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The active territory of the colleague who added this attendee to the managed event. This field is a relationship field. - **Relationship Name**: InviterTerritory - **Refers To**: Territory2 ### IsCapacityExempt - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the participant is excluded from capacity checks and registration counters. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MealType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of meal provided to the managed event participant at the managed event. ### MngEventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID the managed event that the participant is invited to. This field is a relationship field. - **Relationship Name**: MngEvent - **Relationship Type**: Master-detail - **Refers To**: MngEvent (the master object) ### MngEventCapacityRsvId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the capacity reservation block this participant is counted against. This field is a relationship field. - **Relationship Name**: MngEventCapacityRsv - **Refers To**: MngEventCapacityRsv ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event participant. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the participant who has been invited to the managed event. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Refers To**: Account, Contact, Expert, Lead, PartyProfile, User ### ParticipantPartyRecileStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the managed event participant has been associated with a healthcare provider. - **Possible values**: - CompletedNonProfiled—Completed Non-Profiled - CompletedProfiled—Completed Profiled - NotApplicable—Not Applicable - PendingReconciliation—Pending Reconciliation ### ParticipantResponse - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the managed event invitation that's sent to the participant. - **Possible values**: - Accepted - Declined - NoResponse—No Response - Tentative ### PrimaryHealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is a relationship field. - **Relationship Name**: PrimaryHealthcareProvider - **Refers To**: HealthcareProvider ### RegistrationDateTime - **Type**: dateTime - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Date and time when the participant registration record was first created. ### RegistrationStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Lifecycle status of the participant registration. - **Default value**: Registered ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### WaitlistAdjustmentDateTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when the participant was moved from Waitlisted to Registered. ### WaitlistPosition - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The current position of the participant in the waitlist queue. ## 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. MngEventParticipantChangeEvent Change events are available for the object. MngEventParticipantFeed Feed tracking is available for the object. MngEventParticipantHistory History is available for tracked fields of the object. # MngEventParticipantDiscrepancy Captures the list of discrepancies that have been identified for participants when they don't meet the limits or restrictions on the event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to additional contextual information about the discrepancy. ### DiscrepancyReason - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Represents the specific reason that caused the discrepancy. - **Possible values**: - ManagedEventContainsRestrictedProducts—Managed Event Contains Restricted Products - SubjectRecentlyHeardByAccount—Subject Recently Heard By Account - AccountUtilizationLimitReachedBlock—Account Utilization Limit Reached: Block - AccountUtilizationLimitReachedWarning—Account Utilization Limit Reached: Warning - MonetaryCapLimitReachedWarningAtUpdateOrRecalculation—Monetary Cap Limit Reached: Warning at Update or Recalculation - MonetaryCapLimitReachedBlock—Monetary Cap Limit Reached: Block - MonetaryCapLimitReachedWarningAtCreation—Monetary Cap Limit Reached: Warning at Creation - DuplicateReconciliation—Duplicate Reconciliation ### MngEventId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Represents the managed event related to which a discrepancy was identified. This field is a relationship field. - **Relationship Name**: MngEvent - **Refers To**: MngEvent ### MngEventParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Represents the participant for whom a discrepancy was identified. This field is a relationship field. - **Relationship Name**: MngEventParticipant - **Relationship Type**: Master-detail - **Refers To**: MngEventParticipant (the master object) ### ShouldOverrideDiscrepancy - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the admin overrides the discrepancy flagged by the system. ## 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. MngEventParticipantDiscrepancyFeed Feed tracking is available for the object. MngEventParticipantDiscrepancyHistory History is available for tracked fields of the object. # MngEventProduct Represents a junction between a managed event and the product that's a focus area of the managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MngEventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the managed event associated with the managed event product. This field is a relationship field. - **Relationship Name**: MngEvent - **Relationship Type**: Master-detail - **Refers To**: MngEvent (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event product. ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the product or product category associated with the managed event product. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: LifeSciMarketableProduct, Product2, ProductCategory ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ## 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. MngEventProductChangeEvent Change events are available for the object. MngEventProductFeed Feed tracking is available for the object. MngEventProductHistory History is available for tracked fields of the object. # MngEventResource Represents the details of a resource that's required for a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the account associated with the managed event resource. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the address details when the selected address is associated with a location record. This field is a relationship field. - **Relationship Name**: Address - **Refers To**: Address ### Amount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount that's required to procure the resource for the managed event. ### AmountDeviationReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business reason for the deviation of actual amount from the standard fair market values. ### BookingConfirmation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique confirmation number, URL, or reference code provided by the vendor or internal booking system. ### Comments - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The notes that are attached for the requirements related to the managed event resource. ### ContactPointAddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the address details when the selected address is associated with an account record. This field is a relationship field. - **Relationship Name**: ContactPointAddress - **Refers To**: ContactPointAddress ### DoesAmtDifferFrFairMktVal - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the actual rate or amount for the managed event resource deviates from the standard Fair Market Value. - **Default value**: false ### EventMgmtFairMarketValueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The benchmark rate associated with the managed event resource. This field is a relationship field. - **Relationship Name**: EventMgmtFairMarketValue - **Refers To**: EventMgmtFairMarketValue ### EventMgmtSvcSpclznId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service classification that is associated with the event plan. This field is a relationship field. - **Relationship Name**: EventMgmtSvcSpclzn - **Refers To**: EventMgmtSvcSpclzn ### EventMgmtSvcSpclznTierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service classification tier that is associated with the event plan. This field is a relationship field. - **Relationship Name**: EventMgmtSvcSpclznTier - **Refers To**: EventMgmtSvcSpclznTier ### ExpenseTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. The ID of the expense type associated with the managed event resource. This field is a relationship field. - **Relationship Name**: ExpenseType - **Refers To**: ExpenseType ### IsLocationResource - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the resource is associated with a location (true) or a service provider (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the location associated with the managed event resource. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### MaximumRate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The highest acceptable rate for the managed event resource as defined by the linked fair market value benchmark. ### MinimumRate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lowest acceptable rate for the managed event resource as defined by the linked fair market value benchmark. ### MngEventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the managed event associated with the managed event resource. This field is a relationship field. - **Relationship Name**: MngEvent - **Relationship Type**: Master-detail - **Refers To**: MngEvent (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event resource. ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the product or category that's required as a resource for the managed event. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: Product2, ProductCategory ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of the resource that's required for the managed event. ### ResourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category of the resource based on current business logic. For example Human Resource, equipment, or venue. - **Possible values**: - Catering - Venue ### SelectedAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the address associated with the managed event resource with respect to a location or account. This field is a polymorphic relationship field. - **Relationship Name**: SelectedAddress - **Refers To**: Address, ContactPointAddress ### SelectedLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the location or account that is associated with the managed event resource. This field is a polymorphic relationship field. - **Relationship Name**: SelectedLocation - **Refers To**: Account, Location ### SelectedService - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name or description of the service associated with the managed event resource. ### SelectedVendor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name and primary details of the third-party provider responsible for the resource. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the current state of the managed event resource. For example, confirmed, pending, or cancelled. ### SuggestedRate - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The recommended or typical rate for the managed event resource based on the fair market value benchmark. ## 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. MngEventResourceChangeEvent Change events are available for the object. MngEventResourceFeed Feed tracking is available for the object. MngEventResourceHistory History is available for tracked fields of the object. # MngEventResourcePreference Represents the preference rank of a resource that's requested for a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MngEventResourceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the managed event resource that's requested. This field is a relationship field. - **Relationship Name**: MngEventResource - **Relationship Type**: Master-detail - **Refers To**: MngEventResource (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event resource preference. ### Rank - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the rank of the preference when there are multiple preferences for a managed event resource. ### RequestedResourceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the resource that's requested. This field is a polymorphic relationship field. - **Relationship Name**: RequestedResource - **Refers To**: Location, Product2 ## 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. MngEventResourcePreferenceFeed Feed tracking is available for the object. MngEventResourcePreferenceHistory History is available for tracked fields of the object. # MngEventTerritory Represents a junction between a managed event and the territory that the managed event belongs to. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### MngEventId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the managed event associated with the managed event territory. This field is a relationship field. - **Relationship Name**: MngEvent - **Relationship Type**: Master-detail - **Refers To**: MngEvent (the master object) ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event territory. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The ID of the territory associated with the managed event territory. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. MngEventTerritoryFeed Feed tracking is available for the object. MngEventTerritoryHistory History is available for tracked fields of the object. # MngEventType Represents a type of managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of the managed event. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the managed event type. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### Subcategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subcategory of the managed event. ### TargetTemplate - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Required. Specifies the target template that's used by the managed event type. - **Possible values**: - DisplaysAndExhibits - Presentation - SpeakerMeeting - Sponsored ## 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. MngEventTypeFeed Feed tracking is available for the object. MngEventTypeHistory History is available for tracked fields of the object. MngEventTypeShare Sharing is available for the object. # Mobile Metadata Mobile Metadata represents a metadata cache for the Life Sciences Cloud for Customer Engagement mobile application. ![Mobile Metadata entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_mobile_metadata_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/mobile-metadata.html "HTML (New Window)"). ## Mobile Metadata Objects in Life Sciences Customer Engagement - [Content Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentdocument.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Life Science Mobile Metadata Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimobilemetadatarecord.htm) - [Profile](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_profile.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Mobile Sync The Mobile Sync objects store information about data transactions synchronized from the Life Sciences Cloud for Customer Engagement mobile application. This information includes individual data transactions and supporting summary and logging information. ![Mobile Sync entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_mobile_sync_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/mobile-sync.html "HTML (New Window)"). ## Mobile Sync Objects in Life Sciences Customer Engagement - [Device Sync Summary](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesyncsummary.htm) - [Device Sync Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransaction.htm) - [Device Sync Transaction Log](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransactionlog.htm) - [Device Sync Transaction Record](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_devicesynctransactionrecord.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Next Best The Next Best intelligent component is an AI-predictive tool that helps sales representatives to prioritize and personalize their customer interactions. Next Best Customer, Next Best Action, and Next Best Message together comprise the Next Best intelligent family. Next Best Customer surfaces the top accounts within a territory. Next Best Action suggests timely actions on a weekly basis, such as visits and emails. Next Best Message provides tailored and relevant messages for each product associated with the account. These recommendations are dynamically generated based on the real-time data, allowing field sales teams to act quickly or dismiss as needed. Next Best recommendations guide users to concentrate on the right accounts at the right time in the right channel to deliver the right message, fostering strong customer relationships. ![Next Best entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_next_best_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/next-best.html "HTML (New Window)"). ## Next Best Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Life Science Email](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescienceemail.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Managed Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_mngevent.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Territory Account Product Message Score](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryacctprodmsgscore.htm) - [Territory Account Recommended Action](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryacctrcmdaction.htm) - [Territory Account Score](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryaccountscore.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # OBR - Observation Request Segment The Observation Request Segment (OBR) HL7 segment maps primarily to the ClinicalServiceRequest, DiagnosticSummary, and PatientMEdicalProcedure objects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for OBR map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below.
Table 1. OBR - Salesforce
OBR Salesforce Field Type Notes
OBR.2 - Place Order Number Identifier Object Place Order Number is created as an identifier record. This record will then reference the entity it belongs to using the ParentRecordId field.
OBR.3 - Fill Order Number Identifier Object Fill Order Number is created as an identifier record. This record will then reference the entity it belongs to using the ParentRecordId field.
OBR.4 - Universal Service Id
  • ​​Clinical​Service​Request​.​Request​Code​Id
  • ​​​Patient​Medical​​Procedure​.​CodeId
  • ​​​Diagnostic​Summary​.​CodeId
 Lookup: CodeSetBundle N/A
OBR.5 - Order Status
  • ​​Clinical​Service​Request​.Status
  • ​​​Medication​​Request​.​Status
 Picklists N/A
OBR.7 - Observation Date/Time Patient​Medical​​Procedure​.Start​Date Double N/A
OBR.16 - Ordering Provider Clinical​Service​Request​.​Requester​Id Lookup: HealthcareProvider, Account, Asset N/A
OBR.22 - Results Rpt/Status Chng - Date/Time ​​​Diagnostic​Summary​.​IssuedDateTime DateTime N/a
OBR.24 - Diagnostic Service Section ID
  • ​​Clinical​Service​Request​.CategoryId
  • ​​​Diagnostic​Summary​.​CategoryId
  • Lookup: CodeSetBundle
  • Picklist
 N/A
OBR.25 - Result Status
  • ​​Patient​Medical​​Procedure​.Status
  • ​​​Diagnostic​Summary​.​Status
 Picklist N/A
OBR.27 - Quantity/Timing Clinical​Service​Request​.Quantity​Numerator Double N/A
OBR.27 - Quantity/Timing ​​Clinical​Service​Request​.Quantity​Denominator Double N/A
OBR.27 - Quantity/Timing Clinical​Service​Request​.Quantity​Numerator​Unit​Id Lookup: UnitOfMeasure N/A
OBR.31 - Reason For Study ​​Patient​Medical​​Procedure​.ReasonCodeId Lookup: CodeSetBundle N/A
OBR-32 - Principal Result Interpreter ​​​Diagnostic​Summary​.​InterpretedById Lookup: CarePerformer N/A
# ​Observation The observation FHIR resource maps to the Care​Observation and Care​Observation​Component objects in Salesforce​. ## FHIR V4​.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [observation](https://www.hl7.org/fhir/observation.html) map to the fields in Salesforce​.
Table 1. observation - Salesforce
​Observation Resource Salesforce Field Type Salesforce Cardinality Notes
identifier N/A N/A N/A Not supported
basedOn Care​Observation​.​Based​OnId Polymorphic Lookup: Medication​​Request, Clinical​Service​Request 0​.1

While FHIR defines observation​.basedOn as a zero-to-many reference, the Salesforce implementation is a zero-to-one text field​.

Only references to medication request and clinical service request records are supported​.
partOf Care​Observation​.Part​OfId Polymorphic Lookup: Medication​Statement, Patient​Immunization, Patient​Medical​Procedure 0​.1

While FHIR defines observation​.partOf as a zero-to-many reference, the Salesforce implementation is a zero-to-one text field​.

Only references to medication statement, patient immunization, and patient medical procedure records are supported​.
status Care​Observation​.​Observation​Status Picklist 1​.1 While FHIR defines observation​.status as a reference to code set bundle, the Salesforce implementation is a picklist​.
category Care​Observation​.Category Picklist 0​.1 While FHIR defines observation​.category as a zero-to-many reference to code set bundle, the Salesforce implementation is a zero-to-one picklist​.
code Care​Observation​.CodeId Lookup: CodeSet 1​.1 While FHIR defines observation​.code as a one-to-one reference to code set bundle, Salesforce implements this as three separate CodeSet reference fields​. The first one is a one-to-one field, while the other two are zero-to-one fields​.
code Care​Observation​.AdditionalCode1Id Lookup: CodeSet 0​.1 While FHIR defines observation​.code as a one-to-one reference to code set bundle, Salesforce implements this as three separate CodeSet reference fields​. The first one is a one-to-one field, while the other two are zero-to-one fields​.
code Care​Observation​.AdditionalCode2Id Lookup: CodeSet 0​.1 While FHIR defines observation​.code as a one-to-one reference to code set bundle, Salesforce implements this as three separate CodeSet reference fields​. The first one is a one-to-one field, while the other two are zero-to-one fields​.
subject Care​Observation​.​Observed​Subject​Id Master-Detail: Account 1​.1 The Salesforce implementation of observation​.subject supports references to only patients​.
focus N/A N/A N/A Not supported
encounter Care​Observation​.Encounter​Id Lookup: Clinical​Encounter 0​.1 N/A
effective​.effective​Date​Time Care​Observation​.Effective​Date​Time Date​Time 0​.1 N/A
effective​.effective​Period Care​Observation​.Effective​Date​Time Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the observation​.effective​.effective​Period field is flattened into a set of effective date and end date fields​.
effective​.effective​Period Care​Observation​.​End​Date​Time Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the observation​.effective​.effective​Period field is flattened into a set of effective date and end date fields​.
effective​.effective​Timing N/A N/A N/A Not supported
effective​.effective​Instant N/A N/A N/A Not supported
issued Care​Observation​.Issued​Date​Time Date​Time 0​.1 Because Salesforce doesn’t support a native instant data type, the observation​.issued FHIR resource is implemented as a date time field in Salesforce​.
performer Care​Observation​.​ObserverId Polymorphic Lookup: Account, Healthcare Provider 0​.1

While FHIR defines observation​.performer as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference to Account and Healthcare Provider​.

References to care teams are not supported​.
results​Interpreter Care​Observation​.Interpreted​ById Lookup: Care​Performer 0​.1 While FHIR defines observation​.results​Interpreter as a zero-to-many resource, the Salesforce implementation is a zero-to-one reference to Care​Performer​.
value​ Care​Observation​.​Observed​Value​​Type Static Picklist 0​.1 A Salesforce-original field that determines whether the value​ stored in Care​Observation​.​Observed​Value​​Numerator and Care​Observation​.​Observed​Value​​Denominator is a range, ratio, or quantity​. This field is used only when the data entered for observation​.value​ is one these data types​.
value​ Care​Observation​.​Observed​Value​​Numerator Double 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.value​ doesn’t support observation​.value​​.value​Sample​Data and observation​.value​​.value​Time​.

Care​Observation​.​Observed​Value​UnitId is a duplicate field that stores the same information as Care​Observation​.​UnitOf​MeasureId. Use only one of these two fields to specify the unit of a quantity value.
value​ Care​Observation​.​Observed​Value​​Denominator Double 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.value​ doesn’t support observation​.value​​.value​Sample​Data and observation​.value​​.value​Time​.

Care​Observation​.​Observed​Value​UnitId is a duplicate field that stores the same information as Care​Observation​.​UnitOf​MeasureId. Use only one of these two fields to specify the unit of a quantity value.
value​ Care​Observation​.​Observed​Value​UnitId Lookup: ​UnitOf​Measure 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.value​ doesn’t support observation​.value​​.value​Sample​Data and observation​.value​​.value​Time​.

Care​Observation​.​Observed​Value​UnitId is a duplicate field that stores the same information as Care​Observation​.​UnitOf​MeasureId. Use only one of these two fields to specify the unit of a quantity value.
value​ Care​Observation​.​Observed​Value​​Denominator Lookup: CodeSet​Bundle 0​.1 N/A
value​ Care​Observation​.​Numberic​Value Double 0.1 N/A
value​ Care​Observation​.​Observed​Value​Text String 0​.1 N/A
value​ Care​Observation​.IsOutcome​Positive Boolean 0​.1 Care​Observation​.IsObserved is a duplicate field that can store the same information. Use only one of these two fields.
value​ Care​Observation​.​Observation​Start​Time Date​Time 0​.1

Care​Observation​.​Observation​Start​Time is used for both observation​.component​.value​​.value​Date​Time and observation​.component​.value​​.value​Period​.

Because Salesforce doesn’t support a native period data type, the observation​.value​​.value​Period FHIR resource is flattened to a set of start and end dates​.
value​ Care​Observation​.​Observation​EndTime Date​Time 0​.1

Care​Observation​.​Observation​Start​Time is used for both observation​.component​.value​​.value​Date​Time and observation​.component​.value​​.value​Period​.

Because Salesforce doesn’t support a native period data type, the observation​.value​​.value​Period FHIR resource is flattened to a set of start and end dates​.
data​Absent​Reason N/A N/A N/A Not supported
interpretation Care​Observation​.​Value​Interpretation Picklist 0​.1 While FHIR defines observation​.interpretation as a zero-to-many code set bundle, the Salesforce implementation is a zero-to-one picklist​.
note N/A N/A N/A Not supported
body​Site Care​Observation​.Body​SiteId Lookup: CodeSet​Bundle 0​.1 N/A
method Care​Observation​.MethodId Lookup: CodeSet​Bundle 0​.1 N/A
specimen N/A N/A N/A Not supported
device Care​Observation​.DeviceId Lookup: Asset 0​.1 References to device metrics records aren’t supported​.
reference​Range​.low Care​Observation​.Lower​Baseline​Value​ Double 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.reference​Range​.low FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
reference​Range​.low Care​Observation​.​Baseline​UnitId Lookup: ​UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.reference​Range​.low FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
reference​Range​.high Care​Observation​.Upper​Baseline​Value​ Double 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.reference​Range​.high FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
reference​Range​.high Care​Observation​.​Baseline​UnitId Lookup: ​UnitOfMeasure 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.reference​Range​.high FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
reference​Range​.type N/A N/A N/A Not supported
reference​Range​.appliesTo N/A N/A N/A Not supported
reference​Range​.age N/A N/A N/A Not supported
reference​Range​.text Care​Observation​.​Baseline​Value​Text String 0​.1 N/A
hasMember Care​Observation​.Related​Observation​Id Lookup: Care​Observation 0​.1

While FHIR defines observation​.hasMember as a zero-to-many resource, the Salesforce implementation is zero-to-one​.

Only references to observation records are supported​.
derived​From Care​Observation​.Derivation​SourceId Lookup: Care​Observation, Diagnostic​Summary 0.1

While FHIR defines observation​.derivedFrom as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
component Care​Observation​Component Object 0​.M The component information for a care observation is represented as Care​Observation​Component records that reference the Care​Observation record using their Identifier​.Care​Observation​Id field​.
component​.code Care​Observation​Component​.​Component​Type​CodeId Lookup: CodeSet​Bundle 1​.1 N/A
component​.value​ Care​Observation​Component​.​Value​Type Static Picklist 0​.1 A Salesforce-original field that determines whether the value​ stored in Care​Observation​Component.​Observed​Value​​Numerator and Care​Observation​Component​.​Observed​Value​Denominator is a range, ratio, or quantity​. This field is used only when the data entered for observation​.component​.value​ is one these data types​.
component​.value​ Care​Observation​Component​.​Observed​Value​Numerator Double 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.component​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.component​.value​ doesn’t support observation​.component​.value​​.value​Sample​Data and observation​.component​.value​​.value​Time​.
component​.value​ Care​Observation​Component​.​Observed​Value​Denominator Double 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.component​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.component​.value​ doesn’t support observation​.component​.value​​.value​Sample​Data and observation​.component​.value​​.value​Time​.
component​.value​ Care​Observation​Component​.​Observed​Value​​UnitId Lookup: ​UnitOf​Measure 0​.1

Because Salesforce doesn’t support native range, ratio, and quantity data types, the observation​.component​.value​ FHIR resource is flattened to a set of numerator, denominator, and unit fields for this type of data​.

The Salesforce implementation of observation​.component​.value​ doesn’t support observation​.component​.value​​.value​Sample​Data and observation​.component​.value​​.value​Time​.
component​.value​ Care​Observation​Component​.​Observed​Value​CodeId Lookup: CodeSet​Bundle 0​.1 N/A
component​.value​ Care​Observation​Component​.​Numeric​Value​ Double 0.1 N/A
component​.value​ Care​Observation​Component​.​Observed​Value​Text String 0​.1 N/A
component​.value​ Care​Observation​Component​.Is​Observed Boolean 0​.1 N/A
component​.value​ Care​Observation​Component​.​Observation​Start​Time Date​Time 0​.1

Care​Observation​Component​.​Observation​Start​Time is used for both observation​.component​.value​​.value​​Date​Time and observation​.component​.value​​.value​​Period​.

Because Salesforce doesn’t support a native period data type, the observation​.component​.value​​.value​​Period FHIR resource is flattened to a set of start and end dates​.
component​.value​ Care​Observation​Component​.​Observation​EndTime Date​Time 0​.1

Care​Observation​Component​.​Observation​Start​Time is used for both observation​.component​.value​​.value​​Date​Time and observation​.component​.value​​.value​​Period​.

Because Salesforce doesn’t support a native period data type, the observation​.component​.value​​.value​​Period FHIR resource is flattened to a set of start and end dates​.
component​.data​Absent​Reason Care​Observation​Component​.Missing​Data​Reason String 0​.1 While FHIR defines observation​.component​.data​Absent​Reason as a code set bundle reference, the Salesforce implementation is a text field​.
component​.interpretation Care​Observation​Component​.​Value​Interpretation Lookup: CodeSet​Bundle 0​.1 While FHIR defines observation​.component​.interpretation as a code set bundle reference, the Salesforce implementation is a picklist​.
component​.reference​Range​.low Care​Observation​Component​.Lower​Baseline​Value​ Double 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.component​.reference​Range​.low FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
component​.reference​Range​.low Care​Observation​Component​.​Baseline​UnitId Lookup: ​UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.component​.reference​Range​.low FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
component​.reference​Range​.high Care​Observation​Component​.Upper​Baseline​Value​ Double 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.component​.reference​Range​.high FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
component​.reference​Range​.high Care​Observation​Component​.​Baseline​UnitId Lookup: ​UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native quantity data type, the observation​.component​.reference​Range​.high FHIR resource is flattened to a set of value​ and unit fields for this type of data​.
component​.reference​Range​.type N/A N/A N/A Not supported
component​.reference​Range​.applies​To N/A N/A N/A Not supported
component​.reference​Range​.age N/A N/A N/A Not supported
component​.reference​Range​.text Care​Observation​Component​.​Baseline​Value​Text String 0​.1 N/A
![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note The fields Care​Observation​.IsOutcome​Positive and Care​Observation​.​UnitOf​MeasureId don’t have FHIR-defined validation rules built into them because these fields are used in other features and data models. You can define your own custom validation rules on them based on your business requirements. # OBX - Observation Segment The Observation Segment (OBX) HL7 segment maps to the CareObservation object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for OBX map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the Segments supported by Salesforce are mentioned below.
Table 1. OBX - Salesforce
OBX Salesforce Field Type Notes
OBX.2 - Value Type CareObservation.ObservedValueType Picklist N/A
OBX.3 - Observation Identifier Care​Observation​.CodeId Lookup: CodeSetBundle N/A
OBX.3 - Observation Identifier Care​Observation​Component​.​Component​Type​CodeId Lookup: CodeSetBundle N/A
OBX.5 - Observation Value
  • Care​Observation​.​Observed​Value​​Numerator
  • Care​Observation​.​Observed​Value​​Denominator
  • Care​Observation​.​Observed​Value​​CodeId
  • Care​Observation​.​Observed​Value​​Text
  • Care​Observation​.​Is​Observed
  • Care​Observation​.​Observation​Start​Time
  • Care​Observation​.​Observation​End​Time
  • Care​ObservationComponent​.​Observed​Value​​Numerator
  • Care​Observation​Component.​Observed​Value​​Denominator
  • Care​ObservationComponent​.​Observed​Value​​CodeId
  • Care​ObservationComponent​.​Observed​Value​​Text
  • Care​ObservationComponent​.​Is​Observed
  • Care​Observation​Component.​Observation​Start​Time
  • Care​ObservationComponent​.​Observation​End​Time
  • Attachment​.​ContentType
  • Attachment​.​Body
  • Patient​Medical​​Procedure​.ReportId
 Multiple Data types; Refer Object reference documentation N/A
OBX.6 - Units
  • Care​Observation​.​Observed​Value​​UnitId
  • Care​Observation​Component​.​Observed​Value​​UnitId
 Lookup: UnitOfMeasure N/A
OBX.7 - Reference Range
  • Care​Observation​​.Lower​Baseline​Value​
  • Care​Observation​​.Upper​Baseline​Value​
  • Care​Observation​Component​.Lower​Baseline​Value​
  • Care​Observation​Component​.Upper​Baseline​Value​
 Double N/A
OBX.8 - Abnormal Flags
  • Care​Observation​.​Value​Interpretation
  • Care​Observation​Component​.​Value​Interpretation
 Lookup: CodeSetBundle N/A
OBX.11 - Observation Result Status CareObservation.ObservationStatus Picklist N/A
OBX.14 - Date/Time of the Observation CareObservation.IssuedDateTime DateTime N/A
OBX.16 - Responsible Observer CareObservation.ObserverId Lookup: HealthcareProvider, Account N/A
OBX.16 - Responsible Observer CarePerformer Object The performer information for a ​Procedure is represented as Care​Performer records that reference the Patient​Medical​​Procedure record using their Care​Performer​.Parent​RecordId field​.
OBX.17 - Observation Method CareObservation.MethodId Lookup: CodeSetBundle N/A
# ORC - Common Order Segment The Common Order Segment (ORC) HL7 segment maps primarily to the ClinicalServiceRequest and MedicationRequest objects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for ORC map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below.
Table 1. ORC - Salesforce
ORC Salesforce Field Type Notes
ORC.1 - Order Control
  • ​​Clinical​Service​Request​.Status
  • ​​​Medication​​Request​.​Status
 Picklists N/A
ORC.2 - Place Order Number Identifier Object Place Order Number is created as an identifier record. This record will then reference the entity it belongs to using the ParentRecordId field.
ORC.3 - Fill Order Number Identifier Object Fill Order Number is created as an identifier record. This record will then reference the entity it belongs to using the ParentRecordId field.
ORC.4 - Placer Group Number ​​Clinical​Service​Request​.Service​Request​Group​Identifier​Id Lookup: Identifier N/A
ORC.5 - Order Status
  • ​​Clinical​Service​Request​.Status
  • ​​​Medication​​Request​.​Status
 Picklists N/A
ORC.7 - Quantity/Timing Clinical​Service​Request​.Quantity​Numerator Double N/A
ORC.7 - Quantity/Timing ​​Clinical​Service​Request​.Quantity​Denominator Double N/A
ORC.7 - Quantity/Timing Clinical​Service​Request​.Quantity​Numerator​Unit​Id Lookup: UnitOfMeasure N/A
ORC.9 - Date and Time of Transaction Clinical​Service​Request​.Date​Signed DateTime N/A
ORC.12 - Ordering Provider Clinical​Service​Request​.​Requester​Id Lookup: HealthcareProvider, Account, Asset N/A
ORC.12 - Order Control Code Reason
  • ​​Clinical​Service​Request​.ReasonCodeId
  • ​​​Medication​​Request​.​StatusReasonCodeId
 Lookup: CodeSetBundle N/a
# Order Management Order Management combines store check with quotes and pricing so field reps can assess a retail location and capture a priced quoted order from the same visit. Store check surfaces products, and quotes and pricing apply price books, pricing recipes, and sales transaction types to build, discount, and lock a quoted order. Both capabilities share visit and account, so a field rep can complete a store check and create a quoted order without switching context. ## Store Check Field reps use store check to assess product availability, display, and promotional compliance during a store visit. Store check structures those assessments so field reps see only the products and checks that apply to the store, based on products, territories, assortments, assessment tasks, and key performance indicators (KPIs). ![Store Check entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_store_check_data_model.png) Objects included in the license are either from Consumer Goods or Life Sciences. - For more information on Consumer Goods objects, see [Get Started with Consumer Goods Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/retail_get_started_with_cg.htm). - For more information on Life Sciences Cloud standard objects, see [Life Sciences Cloud Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm "Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform."). Life Sciences Cloud adds fields to these Consumer Goods objects. These fields are available only in orgs where Life Sciences Cloud is enabled. - [Fields on AssessmentIndicatorDefinition](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assessmentindicatordefinition_custom_fields.htm "Life Sciences Cloud fields extend the AssessmentIndicatorDefinition object to represent the default comparison rule for store checks.") - [Fields on Assortment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortment_custom_fields.htm "Life Sciences Cloud fields extend the Assortment object to represent the usage type for store checks.") - [Fields on AssortmentProduct](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortmentproduct_custom_fields.htm "Life Sciences Cloud fields extend the AssortmentProduct object to represent whether a product is required in an assortment.") - [Fields on RetailStoreKpi](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailstorekpi_custom_fields.htm "Life Sciences Cloud fields extend the standard RetailStoreKpi object to represent the target price for a store KPI.") - [Fields on RetailVisitKpi](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailvisitkpi_custom_fields.htm "Life Sciences Cloud fields extend the standard RetailVisitKpi object to represent actual and target prices captured during a store visit.") - [Fields on StoreAssortment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_storeassortment_custom_fields.htm "Life Sciences Cloud fields extend the standard StoreAssortment object to represent the store check type for an assortment associated with a store.") ## Pricing A pricing recipe determines which pricing operations run for a quoted order. A pricing procedure inside that recipe defines the sequence of pricing elements that run against each quote line (including list price, volume discounts, tiered volume discounts, condition-based discounts through a Price Adjustment Matrix) and header-level discounts. ![Pricing entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_pricing_data_model.png) Objects included in the license are either from Revenue Lifecycle Management or Life Sciences. - For more information on Revenue Lifecycle Management objects, see [Get Started with Revenue Management Developer Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/rlm_get_started.htm). - For more information on Life Sciences Cloud objects, see [Life Sciences Cloud Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm "Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform."). ## Quotes In Life Sciences, an order is referred to as a quoted order because the Quote object is used to create an order. Quote and quote line item store the quoted order and its products, quantities, prices, and discounts. From the same visit or account used for a store check, a field rep builds a quoted order, then submits it. ![Quotes entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_quotes_data_model.png) Objects included in the license are either from Revenue Lifecycle Management or Life Sciences. - For more information on Revenue Management objects, see [Get Started with Revenue Management Developer Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/rlm_get_started.htm). - For more information on Life Sciences Cloud standard objects, see [Life Sciences Cloud Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm "Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform."). Life Sciences Cloud adds fields to these standard objects. These fields are available only in orgs where Life Sciences Cloud is enabled. - [Fields on Quote](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quote_custom_fields.htm "Life Sciences Cloud fields extend the Quote object to represent visit, delivery, payment, and pricing information for quoted orders.") - [Fields on QuoteLineItem](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quotelineitem_custom_fields.htm "Life Sciences Cloud fields extend the QuoteLineItem object to represent free goods and total quantity on a quoted order line.") ## Product Catalog Product catalogs control which products field reps can see and add to a quoted order, based on territory and account. ![Product Catalog entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_product_catalog_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/product-catalog.html "HTML (New Window)"). Objects included in the license are either from Revenue Lifecycle Management or Life Sciences. - For more information on Revenue Management objects, see [Get Started with Revenue Management Developer Resources](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/rlm_get_started.htm). - For more information on Life Sciences Cloud objects, see [Life Sciences Cloud Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_sforce_api_objects.htm "Life Sciences Cloud standard objects store clinical, medical, and commercial information. Some platform objects used with Life Sciences Cloud are documented in the Object Reference for the Salesforce Platform."). ## Order Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Action Plan](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplan.htm) - [Action Plan Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplanitem_kam.htm) - [Action Plan Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_actionplantemplate_custom_fields.htm) - [Action Plan Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_actionplantemplateassignment.htm) - [Action Plan Template Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_actionplantemplateitem_custom_fields.htm) - [Action Plan Template Item Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateitemvalue.htm) - [Action Plan Template Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionplantemplateversion_pec.htm) - [Actionable List](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionablelist.htm) - [Actionable List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelistfiltercriteria.htm) - [Actionable List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_actionablelistmember.htm) - [Assessment Indicator Defined Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmentindicatordefinedvalue.htm) - [Assessment Indicator Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assessmentindicatordefinition_custom_fields.htm) - [Assessment Indicator Definition Extension](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_asmtinddefext.htm) - [Assessment Indicator Value](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmentindicatorvalue.htm) - [Assessment Task](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_assessmenttask.htm) - [Assessment Task Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmenttaskdefinition.htm) - [Assessment Task Indicator Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_assessmenttaskindicatordefinition.htm) - [Assortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortment_custom_fields.htm) - [Assortment Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_assortmentproduct_custom_fields.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Contact Point Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_contactpointaddress1.htm) - [Content Version](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contentversion.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Distribution Channel](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_distributionchannel.htm) - [Document Recipient](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_documentrecipient.htm) - [Life Science Account Group Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctgrpassignment.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Life Science Product Account Restriction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciproductacctrstrc.htm) - [Payment Term](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_paymentterm.htm) - [Price Adjustment Schedule](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_priceadjustmentschedule.htm) - [Price Adjustment Tier](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_priceadjustmenttier.htm) - [Pricebook](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_pricebook2.htm) - [Pricebook Entry](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_pricebookentry.htm) - [Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Product Catalog](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcatalog.htm) - [Product Category](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcategory.htm) - [Product Category Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productcategoryproduct.htm) - [Product Selling Model](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productsellingmodel.htm) - [Product Selling Model Option](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productsellingmodeloption.htm) - [Product Territory Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterritoryavailability.htm) - [Product Territory Detailed Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterrdtlavailability.htm) - [Provider Account Territory Information](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_provideracctterritoryinfo.htm) - [Quote](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quote_custom_fields.htm) - [Quote Document](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_quotedocument.htm) - [Quote Document Creation Event](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_quotedocumentcreationevent.htm) - [Quote Line Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_quotelineitem_custom_fields.htm) - [Retail Store KPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailstorekpi_custom_fields.htm) - [Retail Visit KPI](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_retailvisitkpi_custom_fields.htm) - [Sales Transaction Type](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_salestransactiontype.htm) - [Store Assortment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_storeassortment_custom_fields.htm) - [Territory](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Unit Of Measure](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_unitofmeasure.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Organization The Organization FHIR resource maps primarily to the Account object in Salesforce​. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [Organization](https://www.hl7.org/fhir/organization.html) map to the fields in Salesforce​.
Table 1. Organization - Salesforce
Organization Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for an organization is represented as Identifier records that reference the organization record using their Identifier​.Parent​RecordId field​.
active Account​.IsActive Boolean 0​.1 N/A
type Account​.Type Picklist 0.1 While FHIR defines account​.type as a zero-to-many code set bundle reference, its Salesforce implementation is a zero-to-one picklist​.
name Account​.Name String 0​.1 N/A
alias N/A N/A N/A Not supported
telecom Contact​Point​Phone Object 0​.M The telecom information for an organization is represented as Contact​Point​Phone records that reference the organization record using their Contact​Point​Phone​.ParentId field​.
address Contact​Point​Address Object 0​.M The address information for an organization is represented as Contact​Point​Address records that reference the organization record using their Contact​Point​Address​.ParentId field​.
contact Account​Contact​Relation​.ContactId Lookup: Contact 0​.M Contacts are connected to organizations using the Account​Contact​Relation junction object​. The Account​Contact​Relation​.AccountId field references the organization’s account record, and the Account​Contact​Relation​.ContactId field references the contact record of the contact’s person account​.
contact​.relationship Account​Contact​Relation​.Roles Multi-Select picklist 0​.M While FHIR defines organization​.contact​.purpose as a code set bundle, its Salesforce implementation is a picklist​.
contact​.name Person​Name Object 0​.M

The name information for a contact is represented as Person​Name records that reference the contact’s person account using their Person​Name​.Parent​RecordId field​.

While FHIR defines patient​.contact​.name as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​.
contact​.telecom Contact​Point​Phone Object 0​.M The telecom information for a contact is represented as Contact​Point​Phone records that reference the contact’s person account record using their Contact​Point​Phone​.ParentId field​.
contact​.address Contact​Point​Address Object 0​.M

The address information for a contact is represented as Contact​Point​Address records that reference the contact’s person account record using their Contact​Point​Address​.ParentId field​.

While FHIR defines patient​.contact​.address as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​.
contact​.endPoint N/A N/A N/A Not supported
# Original Denial Medical Director The name of the medical director who denied the original request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | username | String | username | Big, 46.0 | 46.0 | # Original Denial Medical Director Input The name of the medical director who denied the original request. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | username | String | Original Denial Medical Director’s username. | Yes | 46.0 | # Outcome Represents information about the expected change in participants that is driven by the organization's activity. This object is available in API version 59.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the outcome. ### IntendedDirection - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the intended direction of change in the behavior, knowledge, skills, status, or level of functioning that's detailed in the outcome. - **Possible values**: - Decrease - Increase - Maintain ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last referenced this outcome. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last viewed this outcome. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the outcome. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns the outcome. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### SourceName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source that initially defined the outcome. For example, United Nations Sustainable Development Goals (UNSDG). ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the outcome. - **Possible values**: - Active - Canceled - Completed - Planned ### Term - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the term for which the outcome is defined. - **Possible values**: - Long-Term - Medium-Term - Short-Term ## 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. [OutcomeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [OutcomeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [OutcomeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [OutcomeShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # OutcomeActivity Represents a junction between Outcome and the object that's related to the activity undertaken by an organization to achieve that outcome. This object is available in API version 59.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program associated with the outcome activity. This field is a relationship field. This field is available in API version 61.0 and later with the Patient Program Outcome Management permission set. - **Relationship Name**: CareProgram - **Relationship Type**: Lookup - **Refers To**: CareProgram ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last referenced this outcome activity. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time when a user last viewed this outcome activity. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the outcome activity. ### OutcomeActivityType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of activity that's associated with the outcome, such as care program. - **Possible values**: - Care Program —This value is available from API version 61.0 and later. ### OutcomeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The outcome that's associated with the outcome activity. This field is a relationship field. - **Relationship Name**: Outcome - **Relationship Type**: Master-Detail - **Refers To**: Outcome ## 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. [OutcomeActivityFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [OutcomeActivityHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. # Output Classes These are the Apex output classes for Life Sciences Cloud. - **[ConnectApi.GenericResponseOutputRepresentation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_connect_api_output_generic_response_output.htm)** Output representation for a generic response from a Connect API call. # Page Products Input Input representation that contains the product and guidance IDs associated with a presentation page. ## Properties | Property Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | guidance​Ids | List | List of guidance IDs. | Optional | 65.0 | | product​Id | String | ID of the product. | Optional | 65.0 | # Page Specification Input Input representation of the page specification details. ## Root XML tag ## Properties
Name Type Description Required or Optional Available Version
addToTargetFile Boolean Indicates whether the page must to be added to the target file (true) or not (false). Required 55.0
page Integer The page number of the document to be split. Required 55.0
rotation Integer The angle at which the page needs to be rotated.

Valid values are: 0, 90, 180, 270, or 360.

 Required 55.0
# Page Specification List Input Input representation of the page specification list. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | pageSpecifications | [Page Specification](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_page_specificatio.htm "Input representation of the page specification details.") | Represents the page specification details of the content document that needs to be split. | Required | 55.0 | # Participant Management Participant Management data model helps you to streamline the recruitment and enrollment processes in clinical trials with advanced digital solutions. With this data model, you can store clinical trial data representing care programs and research studies. It’s USCDI and FHIR R4-aligned, which helps with your system's interoperability and compliance while managing participant data efficiently.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Life Sciences or Health Cloud
Participant data in clinical trials is essential in the Life Sciences industry as it helps you track and manage participants' enrollment journey. This data model is your key to collecting information on participants and monitoring the effectiveness and safety of clinical trials. The Participant Management data model allows you to store clinical trial data representing care program management and research studies. Participant Management uses Care Program Management objects to improve patient outcomes. It also uses the Discovery Framework objects to build more complex prescreening assessment forms and questions to check participants' eligibility. To learn more about Care Program Management objects and Discovery Framework objects, refer [Care Program Management](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_care_program_data_model.htm) and [Discovery Framework Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.250.0.industries_reference.meta/industries_reference/discovery_framework_standard_objects.htm). Participant Management also reuses some of the standard Salesforce objects to digitize the Consent Management flow. You can add consent documents to clinical trials by associating them with the related care program and defining their data use purpose. To learn more about the standard objects used for e-consents, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). The participant management objects are available to users with Health Cloud Starter and the Participant Enrollment Add-On license. Available in API version 61.0 and later. ![Participant Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_participant_management_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/participant-management.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # PartyIndicatorResult Represents information about a party for which the indicator result is calculated. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available in products where the Health Cloud Foundation (for Health Cloud) or Health Cloud Starter (for Life Sciences Cloud), and Patient Program Outcome Management permission sets are assigned to users. ## Fields ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the care program enrollee record associated with the party indicator result. This field is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Refers To**: CareProgramEnrollee ### IndicatorResultId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the indicator result record associated with the party. This field is a relationship field. - **Relationship Name**: IndicatorResult - **Refers To**: IndicatorResult ### MeasurementDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the party indicator result is measured. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the party indicator result. ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The object for which the indicator result is calculated. This field is a relationship field. - **Relationship Name**: Party - **Refers To**: CareProgramEnrollee ### ResultValue - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The result value that's used to score the party. ## Usage ## 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. [PartyIndicatorResultFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PartyIndicatorResultHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [PartyIndicatorResultShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # PartyPublication Represents the details of a party's publication. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CitationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of citations the publication has. This field is available in Account Management feature in API version 65.0 and later. ### ImpactFactor - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The number of times the publication is listed. This field is available in Account Management feature in API version 65.0 and later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### ListingPlatformType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The listing platform the publication is listed on. This field is available in Account Management feature in API version 65.0 and later. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the party publication. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID associated with party publication. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Refers To**: Account, HealthcareProvider, Individual ### PartyRoleType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of the author of the publication. Examples include the primary or secondary author. This field is available in Account Management feature in API version 65.0 and later. ### PublicationCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The publication category of where the publication was published. This field is available in Account Management feature in API version 65.0 and later. ### PublicationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which the publication is available. ### PublicationIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external ID associated with the publication. ### PublishedOn - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source where the publication was published, if it appears in multiple journals. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: That status of the publication. This field is available in Account Management feature in API version 65.0 and later. ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The summary of the publication. ### Title - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The full title of the publication. ### Url - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The link or URL to the publication. ## 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. [PartyPublicationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [PartyPublicationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PartyPublicationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PartyPublicationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Patient The Patient FHIR resource maps to the Account and Contact objects in Salesforce​. Patients are modeled using Person Accounts. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [Patient](https://www.hl7.org/fhir/patient.html#patient) map to the fields in Salesforce​.
Table 1. Patient - Salesforce
Patient Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for a patient is represented as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field​.
active Account​.IsActive Boolean 0​.1 N/A
name Person​Name Object 0​.M The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.Parent​RecordId field​.
telecom Contact​Point​Phone Object 0​.M The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​.
gender Contact​.Gender Picklist 0​.1 While FHIR defines patient​.gender as a code set, its Salesforce implementation is a picklist​.
birth​Date Contact​.Birthdate ​Date 0​.1 N/A
deceased​.deceased​Boolean N/A N/A N/A Not supported
deceased​.deceased​Date​Time Contact​.Deceased​Date ​DateTime 0​.1 While FHIR defines patient​.deceased as either a boolean or a date, Salesforce supports only a date​.
address Contact​Point​Address Object 0​.M The address information for a patient is represented as Contact​Point​Address records that reference the patient record using their Contact​Point​Address​.ParentId field​.
marital​Status Contact​.Marital​Status Picklist 0​.1 While FHIR defines patient​.marital​Status as a code set bundle, its Salesforce implementation is a picklist​.
multiple​Birth​.multiple​Birth​Boolean N/A N/A N/A Not supported
multiple​Birth​.multiple​Birth​Integer Contact​.Sequence​In​Multiple​Birth Double 0​.1 While FHIR defines patient​.multiple​Birth as either a boolean or an integer, Salesforce supports only an integer​.
photo N/A N/A N/A Not supported
contact Contact​Contact​Relation__c​.RelatedContact__c Lookup: Contact 0​.M Contacts are connected to patients using the Contact​Contact​Relation__c junction object​. The Contact​​Contact​​Relation__c​​.Contact__c field references the contact record of the patient’s person account, and the Contact​​Contact​​Relation__c​​.Related​Contact__c field references the contact record of the contact’s person account​.
contact​.relationship Contact​​Contact​​Relation__c​​.Role__c Lookup: ReciprocalRole__c 0​.M While FHIR defines patient​.contact​.relationship as a code set bundle, its Salesforce implementation is a reference to ReicprocalRole__c​.
contact​.name Person​Name Object 0​.M

The name information for a contact is represented as Person​Name records that reference the contact record of the contact’s person account using their Person​Name​.Parent​RecordId field​.

While FHIR defines patient​.contact​.name as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​.
contact​.telecom Contact​Point​Phone Object 0​.M The telecom information for a contact is represented as Contact​Point​Phone records that reference the contact’s person account record using their Contact​Point​Phone​.ParentId field​.
contact​.address Contact​Point​Address Object 0​.M

The address information for a contact is represented as Contact​Point​Address records that reference the contact’s person account record using their Contact​Point​Address​.ParentId field​.

While FHIR defines patient​.contact​.address as a zero-to-one resource, the Salesforce implementation can support zero-to-many references​.
contact​.gender Contact​.Gender Picklist 0​.1 While FHIR defines patient​.contact​.gender as a code set, its Salesforce implementation is a picklist​.
contact​.organization N/A N/A N/A Not supported
contact​.period Contact​​Contact​​Relation__c​​.StartDate__c ​Date 0​.1 Because Salesforce doesn’t support a native period data type, the patient​.contact​.period FHIR resource is flattened to a set of from and to dates​.
contact​.period Contact​​Contact​​Relation__c​​.EndDate__c ​Date 0​.1 Because Salesforce doesn’t support a native period data type, the patient​.contact​.period FHIR resource is flattened to a set of from and to dates​.
communication Person​Language Object 0​.M The language information for a patient is represented as Person​Language records that reference the patient record using their Person​Language​.IndividualId field​.
communication​.language Person​Language​.​Language Picklist 0​.1 While FHIR defines patient​.communication​.language as a code set bundle, its Salesforce implementation is a picklist​.
communication​.preferred Person​Language​.Rank Double 0​.1 While FHIR defines patient​.communication​.preferred as a boolean, its Salesforce implementation is an integer field that ranks the degree of preference​.
general​Practitioner Contact​Contact​Relation__c​.RelatedContact__c Lookup: Contact 0​.M

Practitioners are connected to patients using the Contact​Contact​Relation__c junction object​. The Contact​​Contact​​Relation__c​​.Contact__c field references the contact record of the patient’s person account, and the Contact​​Contact​​Relation__c​​.Related​Contact__c field references the contact record of the practitioner’s person account​.

Salesforce doesn't support Practitioner​Role type values for patient.​general​Practitioner
managing​Organization Account​Contact​Relation​.AccountId Lookup: Account 0​.M Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​. The Account​Contact​Relation​.AccountId field references the account record of the patient’s organization, and the Account​Contact​Relation​.ContactId field references the contact record of the patient’s person account​.
link N/A N/A N/A Not supported
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how a patient Charles Green is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_patient.png) # Patient Communication Language The output representation of the PersonLanguage records that represent the communication preferences of a person. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | language | String | The language specified for communication. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | preferenceRank | Integer | The ranked order of preference the person has for being communicated with using the language. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the PersonLanguage record that represents the communication preferences of a person. | Small, 53.0 | 53.0 | # Patient Communication Language Input Input representation of the patient communication language. The PatientCommunicationLanguage FHIR object maps to the [PersonLanguage](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PersonLanguage.htm "HTML (New Window)") object in Salesforce. ## JSON example "PatientCommunicationLanguage": \[ { "language": "High Elvish", "preferenceRank": 2 } \] ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | language | String | The language used by the person. | Optional | 53.0 | | preferenceRank | Integer | The ranked order of preference the person has for the language as a medium of communication. | Optional | 53.0 | # Patient Contact Party The output representation of contact parties associated with a patient. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_custom_field_value_output.htm "The output representation of the custom field values.")\[\] | The data stored in any custom fields as specified in the input request. | Small, 53.0 | 53.0 | | address | [FHIR Address](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_address_output.htm "The output representation of the FHIR address values.") | The address associated with the contact party, stored as ContactPointAddress records. | Small, 53.0 | 53.0 | | contactContact​RelationId | String | The Salesforce ID of the junction record that connects the patient and the contact party. | Small, 53.0 | 53.0 | | gender | String | The gender of the contact party. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can encounter while processing the request. | Small, 53.0 | 53.0 | | name | [FHIR Human Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_human_name_output.htm "The output representation of a PersonName record created to represent a humanName value.") | The names of the contact party, specified as PersonName records. | Small, 53.0 | 53.0 | | organisation | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.") | The organization associated with the contact party. | Small, 53.0 | 53.0 | | periodEnd | String | The date until when the person is a valid contact for the patient. | Small, 53.0 | 53.0 | | periodStart | String | The date from when the person is a valid contact for the patient. | Small, 53.0 | 53.0 | | relationship | [FHIR Codeable Concept](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_codeable_concept_output.htm "The output representation of the Code Set Bundle records created to represent a codeableConcept value.") | The type of relationship between the contact party and the patient, specified with Reciprocal Role records. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the Person Account record that represents the contact party. | Small, 53.0 | 53.0 | | telecom | [FHIR Contact Point](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_contact_point_output.htm "The output representation of contact details stored as a ContactPointPhone record.")\[\] | The contact details of the contact party. For example, phone numbers and email addresses. | Small, 53.0 | 53.0 | # Patient Contact Party Input The input representation of the patient contact party. ## JSON example { "PatientContactParty": \[ { "relationship": { "coding": \[ { "display": "relative" } \] }, "name": { "use": "official", "text": "Shawna Green", "family": "Green", "given": "Shawna", "prefix": "Mrs.", "suffix": "Sr." }, "telecom": \[ { "system": "email", "value": "c@d3.com" }, { "system": "phone", "value": "12345678", "use": "temp", "rank": 1 } \], "address": { "use": "temp", "type": "postal", "line": "Green Household" }, "organization": { "referenceResource": "Green Family Business", "referenceId": "XYZId" }, "gender": "female", "periodStart": "1998-05-26T15:40:30.000Z", "periodEnd": "2021-08-09T15:40:30.000Z", } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | address | [FHIR Address Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_address.htm "Input representation for the Address FHIR object.") | The address associated with the contact party, stored as ContactPointAddress records. | Optional | 53.0 | | gender | String | The gender of the contact party. | Optional | 53.0 | | name | [FHIR Human Name Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_human_name.htm "The input representation for the name of a person and all its associated metadata.") | The name of the contact party, stored as PersonName records. | Optional | 53.0 | | organisation | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.") | The organization associated with the contact party. | Optional | 53.0 | | periodEnd | String | The date until when the contact is associated with the patient. | Optional | 53.0 | | periodStart | String | The date from when the contact is associated with the patient. | Optional | 53.0 | | relationship | [FHIR Codeable Concept Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_codeable_concept.htm "Input representation for the Codeable​Concept FHIR object.") | The type of relationship between the contact party and the patient, recorded using a reference to Reciprocal Roles. | Optional | 53.0 | | telecom | [FHIR Contact Point Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_contact_point.htm "Input representation for the ContactPoint FHIR object.")\[\] | The telecom information for the contact party, stored as ContactPointPhone records. | Optional | 53.0 | # Patient Engagement These objects are available for Life Sciences Cloud for Patient Engagement. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). - **[Advanced Therapy Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_advanced_therapy_management_data_model.htm)** Advanced Therapy Management helps streamline complex procedures that involve multiple appointments across different locations. Use Advanced Therapy Management’s Multi-Step Scheduling solution for easy scheduling of appointments for program participants. Configure procedure steps based on lead times and set up affiliated service territories to establish where work types are sequentially performed. - **[Care Program Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_care_program_data_model.htm)** Drive increased adherence and improve patient outcomes using the care program management data model. Now you can enroll and manage patients to achieve the maximum impact of your programs. - **[Clinical Data Model](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_clinical_data_model.htm)** Patient data and healthcare records are important in the healthcare industry. Without accurate information, performing and managing care becomes difficult. These records are readily available if a patient seeks care from the same provider every time. However, in reality, a patient’s healthcare journey takes them to multiple providers and hospitals at different times. Because the patient’s health hinges on the accuracy of their medical records, it’s crucial for the systems used by different providers and hospitals to be interoperable. And to make this interoperability 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. - **[Electronic Signatures](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_electronic_signatures_data_model.htm)** Manage electronic signatures by using Digital Verifications. Set up signature trails for records or workflows that require users to verify key updates. Define signature details such as the order of designated verifiers and whether designated verifiers belong to a user group or have a specific participant role. - **[Financial Assistance Program](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_financial_assistance_program_data_model.htm)** The financial assistance program data model helps life sciences organizations implement several financial assistance programs for eligible patients to receive assistance with their out of pocket medical expenses. - **[Health Insurance](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_membership_data_model.htm)** The health insurance data model provides objects for managing the ways care is paid for. It represents information about participants such as employment, insurance coverage, and dependents. You can manage details of the benefits provided by plans to members and treatment preauthorization requests made by members or providers. - **[Intelligent Document Automation](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_document_management_data_model.htm)** Use the Intelligent Document Automation data objects to simplify the document management process, reduce manual data entry, and get patients the right care and services faster by managing patient and member forms all in one place, from intake through processing. - **[Patient Program Outcome Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_patient_program_outcome_management_data_model.htm)** Patient Program Outcome Management data model helps you to improve patient and program outcomes by defining and measuring program outcomes, linking patient progress to program outcomes. Program Leads can define outcomes for a care program, and can generate a program and patient outcome summary. Additionally, case agents can generate a patient outcome summary. - **[Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_pharmacy_benefits_verification_data_model.htm)** Pharmacy Benefits Verification uses a data model that’s FHIR-CARIN and NCPDP aligned to store its data and make it interoperable. The pharmacy benefits verification data model supports drug manufacturers, providers, pharmacists, and life sciences organizations in determining pharmacy benefits coverage for the medications prescribed to the patients under a care program. - **[Provider Relationship Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_provider_data_model_overview.htm)** Use the Provider Relationship Management data model along with standard Salesforce objects to manage your provider relationships. - **[Social Determinants](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_social_determinants_data_model.htm)** The social determinants data model represents the barriers, health determinants, and interventions for a patient or member. Available in API version 45.0 and later. - **[Timeline](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_api_timeline_standard_objects.htm)** Use Timeline to configure a chronological view of records from multiple objects. # Patient Get Output representation of details of a patient record. ## JSON example { "active": true, "identifier": \[ { "assigner": { "referenceResource": "Organization", "referenceId": "Org12345XYZ" }, "type": { "text": "Passport Number", "coding": \[ { "display": "Passport number", "code": "PPN", "isActive": true, "use": "Identifier" } \] }, "value": "ABCD5678XYZ" } \], "name": \[ { "use": "alias", "text": "Charles Green", "family": "Green", "given": "Charles", "prefix": "Mr.", "suffix": "Sr." } \], "communication": \[ { "language": "English", "preferenceRank": 1 } \], "address": \[ { "use": "temp", "type": "postal", "line": "Green Household" } \], "telecom": \[ { "system": "email", "value": "a@bc.com" } \], "gender": "male", "birthDate": "2000-09-12T18:13:41Z", "maritalStatus": "married", "contact": \[ { "relationship": { "coding": \[ { "display": "Partner" } \] }, "name": { "use": "Temp", "text": "Shawna Green", "family": "Green", "given": "Shawna", "prefix": "Mrs.", "suffix": "Jr." }, "telecom": \[ { "system": "email", "value": "c@de.com" }, { "system": "phone", "value": "12345678", "use": "temp", "rank": 1 } \], "address": { "use": "temp", "type": "postal", "line": "Green Household" } } \], "sourceSystemId":"567890", "deceasedDateTime": "2023-02-10T10:40:13.000Z", "salesforceId":"0NBRM0000004CGx4AM", "generalPractitioner": \[ { "referenceResource": "Practitioner", "referenceId": "PRAC789XYZ", "relationship": "Plastic Surgeon" } \], "managingOrganisation": { "referenceResource": "Organization", "referenceId": "MI9007GBE" } } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | active | Boolean | Indicates whether the patient record is active or not. | Small, 53.0 | 53.0 | | address | [FHIR Address](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_address_output.htm "The output representation of the FHIR address values.")\[\] | The addresses of the patient, stored as contact point address records. | Small, 53.0 | 53.0 | | birthDate | String | The date of birth of the patient, recorded in Date format. | Small, 53.0 | 53.0 | | communication | [Patient Communication Language](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_communication_language_output.htm "The output representation of the PersonLanguage records that represent the communication preferences of a person.")\[\] | The languages of communication associated with the patient, recorded in the PersonLanguage object. | Small, 53.0 | 53.0 | | contact | [Patient Contact Party](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_contact_party_output.htm "The output representation of contact parties associated with a patient.")\[\] | The contact party associated with the patient record. Contacts are connected to patients using a Contact​Contact​Relation\_\_c junction record. | Small, 53.0 | 53.0 | | deceasedDateTime | String | The date and time of the patient’s death. | Small, 53.0 | 53.0 | | gender | String | The gender of the patient. | Small, 53.0 | 53.0 | | general​Practitioner | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.")\[\] | The practitioner associated with the patient. Practitioners are connected to patients using a Contact​Contact​Relation\_\_c junction record​. | Small, 53.0 | 53.0 | | identifier | [FHIR Identifier](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_identifier_output.htm "The output representation of the Identified records created to represent an identifier value.")\[\] | The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field. | Small, 53.0 | 53.0 | | managing​Organisation | [FHIR Reference](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_reference_output.htm "The output representation of the FHIR reference values.")\[\] | The organization that manages the patient recorded. Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​. | Small, 53.0 | 53.0 | | maritalStatus | String | The current marital status of the patient. | Small, 53.0 | 53.0 | | message | String | A message with any errors that can have been encountered while processing the request. | Small, 53.0 | 53.0 | | multiple​BirthInteger | Integer | The birth order of the patient in a multiple-birth event. | Small, 53.0 | 53.0 | | name | [FHIR Human Name](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_human_name_output.htm "The output representation of a PersonName record created to represent a humanName value.")\[\] | The person name of the patient. | Small, 53.0 | 53.0 | | resourceType | String | Reserved for future use. | Small, 53.0 | 53.0 | | salesforceId | String | The Salesforce ID of the Person Account record that represents the patient. | Small, 53.0 | 53.0 | | sourceSystemId | String | The record identifier of the patient’s record in its source system. | Small, 53.0 | 53.0 | | telecom | [FHIR Contact Point](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_fhir_contact_point_output.htm "The output representation of contact details stored as a ContactPointPhone record.")\[\] | The contact details of the patient, including phone numbers and email addresses. | Small, 53.0 | 53.0 | # Patient Input Input containing data for a single patient. ## Root XML tag ## JSON example { "patientId": "patient2", "careProgramProductData": \[ { "providerId": "provider3", "productId": "product4" } \] } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | careProgramProductData | [Enrollee Product Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_enrollee_product_input.htm "Data for a single enrollee product.")\[\] | List of all objects that contain data related to the enrollee’s care program product. | No | 46.0 | | patientId | String | ID of the patient as configured in the care system field mappings. | Yes | 46.0 | # Patient Program Outcome Management Patient Program Outcome Management data model helps you to improve patient and program outcomes by defining and measuring program outcomes, linking patient progress to program outcomes. Program Leads can define outcomes for a care program, and can generate a program and patient outcome summary. Additionally, case agents can generate a patient outcome summary.
Available in: Lightning Experience
Available in: Enterprise and Unlimited Editions with Health Cloud or Life Sciences Cloud
Patient Program Outcome Management reuses Care Program Management standard objects to calculate the outcomes at a care program level. To learn more about Care Program Management objects, refer [Care Program Management Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_care_program_data_model.htm). The patient program outcome management objects are available to users with Health Cloud Starter and Patient Program Outcome Management permission set. Available in API version 61.0 and later. ![Patient Program Outcome Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_patient_program_outcome_management_erd.png) To view a larger version, right-click or control-click the image and select **Open Image in New Tab**. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Patient Update Output representation of result after a Patient FHIR resource is updated.
Property Name Type Description Filter Group and Version Available Version
code Integer The error in case of failure. Small, 53.0 53.0
errorCode Integer The error code in case of failure. Small, 53.0 53.0
errorMessage String The error message in case of failure. Small, 53.0 53.0
status String Specifies the status of the request.
Possible values are:
  • Failure—Specifies that the update request of the Patient FHIR resource couldn’t be completed.
  • PartialSuccess—Specifies that the update request of the Patient FHIR resource is partially completed.
  • Success—Specifies that the update request of the Patient FHIR resource is successfully completed.
Small, 53.0 53.0
# Patient Upsert Output representation of result after a Patient FHIR resource is created.
Property Name Type Description Filter Group and Version Available Version
errorCode Integer The error code in case of failure. Small, 53.0 53.0
errorMessage String The error message in case of failure. Small, 53.0 53.0
failedCount Integer Specifies the failed count number. Small, 53.0 53.0
failedRecords FHIR Patient[] Represents the failed records. Small, 53.0 53.0
status String Specifies the status of the request.
Possible values are:
  • Failure—Specifies that the upsert request of the Patient FHIR resource couldn’t be completed.
  • Success—Specifies that the upsert request of the Patient FHIR resource is successfully completed.
Small, 53.0 53.0
successRecords FHIR Patient[] Represents the records that got successfully created. Small, 53.0 53.0
# PatientHealthReaction Represents a patient’s adverse reaction to an allergy, intolerance, or immunization. This object is available in API version 51.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CausativeSubstanceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the substance that triggered the reaction. - **Referenced Objects**: - CodeSetBundle ### Details - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional information about the reaction and, if required, the manifested symptoms. ### ExposureRouteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the route of exposure related to the reaction. - **Referenced Objects**: - CodeSetBundle ### IsSelfReported - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the reaction was reported by the patient. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### ManifestedSymptomId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents the manifested symptom. - **Referenced Objects**: - CodeSetBundle ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the PatientHealthReaction record. ### ObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observation that provides additional information about the reaction. - **Referenced Objects**: - CareObservation ### ParentId - **Type**: Polymorphic master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The imm unization or allergy intolerance that this reaction is a result of. - **Referenced Objects**: - AllergyIntolerance - PatientImmunization ### ReactionDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time of the reaction. ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the severity of the reaction. - **Possible values**: - Mild - Moderate - Severe ## Usage PatientHealthReaction records are used to add more information to AllergyIntolerance and PatientImmunization records in the event of the patient experiencing an adverse reaction related to those events. The PatientHealthReaction record is associated to the AllergyIntolerance or PatientImmunization records using the ParentId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PatientHealthReactionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PatientHealthReactionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PatientHealthReactionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # PatientImmunization Represents information about a patient’s immunizations. 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() ## Additional Information for PatientImmunization in Other Objects In addition to creating a record using these fields, you can add more details to your PatientImmunization record by creating records in certain other objects, and referencing your PatientImmunization record as the parent record. Here’s the list of objects you can associate to PatientImmunization in this way, the type of information they add, and the field they use to reference PatientImmunization. | Object | Type of Information | Reference Field | | --- | --- | --- | | Identifier | Associates an identifier value to the patient immunization. | ParentRecordId | | Patient Health Reaction | Adds information about a patient’s adverse reaction to an immunization, if any. | ParentId | | Patient Immunization Protocol | Adds information about this protocols followed by a provider during the immunization. This object enables the support of one-to-many values between immunization and protocols applied. | PatientImmunizationId | ## Fields ### CareObservationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observation that determined the need for the immunization. - **Referenced Objects**: - CareObservation ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter that the immunization was a part of. - **Referenced Objects**: - ClinicalEncounter ### CurrentDose - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current dose the patient is on in the total number of doses recommended for immunization. ### DiagnosticSummaryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The diagnostic summary that determined the need for the immunization. - **Referenced Objects**: - DiagnosticSummary ### Dose - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of vaccine that was administered. ### DoseUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the amount of vaccine that was administered. - **Referenced Object**: UnitOfMeasure ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the immunization is expected to expire. ### FacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare facility where the immunization was performed. - **Referenced Objects**: - HealthcareFacility ### HealthConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition that determined the need for the immunization. - **Referenced Objects**: - HealthCondition ### ImmunizationRecommendation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The protocol that was followed for the immunzation. ### InformationSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the source that provided information about the immunization. - **Referenced Objects**: - CodeSetBundle ### IsRecordedByVaccinator - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the immunization record was recorded by the vaccinator. ### IsSubpotent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the vaccination dose was sub-potent. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### LotNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The lot number of the vaccine. ### Manufacturer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the vaccine’s manufacturer. ### ManufacturerAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the organization that manufactured the vaccine. - **Referenced Objects**: Account ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the patient immunization record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the patient immunization record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient who was immunized. - **Referenced Objects**: - Account ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the reason for the immunization. - **Referenced Objects**: - CodeSetBundle ### RecommendedDoses - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Total number of doses recommended to achieve immunity. ### RecommendingAuthority - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authority or organization that recommended the vaccination protocol that was followed. ### RecordCreationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the patient immunization record was created. ### RouteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the route followed in the vaccine administration. - **Referenced Objects**: - CodeSetBundle ### SiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the site of the vaccine administration on the patient’s body. - **Referenced Objects**: - CodeSetBundle ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the immunization record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the immunization record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the immunization record was last modified in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the vaccination. - **Possible values**: - Completed - Entered in Error - Not Done ### StatusReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the reason for the status of the vaccination. - **Referenced Objects**: - CodeSetBundle ### SubpotencyReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the reason for why the vaccination was sub-potent. - **Referenced Objects**: - CodeSetBundle ### TargetDiseaseCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the disease that was targeted in the immunization. - **Referenced Objects**: - CodeSetBundle ### VaccinationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time of the vaccination. If you specify a vaccination date, you can’t specifiy a vaccination period. ### VaccinationPeriod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The period of time during which the vaccination happened. If you specify a vaccination period, you can’t specify a vaccination date. ### VaccineCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents vaccine that was administered in the immunization. - **Referenced Objects**: - CodeSetBundle ## 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. [PatientImmunizationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [PatientImmunizationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PatientImmunizationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PatientImmunizationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [PatientImmunizationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # PatientImmunizationProtocol Represents the protocol followed by a provider for a patient’s immunization and its related details. The protocol defines the set of recommendations that are followed while a vaccine is administered. This object is a child of the PatientImmunization object. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentDose - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current dose the patient is on in the total number of doses recommended for immunization. ### ImmunizationRecommendation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the protocol that was followed for the immunization. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the PatientImmuizationProtocol record. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Relationship Name**: Owner - **Refers To**: - Group - User ### PatientImmunizationId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent PatientImmunization record that the applied protocol is a part of. - **Relationship Name**: PatientImmunization - **Refers To**: PatientImmunization ### RecommendedDoses - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### RecommendingAuthority - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Total number of doses recommended to achieve immunity. ### TargetDisease1CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization - **Relationship Name**: TargetDisease1Code - **Refers To**: CodeSetBundle ### TargetDisease2CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization - **Relationship Name**: TargetDisease2Code - **Refers To**: CodeSetBundle ### TargetDisease3CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization This field is a relationship field. - **Relationship Name**: TargetDisease3Code - **Refers To**: CodeSetBundle ### TargetDisease4CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization This field is a relationship field. - **Relationship Name**: TargetDisease4Code - **Refers To**: CodeSetBundle ### TargetDisease5CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization This field is a relationship field. - **Relationship Name**: TargetDisease5Code - **Refers To**: CodeSetBundle ### TargetDisease6CodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents a disease that was targeted in the immunization This field is a relationship field. - **Relationship Name**: TargetDisease6Code - **Refers To**: CodeSetBundle ## 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. [PatientImmunizationProtocolFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PatientImmunizationProtocolHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PatientImmunizationProtocolOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 57.0) Sharing rules are available for the object. [PatientImmunizationProtocolShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 57.0) Sharing is available for the object. [PatientImmunizationProtocolChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. # PatientMedicalProcedure Represents detailed information about a healthcare procedure the patient has undergone, is undergoing or will undergo. 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() ## Additional Information for PatientMedicalProcedure in Other Objects In addition to creating a record using these fields, you can add more details to your PatientMedicalProcedure record by creating records in certain other objects, and referencing your PatientMedicalProcedure record as the parent record. Here’s the list of objects you can associate to PatientMedicalProcedure in this way, the type of information they add, and the field they use to reference PatientMedicalProcedure. | Object | Type of Information | Reference Field | | --- | --- | --- | | CarePerformer | Specifies the person who performed the procedure. | ParentRecordId | | Identifier | Associates an identifier value to the procedure. | ParentRecordId | | PatientMedicalProcedureDetail | Associates the procedure with various other records and defines the nature of association. For instance, if the procedure is based on, part of, or a follow up of the associated record, and so on. | PatientMedicalProcedureId | ## Fields ### AssertionSourceId - **Type**: Polymorphic Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who made the statement about the procedure. - **Example**: The patient or the provider who assessed the patient’s condition. - **Referenced Objects**: - Account - HealthcareProvider ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The patient’s clinical encounter that the procedure is a part of. - **Referenced Objects**: - ClinicalEncounter ### CodeId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that identifies a procedure. - **Example**: The SNOMED code for frontal sinusectomy. - **Referenced Object**: CodeSetBundle ### DurationTimeString - **Type**: String - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration of the procedure in string format. - **Example**: 2 hours ### EndDate - **Type**: DateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time that the procedure ended or the end date of the estimated period within which the procedure was performed. - **Example**: 1993-11-09T18:30:00.384Z ### FacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The heathcare facility where the procedure is performed. - **Referenced Object**: HealthcareFacility ### LastReferencedDate - **Type**: DateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time the last time this record was referenced. ### LastViewedDate - **Type**: DateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time the last time this record was viewed. ### Name - **Type**: Dtring - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. This is automatically generated when the record is saved. - **Example**: PMP-7396 ### Outcome - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the outcome for the procedure. - **Possible values**: - Partially successful - Successful - Unsuccessful ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the patient medical procedure record. Available in API version 56.0 and later. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-Detail Reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient on whom the procedure was performed. - **Example**: Charles Green - **Referenced Object**: Account ### PerformedAgeRangeUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the performed at age upper and lower limit fields. - **Referenced Object**: UnitOfMeasure ### PerformedAtAge - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The patient’s age when the procedure was performed. ### PerformedAtAgeLowerLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lower limit for the range of the patient’s age when the procedure was performed ### PerformedAtAgeUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the PerformedAtAge field. - **Referenced Object**: UnitOfMeasure ### PerformedAtAgeUpperLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The upper limit for the range of the patient’s age when the procedure was performed ### ReasonCodeId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason for the procedure. - **Example**: The SNOMED code for paraparesis. - **Referenced Object**: CodeSetBundle ### ReasonReferenceId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The event that warranted the procedure. - **Referenced Objects**: - HealthCondition - CareObservation - PatientMedicalProcedure - DiagnosticSummary - **Example**: Chronic sinusitis, a record in HealthCondition. ### RecordCreatorId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who created the record. - **Referenced Objects**: - Account - HealthcareProvider - **Example**: Dr. Carol Peterson ### ReportId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The report associated with this procedure.. - **Example**: Charles Green’s sinusectomy report. - **Referenced Object**: DiagnosticSummary ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in its source system. ### StartDate - **Type**: DateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time that the procedure began or the start date of the estimated period within which the procedure was performed. This field can be used in two ways to indicate the date and time of the procedure: - 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 the end of the period. - **Example**: 1993-11-09T21:45:00.384Z ### Status - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. Specifies the status of the procedure. - **Possible values**: - Completed - Entered in error - In Progress - Not Done - On Hold - Preparation - Stopped - Unknown ### StatusReasonCodeId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the reason for the status. - **Example**: The SNOMED code for ‘Procedure not ordered’ - **Referenced Object**: CodeSetBundle ### TypeId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that specifies the procedure's type. - **Example**: The SNOMED code for ‘Surgical procedure’ - **Referenced Object**: CodeSetBundle ## 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. [PatientMedicalProcedureChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 58.0) Change events are available for the object. [PatientMedicalProcedureOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 56.0) Sharing rules are available for the object. [PatientMedicalProcedureShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 56.0) Sharing is available for the object. # PatientMedicalProcedureDetail 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailCodeId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a code set or code set bundle that adds information to a patient medical procedure record. - **Referenced Objects**: - CodeSet - CodeSetBundle ### DetailRecordId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a record that adds information to a patient medical procedure record. - **Referenced Objects**: - PatientMedicalProcedure - CareObservation - HealthCondition - ClinicalServiceRequest - CareRegisteredDevice ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of information added to the patient medical procedure record. - **Possible values**: - Based On - Body Site - Complication - Complication Detail - Follow Up - Part Of ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the patient medical procedure detail record. ### PatientMedicalProcedureId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient medical procedure to which details are being added. - **Referenced Objects**: - PatientMedicalProcedure ## Usage PatientMedicalProcedureDetail records add additional information to PatientMedicalProcedure records. This information may be of the following 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 The records providing this additional information is selected using either the DetailCodeId or DetailRecordId fields, and then the type of information is specified using the DetailType field. This information is then connected to the patient medical procedure 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 instances are required in the parent procedure record, multiple records of PatientMedicalProcedureDetail are required. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PatientMedicalProcedureDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API Version 62.0) Change events are available for the object. [PatientMedicalProcedureDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PatientMedicalProcedureDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # 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. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInstruction - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The supplemental instructions or warnings associated with the medication for the patient. ### Comments - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments associated with the medication dosage for the patient. ### DosageDefinitionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies how the dosage was determined. - **Possible values**: - Calculated - Ordered ### DosageQuantityDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range. ### DosageQuantityNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range. ### DosageQuantityType - **Type**: Static picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of dosage quantity recorded in DosageQuantityNumerator and DosageQuantityDenominator. - **Possible values**: - Dose - Dose Range ### DosageRateDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range. ### DosageRateNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range. ### DosageRateType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of dosage rate recorded in DosageRateNumerator and DosageRateDenominator. - **Possible values**: - Frequency - Frequency Range - Frequency Ratio ### DosageRateUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the dosage rate recorded using DosageRateNumerator and DosageRateDenominator. - **Referenced Objects**: - UnitOfMeasure ### DosageUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the dosage rate recorded using DosageQuantityNumerator and DosageQuantityDenominator. - **Referenced Objects**: - UnitOfMeasure ### DosePrerequisiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the conditions that are to be met for the dosage to be taken. - **Referenced Objects**: - CodeSetBundle ### IsAsNeeded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the medication is taken on an as-needed basis. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### MethodId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the method of dosage administration. - **Referenced Objects**: - CodeSetBundle ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the PatientMedicationDosage record. ### ParentRecordId - **Type**: Master-detail polymorphic reference - **Properties**: Create, Filter, Group, Sort - **Description**: The MedicationStatement, MedicationRequest, or the MedicationDispense record that the PatientMedicationDosage record belongs to. - **Referenced Objects**: - MedicationDispense—This value is available in API version 55.0 and later. - MedicationStatement - MedicationRequest - MedicationAdministration ### PatientInstruction - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The patient or consumer instructions associated with this medication. ### RouteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the route of dosage administration. - **Referenced Objects**: - CodeSetBundle ### Sequence - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The position of this medication in the sequence of medications prescribed to a patient. ### SiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the site of dosage administration. - **Referenced Objects**: - CodeSetBundle ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the dosage record was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the dosage record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the dosage record was last modified in its source system. ### TimingId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The timing information for when and how frequent the medication dosage should be taken. - **Referenced Objects**: - ActivityTiming ## Usage PatientMedicationDosage records are used to add more dosage-related information to MedicationStatement, MedicationRequest, and MedicationDispense records. The PatientMedicationDosage record is associated to the MedicationStatement, MedicationRequest, and MedicationDispense records using the ParentRecordId field. ## 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. [PatientMedicationDosageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # Patients (GET, POST, PUT) Retrieve the FHIR patient resource record details. Create or update a patient record rather than making multiple separate calls to the objects in Salesforce. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note We recommend limiting the number of concurrent requests in your org to five. If you exceed this number, the Patients API request can fail. The update request deletes all child records associated with a patient and recreates them. For example, when you update a patient record having three PersonName records and five Identifier records as child records, the API first deletes all the PersonName and Identifier child records and then reinserts them. If something goes wrong while updating data, the API rolls back to prevent leaving orphan records behind. ## Resource for POST /connect/health/patients ## Resource for GET, PUT /connect/health/patients/${patientId} ## Example URI /services/data/v53.0/connect/health/patients/001x0000005CQbtAAG ## Available Version 53.0 ## Requires Chatter No ## HTTP Methods GET, POST, PUT ## Response Body for GET [Patient Get Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_get_output.htm "Output representation of details of a patient record.") ## JSON example { "active": true, "identifier": \[ { "assigner": { "referenceResource": "Organization", "referenceId": "Org12345XYZ" }, "type": { "text": "Passport Number", "coding": \[ { "display": "Passport number", "code": "PPN", "isActive": true, "use": "Identifier" } \] }, "value": "ABCD5678XYZ" } \], "name": \[ { "use": "alias", "text": "Charles Green", "family": "Green", "given": "Charles", "prefix": "Mr.", "suffix": "Sr." } \], "communication": \[ { "language": "English", "preferenceRank": 1 } \], "address": \[ { "use": "temp", "type": "postal", "line": "Green Household" } \], "telecom": \[ { "system": "email", "value": "a@bc.com" } \], "gender": "male", "birthDate": "2000-09-12T18:13:41Z", "maritalStatus": "married", "contact": \[ { "relationship": { "coding": \[ { "display": "Partner" } \] }, "name": { "use": "Temp", "text": "Shawna Green", "family": "Green", "given": "Shawna", "prefix": "Mrs.", "suffix": "Jr." }, "telecom": \[ { "system": "email", "value": "c@de.com" }, { "system": "phone", "value": "12345678", "use": "temp", "rank": 1 } \], "address": { "use": "temp", "type": "postal", "line": "Green Household" } } \], "generalPractitioner": \[ { "referenceResource": "Practitioner", "referenceId": "PRAC789XYZ", "relationship": "Plastic Surgeon" } \], "managingOrganisation": { "referenceResource": "Organization", "referenceId": "MI9007GBE" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | active | Boolean | Indicates whether the patient record is active or not. | Optional | 53.0 | | additional​Information | [Custom Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_custom_field_value.htm "Adds additional information to any fields not mapped by the medication statement API.")\[\] | Adds additional information to any fields not mapped in this API. | Optional | 53.0 | | address | [FHIR Address Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_address.htm "Input representation for the Address FHIR object.")\[\] | The address of the patient. | Optional | 53.0 | | birthDate | String | The date of birth of the patient. | Optional | 53.0 | | communication | [Patient Communication Language Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_patient_communication_language.htm "Input representation of the patient communication language.")\[\] | The languages of communication associated with the patient. | Optional | 53.0 | | contact | [Contact Party For Patient Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_patient_contact_party.htm "The input representation of the patient contact party.")\[\] | The contact associated with the patient record, modeled as a person account. Contacts are connected to patients using the Contact​Contact​Relation\_\_c junction object. | Optional | 53.0 | | deceased​​​DateTime | String | The date and time of the patient’s death. | Optional | 53.0 | | gender | String | The gender of the patient. | Optional | 53.0 | | general​Practitioner | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.")\[\] | The practitioners associated with the patient, modeled as either person accounts or Contacts and HealthcareProvider records. Practitioners are connected to patients using the Contact​Contact​Relation\_\_c junction object​. | Optional | 53.0 | | identifier | [FHIR Identifier Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_identifier.htm "The input representation of the Identifier FHIR object.")\[\] | The identifier information for the patient, stored as Identifier records that reference the patient record using their Identifier​.Parent​RecordId field. | Optional | 53.0 | | managing​Organisation | [FHIR Reference Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_reference.htm "The input representation for the Reference FHIR object.") | The organization that manages the patient record, referenced using a lookup to the Account object. Managing organizations are connected to patients using the Account​Contact​Relation​ junction object​. | Optional | 53.0 | | maritalStatus | String | The current marital status of the patient. | Optional | 53.0 | | multiple​BirthInteger | Integer | The birth order of the patient, in the event that the patient was a part of a multiple birth event. | Optional | 53.0 | | name | [FHIR Human Name Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_human_name.htm "The input representation for the name of a person and all its associated metadata.")\[\] | The names of the patient, stored as a PersonName record. | Optional | 53.0 | | sourceSystemId | String | The source system ID associated with a patient record. | Optional | 53.0 | | telecom | [FHIR Contact Point Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_fhir_contact_point.htm "Input representation for the ContactPoint FHIR object.")\[\] | Contact details of the patient, such as phone numbers and email addresses. These contact details are stored as Contact​Point​Phone records that reference the patient records using their Contact​Point​Phone​.ParentId field. | Optional | 53.0 | ## Response Body for POST [Patient Upsert Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_upsert_output.htm "Output representation of result after a Patient FHIR resource is created.") ## Response Body for PUT [Patient Update Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_patient_update_output.htm "Output representation of result after a Patient FHIR resource is updated.") # Payer A payer is a health insurance company that helps cover the cost of member care. payer is represented by records on the Account object. To learn more, see [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_account.htm). # Payload Output Output representation of the details communicated to the recipient. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | authorNoteId | String | The author note ID that contains the communication details along with information about the author of the note and the time the note was authored. | Big, 57.0 | 57.0 | | codeSetBundleId | String | The ID of the code set bundle. | Big, 57.0 | 57.0 | # PersonEducation Represents information about professional education for a person in a provider role. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CompletionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Education's completion date. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the person who earned the degree and is listed as a contact. ### EducationLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Level of education achieved. Example values: - Undergraduate degree - Medical school - Internship - Residency - Fellowship ### GraduationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Graduation date from institution. ### Identifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID issued to the recipient by the educational institution. ### IdentifierIssuer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Educational institution's name. ### IndividualId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the person who earned the degree and is listed as an individual. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is active. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the degree earned. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Education's start date. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Current status of education. Valid values: - Inactive - Revoked - Draft - Verified - **Default value**: Inactive ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the person who earned the degree and is listed as a user. ### VerificationStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Current educational status. Valid values: - Authorized - None - **Default value**: None ### VerifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Education was validated on this date. ## 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. [PersonEducationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_changeevent.htm "HTML (New Window)") (API version 58.0) Change events are available for the object. [PersonEducationFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") Feed tracking is available for the object. [PersonEducationHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") History is available for tracked fields of the object. [PersonEducationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "HTML (New Window)") Sharing rules are available for the object. [PersonEducationShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm "HTML (New Window)") Sharing is available for the object. # PersonEmployment Represents information about a person’s employment. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AnnualIncome - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The annual income of the person. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the employment. ### EmployerAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The complete address of the employer. ### EmployerCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city where the employer is located. ### EmployerCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the employer is located. ### EmployerGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates. - **Possible values**: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### EmployerLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. ### EmployerLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. ### EmployerPhone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Employer's phone number. ### EmployerPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the employer’s address. ### EmployerState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the employer’s address. ### EmployerStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street address of the employer. ### EmploymentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the employment status with the employer. - **Possible values**: - Employed - Home Maker - Retired - Self-Employed - Student - Unemployed with Income - Unemployed without Income ### EmploymentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: - **Possible values**: - Contract - Full-Time - Part-Time - Self-Employed - Temporary ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The last date of employment at this job. ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider associated with the person employment. This field is a relationship field. - **Relationship Name**: HealthcareProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record, a record related to this record, or a list view. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name for this record. ### Occupation - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the person’s occupation. - **Possible values**: - Dental assistants - Dental hygienists - Dentists - Diagnostic related technologists and technicians - Health technologists and technicians (all) - Healthcare support occupations (all) - Licensed practical and licensed vocational nurses - Nurse midwives and nurse practitioners - Nursing, psychiatric, and home health aides - Occupational and physical therapist assistants and aides - Other occupations within the healthcare sector - Pharmacists and pharmacy aides - Phlebotomists - Physical therapists - Physician assistants - Physicians and surgeons - Registered nurses - Respiratory therapists ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Position - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The last position of the person at this job. ### RelatedPersonId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person associated with the employment. This field is a polymorphic relationship field. - **Relationship Name**: RelatedPerson - **Relationship Type**: Lookup - **Refers To**: Account, Contact ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of employment at this job. ### VerificationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date of verification of the employment. ### VerificationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of verification of the employment. - **Possible values**: - Authorized - Confirmed - Expired - In Progress - Submitted - Verified ## 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. [PersonEmploymentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object. [PersonEmploymentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PersonEmploymentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PersonEmploymentShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Pharmacy Benefits Verification Pharmacy Benefits Verification uses a data model that’s FHIR-CARIN and NCPDP aligned to store its data and make it interoperable. The pharmacy benefits verification data model supports drug manufacturers, providers, pharmacists, and life sciences organizations in determining pharmacy benefits coverage for the medications prescribed to the patients under a care program.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Life Sciences or Health Cloud
The pharmacy benefits verification objects are available to users with the Health Cloud Starter and Manage Pharmacy Benefits Verification permission set. Available in API version 61.0 and later. ![Pharmacy benefit verification entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_pharmacy_benefits_verification_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/pharmacy-benefits-verification.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # PID - Patient Identification The Patient Identification (PID) HL7 segment maps to the ContactPointPhone object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for PID map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the Segments supported by Salesforce are mentioned below. Table 1. PID - Salesforce | PID | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | PID.2 - Patient ID (External ID) | Identifier | Object | The identifier record for the patient is associated to the patient by referencing the patient’s account record using the ParentRecordId field in Identifier. | | PID.3 - Patient ID (Internal ID) | Identifier | Object | The identifier record for the patient is associated to the patient by referencing the patient’s account record using the ParentRecordId field in Identifier. | | PID.4 - Alternate Patient ID | Identifier | Object | The identifier record for the patient is associated to the patient by referencing the patient’s account record using the ParentRecordId field in Identifier. | | PID.5 - Patient Name | PersonName | Object | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.Parent​RecordId field​. | | PID.7 - Date/Time of Birth | Contact.BirthDate | Date | Salesforce supports only the date of birth. The time of birth isn’t supported. | | PID.8 - Sex | Contact.Gender | Picklist | N/A | | PID.9 - Patient Alias | PersonName | Object | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Name​.Parent​RecordId field​. | | PID.11 - Patient Address | ContactPointAddress | Object | The address information for a patient is represented as Contact​Point​Address records that reference the patient record using their Contact​Point​Address​.ParentId field​. | | PID.13 - Home Phone | ContactPointPhone | Object | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. | | PID.14 - Work Phone | ContactPointPhone | Object | The telecom information for a patient is represented as Contact​Point​Phone records that reference the patient record using their Contact​Point​Phone​.ParentId field​. | | PID.15 - Primary Langauge | PersonLanguage | Object | The name information for a patient is represented as Person​Name records that reference the patient record using their Person​Language​.IndividualId field​. | | PID.16 - Marital Status | Contact.MaritalStatus | Picklist | N/A | | PID.25 - Multiple Birth Indicator | Contact​.Sequence​In​Multiple​Birth | Double | N/A | | PID.29 - Patient Death Date and Time | Contact.Deceased​Date | DateTime | N/A | # PlanBenefit Represents the standard benefits available under a plan that the purchaser offers to their members. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### BenefitNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the benefits available to members under this plan’s coverage. ### CoinsuranceNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information about the contribution a member makes towards treatment. ### CopayNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information on the copayment amounts that members contribute. ### DeductibleNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about a member’s deductibles. ### DocumentLocation - **Type**: url - **Properties**: Create, Nillable, Update - **Description**: Hyperlink to internal or external resources. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which these benefits are communicated to plan members. ### EffectiveFrom - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which these benefits become effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which these benefits ceased to be effective. ### EmergencyDepartmentCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Patient's portion of payment for using emergency department services. ### FamilyInNetworkDeductible - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member pays for health care provided by the health plan’s preferred providers for all family members. When this amount is reached, the plan starts to contribute towards treatment. ### FamilyInNetworkOutofPocket - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during a coverage year for health care provided by the health plan’s preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but is in addition to premiums. ### FamilyOutofNetworkDeductible - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member pay for health care provided by non-preferred providers for all family members before this plan starts to contribute towards treatment. ### FamilyOutofNetworkOutofPocket - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during a coverage year for health care provided by non-preferred providers for all family members. It includes deductibles, copayments, and coinsurance, but is in addition to premiums. ### FrequencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency type of the plan benefit associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. - **Possible values**: - Daily - Fortnightly - Monthly - Quarterly - Weekly - Yearly ### IndividualInNetworkDeductible - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member pays for health care provided by the health plan’s preferred providers to any one family member. When this amount is reached, the plan starts to contribute towards treatment. ### IndividualInNetworkOutofPocket - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during a coverage year for health care provided by the health plan’s preferred providers for any one family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### IndividualOutofNetworkDeductible - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member pays for health care provided by non-preferred providers to any one family member before this plan starts to contribute towards treatment. ### IndividualOutofNetworkOutofPocket - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during a coverage year for health care provided by non-preferred providers for any one family member. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### InNetworkCoinsuranceAmount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member contributes towards each treatment undertaken by the health plan’s preferred providers. ### InNetworkCoinsurancePercentage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of treatment cost the member pays for each treatment undertaken by the health plan’s preferred providers. ### InNetworkLifetimeMaximum - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during the lifetime membership on this plan for health care provided by the health plan’s preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### LifetimeMaximumNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about a member’s maximum lifetime payments. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of these plan coverage benefits. ### OutofNetworkCoinsuranceAmount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member contributes towards treatment undertaken by non-preferred providers. ### OutofNetworkCoinsurancePercentage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of treatment cost the member pays for treatment undertaken by non-preferred providers. ### OutofNetworkLifetimeMaximum - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The most a member pays during the lifetime membership on this plan for health care provided by non-preferred providers. It includes deductibles, copayments, and coinsurance, but excludes premiums. ### OutofPocketNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the out-of-pocket payment a member makes. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PrimaryCareCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member contributes towards primary care treatment. ### PurchaserPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the purchaser plan offering these benefits. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this benefits record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this benefits record on its source system. ### SourceSystemModified - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which these benefits were last changed on their source system. ### SpecialistCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member contributes towards specialist consultations. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of these benefits. The default the picklist - **Possible values**: - Active - Inactive ### TotalBenefitAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of the plan benefit associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. ### UrgentCareCopay - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount a member contributes towards urgent care. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PlanBenefitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [PlanBenefitFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PlanBenefitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PlanBenefitOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PlanBenefitShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PlanBenefitItem Represents the details of a benefit available under a purchaser’s plan that is offered to their members. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### BenefitCategory - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the benefit category this item belongs to. ### CoverageLevel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the level of coverage provided. ### FrequencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The frequency type of the plan benefit item associated with the home healthcare visit. This field is available in API version 66.0 and later with the Home Health add-on license. - **Possible values**: - Daily - Fortnightly - Monthly - Quarterly - Weekly - Yearly ### InNetworkCoverage - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount available to contribute towards treatment costs for each treatment undertaken by the health plan’s preferred providers. ### IsInPlanNetwork - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the benefit is only available in the plan network. ### ItemCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the plan benefit item. This field is a polymorphic relationship field. This field is available in API version 64.0 and later. - **Relationship Name**: ItemCode - **Refers To**: CodeSet, CodeSetBundle ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of this benefit item. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about this benefit item. ### OutofNetworkCoverage - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount available to contribute towards treatment costs for each treatment undertaken by non-preferred providers. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PauthRequirementEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from which preauthorization for the plan benefit item is required or not. This field is available in API version 64.0 and later. ### PauthRequirementStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last date for which preauthorization for the plan benefit item is required or not. This field is available in API version 64.0 and later. ### PlanBenefitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the benefit this item belongs to. ### PreauthorizationTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code which represents the type of preauthorization that the plan benefit item requires. This field is a relationship field. This field is available in API version 64.0 and later. - **Relationship Name**: PreauthorizationTypeCode - **Refers To**: CodeSet ### ServiceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of service this plan benefit item provides for. ### ServiceTypeCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code for the type of service this plan benefit item provides for. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this benefits item record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this benefits item record on its source system. ### SourceSystemModified - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this benefits item was last updated from the source system. ### TimePeriod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the period during which services under this plan benefit item are to be rendered or continued. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PlanBenefitItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [PlanBenefitItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PlanBenefitItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PlanBenefitItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PlanBenefitItemShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Practitioner The 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 accounts in Salesforce, where the HealthcareProvider record is the base. The person account is associated to the HealthcareProvider record by referencing the person account record using the AccountId field on HealthcareProvider. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note If your implementation models providers as contacts instead of person accounts, you can’t associate the fields mapped to Account to your providers. You can instead associate your HealthcareProvider record to the Contact record using the PractitionerId field on HealthcareProvider. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [Practitioner](https://www.hl7.org/fhir/practitioner.html) map to the fields in Salesforce​.
Table 1. Practitioner - Salesforce
Practitioner Resource Salesforce Field Type Salesforce Cardinality Notes
identifier ​​​Identifier Object 0​.​M The identifier information for a documentReference is represented as Identifier records that reference the Healthcare​Provider record using their ​​​Identifier​.​Parent​RecordId field​.
active Account​.IsActive Boolean 0​.1

The practitioner​​.active field is mapped to the account record of the provider’s person account. This account record is referenced using the Healthcare​Provider​.AccountId field.

If your Implementation models providers as Contacts instead of Person Accounts, then you can’t map practitioner​​.active to your providers.
name Person​Name Object 0​.M The name information for a practitioner is represented as Person​Name records that reference the practitioner’s person account record using their Person​Name​.Parent​RecordId field​.
telecom Contact​Point​Phone Object 0​.M

The telecom information for a practitioner is represented as Contact​Point​Phone records that reference the account record of the practitioner’s person account using the Contact​Point​Phone​.ParentId field​.

If your Implementation models providers as Contacts instead of Person Accounts, then you can’t map practitioner​​.telecom to your providers.
address Contact​Point​Address Object 0​.M

The address information for a practitioner is represented as Contact​Point​Address records that reference the account record of the practitioner’s person account using the Contact​Point​Address​.ParentId field​.

If your Implementation models providers as Contacts instead of Person Accounts, then you can’t map practitioner​​.address to your providers.
gender Contact​.Gender Picklist 0​.1

While FHIR defines practitioner​.gender as a code set, its Salesforce implementation is a picklist​.

The practitioner’s gender is mapped to the contact record of their person account. This contact record is referenced using the Healthcare​Provider​.PractitionerId field on HealthcareProvider.
birth​Date Contact​.Birthdate ​Date 0​.1 N/A
photo N/A N/A N/A Not supported
qualification Board​Certification Object 0​.M The qualification information for a practitioner is represented as Board​Certification records that reference the practitioner’s Healthcare​Provider record using their Board​Certification​.Healthcare​ProviderId field​.
qualification​.identifier ​​​Identifier Object 0​.​M The identifier information for a qualification is represented as Identifier records that reference the Board​Certification record using their ​​​Identifier​.​Parent​RecordId field​.
qualification​.code Board​Certification​.Certification​Type Picklist 0​.1

While FHIR defines practitioner​.qualification​.code as a code set bundle, its Salesforce implementation is a picklist​.
qualification​.period Board​Certification​.Effective​From ​Date 0​.1 Because Salesforce doesn’t support a native period data type, the practitioner​.qualification​.period FHIR resource is flattened to a set of from and to dates​.
qualification​.period Board​Certification​.Effective​To ​Date 0​.1 Because Salesforce doesn’t support a native period data type, the practitioner​.qualification​.period FHIR resource is flattened to a set of from and to dates​.
qualification​.issuer Board​Certification​.Board​Name String 0.1 N/A
communication Person​Language Object 0​.M

The language information for a practitioner is represented as Person​Language records that reference the practitioner’s person account using their Person​Language​.IndividualId field​.

While FHIR defines practitioner​.communication as a code set bundle, the Salesforce implementation is a reference to Person​Language.
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how a practitioner Carol Peterson is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_practitioner.png) # PractitionerRole The practitionerRole FHIR resource maps to the HealthcarePractitionerFacility and CareProviderFacilitySpecialty objects in Salesforce​. The practitionerRole resource in FHIR is represented as a combination of HealthcarePractitionerFacility and CareProviderFacilitySpecialty records, where the HealthcarePractitionerFacility record is the base. The CareProviderFacilitySpecialty record is associated to the HealthcarePractitionerFacility record by referencing the HealthcarePractitionerFacility record using the PractitionerFacilityId field on CareProviderFacilitySpecialty. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [PractitionerRole](https://www.hl7.org/fhir/practitionerrole.html) map to the fields in Salesforce​.
Table 1. PractitionerRole - Salesforce
Practitioner Resource Salesforce Field Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for a practitioner​Role is represented as Identifier records that reference the Healthcare​Practitioner​Facility record using their Identifier​.Parent​RecordId field​.
active Healthcare​Practitioner​Facility​.IsActive Boolean 0​.1 N/A
period Healthcare​Practitioner​Facility​.Effective​From Date 0​.1 Because Salesforce doesn’t support a native period data type, the practitioner​Role​​.period FHIR resource is flattened to a set of from and to dates​.
period Healthcare​Practitioner​Facility​.Effective​To Date 0​.1 Because Salesforce doesn’t support a native period data type, the practitioner​Role​​.period FHIR resource is flattened to a set of from and to dates​.
practitioner Healthcare​Practitioner​Facility​.Healthcare​Provider​Id Lookup: Healthcare​Provider 0​.1

N/A
organization Healthcare​Practitioner​Facility​.Account​​Id Lookup: Account 0​.1

N/A
code CareProvider​Facility​Specialty​.Specialty​Role Picklist 0​.M

While FHIR defines practitioner​Role​.code as a code set bundle, its Salesforce implementation is a picklist​.

Zero-to-many values can be associated by creating multiple CareProvider​Facility​Specialty​ records that reference a Healthcare​Practitioner​Facility​ record. However, a single CareProvider​Facility​Specialty​ record can have only one combination of role and specialty.
specialty CareProvider​Facility​Specialty​.Specialty​Id Lookup: CareSpecialty 0​.M

While FHIR defines practitioner​Role​.code as a code set bundle, its Salesforce implementation is a CareSpecialty reference​.

Zero-to-many values can be associated by creating multiple CareProvider​Facility​Specialty​ records that reference a Healthcare​Practitioner​Facility​ record. However, a single CareProvider​Facility​Specialty​ record can have only one combination of role and specialty.
location Healthcare​Practitioner​Facility​.Healthcare​Facility​Id Lookup: Healthcare​Facility 0​.1

The Salesforce implementation supports only one practitioner​Role​.location reference for each practitioner role.
healthcare​Service N/A N/A N/A Not supported
telecom N/A N/A N/A Not supported
availableTime Healthcare​Practitioner​Facility​.Operating​HoursId Operating​Hours 0.M Even though only one Operating​Hours record can be referenced from a Healthcare​Practitioner​Facility record, multiple time slots can be added to that Operating​Hours record. As such, zero-to-many available time values can be added to a single Healthcare​Practitioner​Facility record through a single Operating​Hours reference.
not​Available N/A N/A N/A Not supported
availability​Exceptions Healthcare​Practitioner​Facility​.Avialability​Exceptions String 0​.1 N/A
endPoint N/A N/A N/A Not supported
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how Carol Peterson's practice at Goodly Healthification is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_practitionerrole.png) # Presentation Represents a collection of presentations, each with various attributes such as activation dates, the ability to be sent by email, associated tags, and gestures. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which active presentations become available to sales representatives. If the field is empty, the start date limit is not applied to the presentation. ### CanSendByEmail - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the presentation can be sent via email. - **Default value**: false ### DeactivationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date limit during which active presentations are available to sales representatives. If the field is empty, the end date limit isn't applied to the presentation. ### IsCustom - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies whether the presentation was created by a user. - **Default value**: false ### IsDoubleTapZoomEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the double-tap zoom feature is activated for the presentation. Available only for html presentations. - **Default value**: false ### IsPDFIncluded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the presentation includes a PDF file, which can be sent as an attachment via email. If set to true, it means that the presentation contains PDF files ready for email delivery. - **Default value**: false ### IsPinchZoomEnabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enables or disables the pinch-to-zoom functionality in the presentation. - **Default value**: false ### IsPresentationLocked - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the presentation has been locked by an admin, meaning it can no longer be edited. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. Name of the presentation. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PlayerGestureSectionSide - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The gesture with which sales representatives open the Presentation Player menu. - **Possible values**: - SwipeDown - SwipeUp - TapBottom - TapTop ### PresentationScope Reserved for future use. ### PublicDisclaimerContentName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the public content that will be accessible during remote interactions and tied to the presentation. This content is typically linked to important public documents, such as product information or legal disclaimers, which the healthcare professional can view through their browser. Maximum length is 40 characters. ### PublicDisclaimerContentUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL pointing to the public disclaimer. ### ReactionSectionSide - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the location of the sequence rating zone in the presentation player. - **Possible values**: - Left - Right ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. - **Possible values**: - Active - Deleted - Inactive ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The presentation file type. - **Possible values**: - PDF - ZIP ### Version - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A text field to store the presentation’s version. ## 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. [PresentationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PresentationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Presentation Page Product (POST, PATCH) Create or update (delete) product and guidance associations for a presentation page. The Health Cloud Starter and Life Sciences Commercial Admin Permission Sets are required for accessing this API. To know more, see [Email Template](https://help.salesforce.com/s/articleView?id=ind.lsc_email_get_ready.htm&language=en_US) and [Intelligent Content](https://help.salesforce.com/s/articleView?id=ind.lsc_intelligent_content_get_ready.htm&language=en_US). ## Resource /connect/life-sciences/commercial/page/products ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/page/products ## Available Version 65.0 ## HTTP Methods POST, PATCH ## Request Body for POST or PATCH ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note - File Input Payload Size: - Overall API Payload Limit: The total request payload limit across APIs is 2 GB. When attaching single or multiple files as binary inputs using fileId, this 2 GB limit applies to the entire combined request payload. - ZIP Presentations: If the cumulative payload of pages in a ZIP presentation exceeds the 2 GB API limit, upload them as individual standalone pages using the PRESENTATION\_PAGE contentType. - Rate Limits: - Bulk Presentation (POST and PATCH): The rate limit is 200 API calls per org per hour. { "id": "string", "products": \[ { "productId": "1Kexx000000409xxAE", "guidanceIds": \[ "a0Fc0000007I5l6EAC", "Guidance\_2\_ext\_id" \] } \] }
Name Type Description Required
id String ID of the presentation page. Required, if an existing page record needs to be updated for PRESENTATION_ZIP and PRESENTATION_PAGE content types.
pageNumber Integer Page number for the presentation page. This value must be unique and within the range of 1 to 200. Required for PRESENTATION_PDF content type.
products List<Object> Array of objects containing the product ID and guidance ID mapping.

To view all products object properties, see Page Products Input.

 Required
## Response Body for POST [Presentation Page Product Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_presentation_page_products_output.htm "Represents the output for Presentation Page Products API.") # Presentation Page Product Output Represents the output for Presentation Page Products API. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isSuccess | Boolean | Indicates whether the request was successfully accepted or processed. | Small, 65.0 | 65.0 | | message | String | Message that provides details about the request outcome. | Small, 65.0 | 65.0 | | errors | List | List of errors that occurred during the request validation. | Small, 65.0 | 65.0 | ## Example { "isSuccess": true, "message": "Presentation page products created successfully", "errors": \[\] } # PresentationClickStrmEntry Represents the collection of clickstream data captured while the presentation is being used or shown across different forums. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the account, identifying the account on which the call was made. This field links the call data to a specific account for tracking purposes. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AccountLoginName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the guest attendee used to log in remotely, if applicable. Tracks guest users accessing the remote session. ### ActualUsageDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Records the total time, in seconds, that the user (during a face-to-face interaction) or the attendee (in a remote session) spent on a slide. ### AttendeeBrowser - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the web browser used by the attendee during a remote session. ### AttendeeDeviceOs - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the operating system used by the attendee's device during a remote session. ### AttendeeDeviceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the type of device (smartphone, tablet, computer) used by the attendee during a remote session. ### ContentEventDescription Reserved for future use. ### ContentEventIdentifier Reserved for future use. ### ContentEventType Reserved for future use. ### ContentName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the public content that was opened during a remote interaction and that is tied to the presentation. This content is typically linked to important public documents, such as product information or legal disclaimers, which the health care professional can view through their browser. Maximum length is 40 characters. ### ContentPageIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the specific slide within a presentation page container (sequence). ### ContentReaction - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Captures the reaction to the presentation page—positive (1), negative (-1), or neutral (0). ### ContentUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The public disclaimer URL of the presentation that was opened. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MetricType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the type of metric being collected from the clickstream, such as Tracking or Content Rating. This field is a calculated field. ### MetricEntryType Reserved for future use. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. An automatically generated unique identifier for the record, following the format, CSM-{00000000}. ### PageDisplaySourceType Reserved for future use. ### PresentationFileContentName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the slide that the user viewed in the presentation page file. Maximum length is 200 characters. ### PresentationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. A reference to the presentation, linking to the presentation on which clickstream data was captured. This field is a relationship field. - **Relationship Name**: Presentation - **Relationship Type**: Master-detail - **Refers To**: Presentation (the master object) ### PresentationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the presentation from which the clickstream data was captured. ### PresentationPageContentVerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the specific version of the presentation file that was viewed by the user. This field is a relationship field. - **Relationship Name**: PresentationPageContentVer - **Refers To**: ContentVersion ### PresentationPageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the presentation page, identifying the specific page where the clickstream data was recorded. This field is a relationship field. - **Relationship Name**: PresentationPage - **Refers To**: PresentationPage ### PresentationVersion - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the presentation that was displayed during the session. ### ProductGuidanceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the Product Guidance object, linking a specific product message to a presentation page presented and the clickstream metric record. This field is a relationship field. - **Relationship Name**: ProductGuidance - **Refers To**: ProductGuidance ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to both the Product2 and LSMarketableProduct objects, associating a product with the presentation page presented and the clickstream metric record. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ProviderVisitDtlProductMsgId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the detailing product message associated with the presentation page. This field is a relationship field. - **Relationship Name**: ProviderVisitDtlProductMsg - **Refers To**: ProviderVisitDtlProductMsg ### ProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the Provider Visit object, linking to the overall record of the visit (Call). This field is a relationship field. - **Relationship Name**: ProviderVisit - **Refers To**: ProviderVisit ### ProviderVisitPrdDetailingId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the Provider Visit Product Detailing object, linking to specific product information discussed during the visit. This field is a relationship field. - **Relationship Name**: ProviderVisitPrdDetailing - **Refers To**: ProviderVisitProdDetailing ### ProviderVisitType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of remote call. - **Possible values**: - AdHocSession - RemoteCall - RemoteMeeting ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### UsageEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The exact date and time when the user left the slide. For remote sessions, captured at the attendee level, not at the user level. ### UsageStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The exact date and time when the user opened the slide. For remote sessions, captured at the attendee level, not at the user level. ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the associated visit where clickstream data was captured. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [PresentationClickStrmEntryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationClickStrmEntryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PresentationContent Represents the AI-generated static asset at run-time, based on a Presentation Content Definition record. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the document from which the content is generated. This field is a relationship field. - **Relationship Name**: ContentDocument - **Refers To**: ContentDocument ### ContentText - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Represents the text of the generated content. ### ContentTextHash - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the hash of the generated content text. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the date to which the presentation content is available. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the date from which the presentation content is available. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the presentation content. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PrstContentDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the definition record for the presentation content. This field is a relationship field. - **Relationship Name**: PrstContentDefinition - **Refers To**: PrstContentDefinition ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the record in reference to which the presentation content type is generated. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Account ### RelatedPrstContentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the related presentation content. This field is a relationship field. - **Relationship Name**: RelatedPrstContent - **Refers To**: PresentationContent ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the external system that generated the record. ### TargetUserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the target for whom the presentation content is generated. This field is a relationship field. - **Relationship Name**: TargetUser - **Refers To**: User ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the territory in the context of which the presentation content is generated. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 # PresentationForum Represents the details of the forums (call, meetings, order) where the presentation was presented. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ForumReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. A reference to either the visit or account record that represents the forum in which the presentation was delivered. This field is a polymorphic relationship field. - **Relationship Name**: ForumReference - **Refers To**: Account, Visit ### Geolocation - **Type**: location - **Properties**: Nillable - **Description**: Captures the geographical location where the presentation was opened. ### GeolocationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the location was last successfully acquired. ### GeolocationLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Captures the geographical latitude where the presentation was opened. ### GeolocationLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Captures the geographical longitude where the presentation was opened. ### GeolocationMissingReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies why the location could not be retrieved, with possible reasons. - **Possible values**: - BadData - DeviceRestricted - Offline - UserRestricted ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. A unique identifier for the record, automatically generated in the format PF-{0000000000}. ### PresentationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates the reference to the presentation. This field is a relationship field. - **Relationship Name**: Presentation - **Relationship Type**: Master-detail - **Refers To**: Presentation (the master object) ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ## 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. [PresentationForumFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationForumHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PresentationLinkedPage Represents the connection between a presentation and its associated presentation pages. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the order of the related presentation page within the overall presentation. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the presentation linked page. ### OriginalPrstLinkedPageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source presentation linked page from which this presentation linked page is copied. This field is a relationship field. - **Relationship Name**: OriginalPrstLinkedPage - **Refers To**: PresentationLinkedPage ### PresentationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates the reference to the presentation. This field is a relationship field. - **Relationship Name**: Presentation - **Relationship Type**: Master-detail - **Refers To**: Presentation (the master object) ### PresentationPageId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Indicates the reference to the presentation page, linking the specific page within the presentation. This field is a relationship field. - **Relationship Name**: PresentationPage - **Refers To**: PresentationPage ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ## 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. [PresentationLinkedPageFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationLinkedPageHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PresentationPage Represents a collection of pages that can be used within a presentation. Each page can contain multiple slides. Pages can be reused across different presentations. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the presentation page is activated and available for use. ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The content document that is the PDF or ZIP file containing the content for the presentation page. This field is a relationship field. - **Relationship Name**: ContentDocument - **Refers To**: ContentDocument ### DeactivationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the presentation page is deactivated and no longer available for use. ### EmailTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lookup field that links the presentation page to a specific email template. This email template can be used for sending studies, statistics, or other relevant content associated with the current presentation page via email. This field is a relationship field. - **Relationship Name**: EmailTemplate - **Refers To**: LifeSciEmailTemplate ### IsAdditionalContent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the page is an asset. Assets are PDF files which can be added to ZIP presentations and referenced by link from any presentation slide. - **Default value**: false ### IsMandatory - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a specific page in the presentation must be shown. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the presentation page. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this presentation page. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PageNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The page number of this page in the presentation PDF file. There's no page number for presentations with ZIP file type. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Indicates whether the page is active, meaning it can be included and used in a presentation. - **Possible values**: - Active - Inactive ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies whether the content is in PDF or ZIP format. - **Possible values**: - PDF - ZIP ## 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. [PresentationPageFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationPageHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PresentationPageShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PresentationPageDependency Reserved for future use. ## Fields ### DependencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether to show the dependent presentation page before or after the target page. - **Possible values**: - Postrequisite - Prerequisite ### DisplayOrder - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The order in which dependent content is shown to users. Lower values appear first. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the dependency is active and enforced (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the presentation page dependency. ### PresentationPageId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The presentation page that has dependencies on other pages or presentations. This field is a relationship field. - **Relationship Name**: PresentationPage - **Relationship Type**: Master-detail - **Refers To**: PresentationPage (the master object) ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The presentation page or presentation that must be shown before the target page renders in the presentation player. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Presentation, PresentationPage # PresentationPageProduct Represents the link between a presentation page and a product, and may also include a connection to related product message (product guidance). This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the order of the related product message (product guidance) within the presentation page. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the presentation page product. ### PresentationPageId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates the reference to the presentation page. This field is a relationship field. - **Relationship Name**: PresentationPage - **Relationship Type**: Master-detail - **Refers To**: PresentationPage (the master object) ### ProductGuidanceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A reference to the Product Guidance object, linking a specific product message to the presentation page. This field is a relationship field. - **Relationship Name**: ProductGuidance - **Refers To**: ProductGuidance ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. A reference to both the Product2 and LSMarketableProduct objects, associating a product with the presentation page. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ## 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. [PresentationPageProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationPageProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PresentationPartyAccess Represents the access-sharing details of a presentation with a healthcare professional, including an expiration date for that access. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccessIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A UUID that identifies the presentation to show and the user who the link is intended for when sales representatives send presentations as links in email content. ### AccessRole - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Represents the role of the party (Account) in relation to the presentation, and define their level of access and permissions. - **Possible values**: - Approver - Author - Viewer ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when access to the presentation expires. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when access to the presentation begins. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. Name of the presentation party access. ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Identifies the party with whom this record is shared, granting access to the presentation associated with this record. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Refers To**: Account ### PresentationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Indicates the reference to the presentation. This field is a relationship field. - **Relationship Name**: Presentation - **Relationship Type**: Master-detail - **Refers To**: Presentation (the master object) ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ## 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. [PresentationPartyAccessFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PresentationPartyAccessHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Pricebook2 Represents a price book that contains the list of products that your org sells. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text description of the price book. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the price book is active (true) or not (false). Inactive price books are hidden in many areas in the user interface. You can change this field’s value as often as necessary. Label is **Active**. ### IsArchived - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the price book has been archived (true) or not (false). This field is read only. ### IsDeleted - **Type**: boolean - **Properties**: Defaulted on create, Filter - **Description**: Indicates whether the price book has been moved to the Recycle Bin (true) or not (false). Label is **Deleted**. ### IsStandard - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates 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 price books. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Name of this object. This field is read-only for the standard price book. Label is **Price Book Name**. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [Pricebook2History](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # Pricebookentry Represents a product entry (an association between a price book and product) in a price book. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this price book entry is active. ### IsArchived - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the price book entry has been archived (true) or not (false). This is set to true when the product record it’s associated with is archived, or when the price book record is archived. This field is read only. Available in API version 45.0 and later. Label is **Archived**. ### Name - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Name of this price book entry record. This read-only field references the value in the Name field of the product record. Label is **Product Name**. ### Pricebook2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. ID of the price book record with which this record is associated. This field must be specified when creating price book records. It can’t be changed in an update. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. ID of the product record with which this record is associated. This field must be specified when creating product records. It can’t be changed in an update. ### ProductCode - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Product code for this record. This read-only field references the value in the **ProductCode** field of the associated product record. ### UnitPrice - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: Required. Unit price for this price book entry. You can specify a value only if UseStandardPrice is set to false. Label is **List Price**. ### UseStandardPrice - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this price book entry uses the standard price defined in the standard price book record. ## Usage Use this object to define the association between your organization’s products (product) and your organization’s standard price book or to other, custom-defined price books ( price book). Create one PricebookEntry record for each standard or custom price and currency combination 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 client application 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 and unavailable from the API. Deleted PriceBookEntry records can’t be recovered. You must load the standard price for a product before you are permitted to load its custom price(s). ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PricebookEntryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ​Procedure The procedure FHIR resource maps to the Patient​Medical​​Procedure and Patient​Medical​​Procedure​Detail objects in Salesforce​. ## FHIR V4​.0 - Clinical​ Data Model Mapping Here’s how the fields defined by FHIR for [​Procedure](https://www.hl7.org/fhir/procedure.html) map to the fields in Salesforce​.
Table 1. ​Procedure - Salesforce
​Procedure Resource Salesforce Field ​Type Salesforce Cardinality Notes
identifier Identifier Object 0​.M The identifier information for a ​Procedure is represented as Identifier records that reference the Patient​Medical​​Procedure record using their Identifier​.Parent​RecordId field​.
instantiates​Canonical​ N/A N/A N/A Not Supported
instantiates​Canonical​ N/A N/A N/A Not Supported
basedOn Patient​Medical​​Procedure​Detail Object 0​.M

The information about the service request that a procedure is based on is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​Procedure​Id field​.

The Salesforce implementation of procedure​.basedOn doesn’t support references to care plans​.
basedOn Patient​Medical​​Procedure​Detail​.​Detail​RecordId Lookup: Clinical​Service​Request 0​.1 For procedure​.basedOn information, Patient​Medical​​Procedure​Detail​.​Detail​RecordId must reference a Clinical​Service​Request record​.
basedOn Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Based On

 0​.1 For procedure​.basedOn information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Based On​.
partOf Patient​Medical​​Procedure​Detail Object 0​.M

The information about the procedure or observation that a procedure is a part of is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​Procedure​Id field​.

The Salesforce implementation of procedure​.partOf doesn’t support references to medication administration​.
partOf Patient​Medical​​Procedure​Detail​.​Detail​RecordId Polymorphic Lookup: Patient​Medical​​Procedure, Care​Observation 0​.1 For procedure​.partOf information, Patient​Medical​​Procedure​Detail​.​Detail​RecordId must reference a either a Patient​Medical​​Procedure record or a Care​Observation​.
partOf Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Part Of

 0​.1 For procedure​.partOf information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Part Of​.
status Patient​Medical​​Procedure​.Status Picklist 0​.1 While FHIR defines procedure​.status as a code set bundle, the Salesforce implementation of Patient​Medical​​Procedure​.Status is picklist​.
status​Reason Patient​Medical​​Procedure​.Status​Reason​​CodeId Lookup: ​CodeSet​Bundle 0​.1 N/A
category Patient​Medical​​Procedure​.​TypeId Lookup: ​CodeSet​Bundle 0​.1 N/A
code Patient​Medical​​Procedure​.​CodeId Lookup: ​CodeSet​Bundle 0​.1 N/A
subject Patient​Medical​​Procedure​.PatientId Master​Detail: Account 1​.1 The Salesforce implementation of procedure​.subject doesn’t support references to groups​.
encounter Patient​Medical​​Procedure​.Clinical​Encounter​Id Lookup: Clinical​Encounter 0​.1 N/A
performed​.performed​Date​Time Patient​Medical​​Procedure​.Start​Date Date​Time 0​.1 Patient​Medical​​Procedure​.Start​Date is used for both procedure​.performed​.performed​Date​Time and procedure​.performed​.performed​Period​. For the latter, the field is used to represent the start date of the period​.
performed​.performed​Period Patient​Medical​​Procedure​.Start​Date Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the procedure​.performed​.performed​Period field is flattened into a set of start date and end date fields​.
performed​.performed​Period Patient​Medical​​Procedure​.End​Date Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the procedure​.performed​.performed​Period field is flattened into a set of start date and end date fields​.
performed​.performed​String Patient​Medical​​Procedure​.Duration​Time​String String 0​.1 N/A
performed​.performedAge Patient​Medical​​Procedure​.Performed​AtAge Double 0​.1 Because Salesforce doesn’t support a native age data type, the procedure​.performed​.performedAge FHIR resource is flattened into a set of age and unit fields​.
performed​.performedAge Patient​Medical​​Procedure​.PerformedAt​AgeUnitId Lookup: UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native age data type, the procedure​.performed​.performedAge FHIR resource is flattened into a set of age and unit fields​.
performed​.performed​Range Patient​Medical​​Procedure​.PerformedAt​AgeLower​Limit Double 0​.1 Because Salesforce doesn’t support a native range data type, the procedure​.performed​.performed​Range FHIR resource is flattened into a set of lower limit, upper limit, and unit fields​.
performed​.performed​Range Patient​Medical​​Procedure​.PerformedAt​​AgeUpper​Limit Double 0​.1 Because Salesforce doesn’t support a native range data type, the procedure​.performed​.performed​Range FHIR resource is flattened into a set of lower limit, upper limit, and unit fields​.
performed​.performed​Range Patient​Medical​​Procedure​.Performed​AgeRange​Unit Lookup: UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native range data type, the procedure​.performed​.performed​Range FHIR resource is flattened into a set of lower limit, upper limit, and unit fields​.
recorder Patient​Medical​​Procedure​.​Record​Creator​Id Lookup: Account, HealthcareProvider 0​.1 N/A
asserter Patient​Medical​​Procedure​.Assertion​SourceId Lookup: Account, Healthcare​Provider 0​.1 N/A
performer Care​Performer Object 0​.M The performer information for a ​Procedure is represented as Care​Performer records that reference the Patient​Medical​​Procedure record using their Care​Performer​.Parent​RecordId field​.
performer​.function Care​Performer​.RoleId Polymorphic Lookup: ​CodeSet, ​CodeSet​Bundle 0​.1 N/A
performer​.actor Care​Performer​.PersonId Polymorphic Lookup: Account, Healthcare​Provider 0​.1 The Salesforce implementation doesn’t support references to devices​.
performer​.actoron​BehalfOf Care​Performer​.Affiliated​Organization​Id Lookup: Account 0​.1 0​.1
location Patient​Medical​​Procedure​.FacilityId Lookup: Healthcare​.Facility 0​.1 N/A
reason​Code Patient​Medical​​Procedure​.Reason​CodeId Lookup: ​CodeSet​Bundle 0​.1 While FHIR defines procedure​.reason​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​Reference Patient​Medical​​Procedure​.Reason​Reference​Id Polymorphic Lookup: Health​Condition, Care​Observation, Patient​Medical​​Procedure, and Diagnostic​Summary 0​.1

While FHIR defines procedure​.reason​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.

The Salesforce implementation doesn’t support document reference records​.
bodySite Patient​Medical​​Procedure​Detail Object 0​.M

The body site information of a procedure is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​ProcedureId field​.

bodySite Patient​Medical​​Procedure​Detail​.​Detail​CodeId Polymorphic Lookup: ​CodeSet, ​CodeSet​Bundle 0​.1 For procedure​.bodySite information, Patient​Medical​​Procedure​Detail​.​Detail​CodeId must reference a ​CodeSet or ​CodeSet​Bundle record​.
bodySite Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Body Site

 0​.1 For procedure​.bodySite information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Body Site​.
outcome Patient​Medical​​Procedure​.Outcome Picklist 0​.1 While FHIR defines procedure​.outcome as a code, the Salesforce implementation of Patient​Medical​​Procedure​.Outcome is a picklist​.
report Patient​Medical​​Procedure​.ReportId Lookup: Diagnostic​Summary 0​.1

While FHIR defines procedure​.report as a zero-to-many resource, the Salesforce implementation is zero-to-one​.

The Salesforce implementation of procedure​.report doesn’t support references to composition or document reference records​.
complication Patient​Medical​​Procedure​Detail Object 0​.M

The complication information of a procedure is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​ProcedureId field​.

complication Patient​Medical​​Procedure​Detail​.​Detail​CodeId Polymorphic Lookup: ​CodeSet, ​CodeSet​Bundle 0​.1 For procedure​.complication information, Patient​Medical​​Procedure​Detail​.​Detail​CodeId must reference a ​CodeSet or ​CodeSet​Bundle record​.
complication Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Complication

 0​.1 For procedure​.complication information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Complication​.
complication​Detail Patient​Medical​​Procedure​Detail Object 0​.M

The complication detail information of a procedure is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​ProcedureId field​.

complication​Detail Patient​Medical​​Procedure​Detail​.​Detail​RecordId Lookup: Health​Condition 0​.1 For procedure​.complication​Detail information, Patient​Medical​​Procedure​Detail​.​Detail​RecordId must reference a Health​Condition record​.
complication​Detail Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Complication ​Detail

 0​.1 For procedure​.complication​Detail information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Complication ​Detail​.
followUp Patient​Medical​​Procedure​Detail Object 0​.M

The follow up information of a procedure is represented as Patient​Medical​​Procedure​Detail records that reference the Patient​Medical​​Procedure record using their Patient​Medical​​Procedure​Detail​.Patient​Medical​​ProcedureId field​.

followUp Patient​Medical​​Procedure​Detail​.​Detail​CodeId Polymorphic Lookup: ​CodeSet, ​CodeSet​Bundle 0​.1 For procedure​.followUp information, Patient​Medical​​Procedure​Detail​.​Detail​CodeId must reference a ​CodeSet or ​CodeSet​Bundle record​.
followUp Patient​Medical​​Procedure​Detail​.​Detail​Type

Picklist

Value: Follow Up

 0​.1 For procedure​.complication​Detail information, Patient​Medical​​Procedure​Detail​.​Detail​Type must use the value Follow Up​.
Note AuthorNote Object 0.M Use the AuthorNote object to add notes to a procedure, and use the ParentRecordId field to reference the parent procedure the note belongs to.
focal​Device Patient​Medical​​Procedure​Detail​.​Detail​recordId Lookup: Care​Registered​Device 0.M Use the Patient​Medical​​Procedure​Detail child object to add multiple focalDevice values that reference the parent procedure record.
used​Reference Patient​Medical​​Procedure​Detail​.​Detail​RecordId Lookup: Care​Registered​Device 0.M Use the Patient​Medical​​Procedure​Detail child object to specify devices used in a procedure, and reference the parent procedure record.
used​Code Patient​Medical​​Procedure​Detail​.​Detail​CodeId N/A 0.M Use the Patient​Medical​​Procedure​Detail child object to specify codes for items used in a procedure, and reference the parent procedure record.
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how a procedure for Charles' sinusectomy is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_procedure.png) #### See Also - [CarePerformer](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_CarePerformer.htm "Represents the person performing care in observations, procedure, and immunizations. This person may be a physician, the patient’s contact, or anyone who administered any sort of care to the patient in the context of the concerned care event. This object is available in API version 51.0 and later.") - [PatientMedicalProcedure](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_patientmedicalprocedure.htm "Represents detailed information about a healthcare procedure the patient has undergone, is undergoing or will undergo. This object is available in API version 51.0 and later.") - [PatientMedicalProcedureDetail](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_PatientMedicalProcedureDetail.htm "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.") # Process Criteria Matching Response Parses a GPT-generated JSON response to evaluate each inclusion and exclusion criterion for a given Research Study Candidate, determining whether each criterion is matched or not. This action stores the GPT response in the Care Program Enrollment Evaluation Result entity and computes the number of matched inclusion criteria and exclusion criteria, returning these counts as output. This action is available in API version 62.0 and later. ## Special Access Rules The Assign Candidate to Research Study Group action is available in Enterprise and Unlimited Editions with Life Sciences Cloud and the Participant Enrollment Add-On license. Additionally, the org must be enabled with Research Study Randomization. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/processCriteriaMatchingResp Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
researchStudy​CandidateId string Required

ID of the research study candidate for which GPT response is received.
gptResponse string Required

GPT Response of PromptTemplate Invocable action will be input to this action.
## Outputs | Output | Type | Description | | --- | --- | --- | | matchedInclusionCount | string | Number of inclusion criteria matched. | | matchedExclusionCount | string | Number of exclusion criteria matched. | ## Example **POST** This sample request is for the Process Criteria Matching Response action. { "inputs": \[ { "researchStudyCandidateId": "7evxx0000000001AAA", "gptResponse": { "EligibilityResponse": \[ { "Id": "0bkxx0000000001AAA", "EligibilityCriteria": "Adult SARI patients with 2019-ncov infection confirmed by PCR", "Result": "Unknown", "Reason": "No information provided" }, { "Id": "0bkxx000000001dAAA", "EligibilityCriteria": "Age < 78", "Result": "Match", "Reason": "Patient is 50 years old." }, { "Id": "0bkxx000000003FAAQ", "EligibilityCriteria": "Pregnant", "Result": "Not Match", "Reason": "Patient is male." }, { "Id": "0bkxx000000004rAAA", "EligibilityCriteria": "Allergic to Gluten", "Result": "Match", "Reason": "Patient has Gluten Allergy." } \] } } \] } This sample response is for the Process Criteria Matching Response action. { "inclusionCriteriaMatchCount": 1, "exclusionCriteriaMatchCount": 1 } # Product Management Product Management centers on products, which are essential for business activities within the system. Products are modeled in a hierarchy that can mirror a company's SKU structure and are used in scenarios such as selling to pharmacies and delivering messages and samples to healthcare professionals. Product alignment is key to ensuring that users have access to products and related data to perform their jobs effectively. To maintain compliance and adherence to regulatory standards, user access to products can be controlled. Users can access and discuss only products available to them and not restricted for the target customer. Life Sciences Marketable Product stores information about all of the products that a Life Science company manufactures, markets, sells, or competes with. This information can include any type of product or product area that is discussed or detailed, including brands, indications, and therapeutic areas. Store additional information about physical products that are sampled, ordered, or distributed as promotional items in the Product2 object. ![Product Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_product_mgmt_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/product-management.html "HTML (New Window)"). ## Product Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Life Science Product Account Restriction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciproductacctrstrc.htm) - [Product Guidance](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productguidance.htm) - [Product Territory Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterritoryavailability.htm) - [Product Territory Detailed Availability](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productterrdtlavailability.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). #### See Also - [_Object Reference for the Salesforce Platform_: Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_product2.htm) # Product Required Attributes Input Input representation of the products required for the visit. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | productId | String | ID of the product. | Required | 55.0 | | quantity | Integer | Quantity of the product. | Required | 55.0 | # Product2 Represents a product that your org sells. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: A text description of this record. Label is **Product Description**. ### DisplayUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: URL leading to a specific version of a record in the linked external data source. ### ExternalDataSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the related external data source. ### ExternalId - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of a record in the linked external data source. For example, ID #123. ### Family - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the product family associated with this record. Product families are configured as picklists in the user interface. Label is **Product Family**. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this record is active. ### IsArchived - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicated whether the product is archived. ### IsSerialized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product supports serial numbers. If an associated product item record already exists, this boolean can’t be set to true unless the product item’s quantity is zero. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Time stamp for the last time this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Time stamp for the last time this record was viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Default name of this record. Label is **Product Name**. ### ProductCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default product code for this record. Your org defines the product code naming pattern. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unit of the product; for example, kilograms, liters, or cases. This field comes with only one value, Each, so you may want to create your own. The QuantityUnitOfMeasure field on ProductItem inherits this field’s values. ### StockKeepingUnit - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SKU for the product. Use in tandem with or instead of the ProductCode field. For example, you can track the manufacturer’s identifying code in the Product Code field and assign the product a SKU when you resell it. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [Product2Feed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [Product2History](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProductAvailabilityProjection Represents the projected product quantity available at an inventory location at various points in time. Records for this object are automatically created by Intelligent Sales. This object is available in API version 55.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the record was last viewed. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: Lookup - **Properties**: Filter, Group, Sort - **Description**: The owner of the record. - **Refers To**: Group, User ### Product2Id - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product whose quantity is available quantity is projected. - **Refers To**: Product2 ### ProductLocationId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The inventory location of the product with that quantity. - **Refers To**: Location ### ProjectedQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The quantity projected at the inventory for the specified date. ### ProjectionDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: The date for when the quantity projection is applicable. ### Status - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The status of the inventory based on the projected quantity and the required quantity for that day. - **Possible values**: - Available - ProjectedAvailable - Shortfall ## 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. [ProductAvailabilityProjectionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductAvailabilityProjectionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProductAvailabilityProjectionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductBatchItem Represents the details about the product items in each batch. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssigneeId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the user or group assigned to the product batch item. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: Group, User ### ExpirationDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product batch item expires and is no longer usable. ### InitialAllocatedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The initial allocated quantity of product items in the product batch item. ### IsProductionBatchActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the production batch associated with the product batch item is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### LocationId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The location associated with the product batch item. This field is a relationship field. - **Relationship Name**: Location - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product batch item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the product batch item record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The product associated with the product batch item. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product item associated with the product batch item. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The production batch associated with the product batch item. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### QuantityDeductedFromWeb - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of the product batch item deducted through the web interface. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the unit of measure for the quantity of the product batch item. ### RemainingQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The remaining quantity of product items in the product batch item. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the product batch item. # ProductDisbursement Represents details about the product being disbursed. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores additional information about the product disbursement. ### Comments - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments for the product disbursement. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the products disbursed. ### DisbursementDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time of the product disbursement. ### DisbursementToAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The destination account associated with the product disbursed. This field is a relationship field. - **Relationship Name**: DisbursementToAccount - **Refers To**: Account ### InventoryCountReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the reference record of the inventory count after the disbursement. This field is a polymorphic relationship field. - **Relationship Name**: InventoryCountReference - **Refers To**: InventoryCntProdtBatchItem ### InventoryOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory operation associated with the product disbursement. This field is a relationship field. - **Relationship Name**: InventoryOperation - **Refers To**: InventoryOperation ### IsDisbursed - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is disbursed (true) or not (false). - **Default value**: false ### IsProductSerialized - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the product disbursed is serialized (true) or not (false). - **Default value**: false ### IsResolutionRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the disbursement was made with insufficient inventory and requires reconciliation after enough stock is available. - **Default value**: false ### IsSignatureCaptured - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the signature was captured during disbursement. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product to be disbursed. ### OpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the opportunity associated with the product disbursement. This field is a relationship field. - **Relationship Name**: Opportunity - **Refers To**: Opportunity ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the product to be disbursed. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the product item at a particular location to be disbursed. This field is a relationship field. - **Relationship Name**: ProductItem - **Refers To**: ProductItem ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the product to be disbursed. ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the production batch of the products disbursed. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### ProductionBatchNumber - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The unique identification number of the batch that the disbursed product belongs to. ### QuantityDisbursed - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of products that are disbursed. ### QuantityRequested - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of products requested to be disbursed. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the unit used to measure the quantity of products disbursed. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the product disbursement. ### ViolationMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The violation message for product disbursement. ### ViolationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of violation that happens during the product disbursement. ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the visit associated with the product disbursement. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ### WarningMessage - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The warning message for product disbursement. ### WarningType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of warning displayed during the product disbursement. ## 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. [ProductDisbursementFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductDisbursementHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProductDisbursementShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductFulfillmentLocation Associates a business account and a product inventory with the responsible field rep. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business account a field rep is responsible for visiting. ### FulfillmentLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The inventory location from which an order will be fulfilled. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location of the account the field rep visits. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Product Fulfillment Location record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the product the field rep fulfills at the account. ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The field rep responsible for the account and inventory. ## 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. [ProductFulfillmentLocationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") (API version 63.0) History is available for tracked fields of the object. [ProductFulfillmentLocationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 63.0) Sharing rules are available for the object. [ProductFulfillmentLocationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 63.0) Sharing is available for the object. # ProductGuidance Represents information about key product messages, product objectives, or other information that can assist or guide users when working with the product. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContentText - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product guidance message or objective. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date after which the guidance is no longer available. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the product guidance takes effect. ### GroupName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The group name used to categorize messages. ### GroupSequence - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which group are displayed. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product guidance is active (true) or not (false). - **Default value**: false ### IsReactionSelectionHidden - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether reaction capture is hidden (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the product guidance. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Priority - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The default priority order of product guidance messages and objectives. ### ProductReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product that's associated with the product guidance. This field is a polymorphic relationship field. - **Relationship Name**: ProductReferenceRecord - **Refers To**: LifeSciMarketableProduct, Product2 ### Reactions - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A semicolon-delimited list of custom reactions captured by the user. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into the object. ### Type - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the product guidance. - **Default value**: Message - **Possible values**: - Message - Objective - Other ## 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. [ProductGuidanceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProductGuidanceFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductGuidanceHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProductGuidanceShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductGuidancePrstDpnd Reserved for future use. ## Fields ### DependencyType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether to show the dependent presentation page before or after the target page. - **Possible values**: - Postrequisite - Prerequisite ### DisplayOrder - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The order in which dependent content is shown to users. Lower values appear first. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the dependency is active and enforced (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferencedDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product guidance presentation dependency. ### ProductGuidanceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The product guidance that has dependencies on presentation pages or presentations. This field is a relationship field. - **Relationship Name**: ProductGuidance - **Relationship Type**: Master-detail - **Refers To**: ProductGuidance (the master object) ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The presentation page or presentation that must be shown before the target page renders in the presentation player. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Presentation, PresentationPage # ProductionBatch Represents the batch of homogeneous products manufactured in the same production line. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BatchCreatedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the production batch is created. ### CreationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the location where the batch is created. This field is a relationship field. - **Relationship Name**: CreationLocation - **Refers To**: Location ### Description - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the production batch. ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the batch expires and is no longer usable. ### InitialQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The initial quantity of products in the production batch. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the production batch is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### ManufacturingDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The manufactured date and time for the production batch. ### ManufacturingLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the manufacturing location of the production batch. This field is a relationship field. - **Relationship Name**: ManufacturingLocation - **Refers To**: Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the production batch. ### OriginType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of origin of the batch. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the production batch. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the unit of measure for the products of the production batch. ### UniqueIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identification number of the production batch. This field is unique within your organization. # ProductItem Represents the stock of a particular product at a particular location in field service, such as all bolts stored in your main warehouse. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules Field Service must be enabled. ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product item was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product item was last viewed. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Location associated with the product item. This usually indicates where the product item is stored. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The product item’s owner. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Product associated with the product item, which represents the type of product in your inventory. ### ProductItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: (Read Only) Auto-generated number identifying the product item. ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: A name for the product item. Try to select a name that indicates what is being stored where; for example, Batteries in Warehouse A. ### QuantityOnHand - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity at the location. If you want to add a serial number, this value must be 1. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Units of the product item; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products. ### SerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A unique number for identification purposes. If you want to enter a serial number, the Quantity on Hand must be 1. ## Usage Each product item is associated with a product and a location in Salesforce. If a product is stored at multiple locations, the product will be tracked in a different product item for each location. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProductItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProductItemShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductItemTransaction Standard and custom fields extend the standard Product Item Transaction object to represent information about an action taken on a product item. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ProductItemTransaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_productitemtransaction.htm) ## Fields ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production batch associated with transacted products. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch # ProductRequest Represents a device request made as part of a care program. Standard and custom fields extend the standard Product Request object to represent information about sample orders. This object is available in API version 65.0 and later in Samples Management feature. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The access rules is required for Intelligent Sales feature in Life Sciences cloud. Field Service must be enabled. Authenticated external users can create and update ProductRequest objects. ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the product request. This is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care program enrollee associated with the product request. This field is available from API version 49.0 and later. This is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Relationship Type**: Lookup - **Refers To**: CareProgramEnrollee ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the product request. This is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A text field for details not recorded in the provided fields. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Where the product is delivered. This is a relationship field. - **Relationship Name**: DestinationLocation - **Relationship Type**: Lookup - **Refers To**: Location ### DestinationLocationUserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The primary user of the destination location associated with the product request. This field is a relationship field. It is available in API version 65.0 and later in Samples Management feature. - **Relationship Name**: DestinationLocationUser - **Refers To**: User ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product request was last modified. Its label in the user interface is Last Modified Date. ### LastModifiedById - **Type**: reference - **Properties**: Aggregatable, Defaulted on create, Filter, Group, Sort - **Description**: ID of the user who last updated this object. ### NeedByDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the product must be delivered by. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the shipment. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProductRequestNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-assigned number that identifies the shipment. ### ShipToAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address that the product is to be delivered to. ### ShipToCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city that the product is to be delivered to. ### ShipToCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country that the product is to be delivered to. ### ShipToGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The accuracy of the geocode for the shipping address. ### ShipToLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The latitude of the location where the product is to be delivered to. ### ShipToLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The longitude of the location where the product is to be delivered to. ### ShipToPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the address where the product is to be delivered to. ### ShipToState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the state where the product is to be delivered to. ### ShipToStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street address where the product is to be delivered to. ### ShipmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of shipment. The picklist includes the following values by default: - None - Rush - Overnight - Next Business Day - Pick Up ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location the product is shipped from. This is a relationship field. - **Relationship Name**: SourceLocation - **Relationship Type**: Lookup - **Refers To**: Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the product transfer. ### UrgencyLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the level of urgency associated with the product request. This field is available in API version 65.0 and later in Samples Management feature. ### WorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order that the product request is related to. This is a relationship field. - **Relationship Name**: WorkOrder - **Relationship Type**: Lookup - **Refers To**: WorkOrder ### WorkOrderLineItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work order line item that the product request is related to. This is a relationship field. - **Relationship Name**: WorkOrderLineItem - **Relationship Type**: Lookup - **Refers To**: WorkOrderLineItem # ProductRequestLineItem A junction object between ProductRequest and ProductTransfer This object is available in API version 50.0 and later. This object is available in API version 65.0 and later in Samples Management feature. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ExceptionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of exception while placing a product request. This object is available in Samples Management feature in API version 65.0 and later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time this record was viewed. ### NeedByDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date specified as required in a transfer request. ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the parent ProductRequest record. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the product requested. ### ProductRequestLineItemNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. This is auto-generated. ### QuantityRequested - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The quantity that was requested. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the quantity requested. - **Possible values**: - Each # ProductRequired Represents a product that is needed to complete a visit. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product required was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product required was last viewed. ### ParentRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The work order or work order line item that the product is required for. ### ParentRecordType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Indicates whether the parent record is a work order or a work order line item. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The required product. ### ProductName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the product required. ### ProductRequiredNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: (Read only) Auto-generated number identifying the product required. ### QuantityRequired - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Quantity required of the product. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Units of the required product ## Usage Required products can be added to work types, work orders, and work order line items to ensure that the assigned service resource arrives with the right equipment. Adding required products to work types saves you time and keeps your business processes consistent. Work orders and work order line items inherit their work type’s required products. For example, if all light bulb replacement jobs require a ladder and a light bulb, add the ladder and light bulb as required products to your Light Bulb Replacement work type. When it’s time to create a work order for a customer’s light bulb replacement, applying that work type to the work order adds the required products. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductRequiredFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductRequiredHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProductTerrDtlAvailability Represents the details of the products aligned to territories. This object is an extension of the information stored in the Product Territory Availability object and is used for internal purposes. This object is available in API version 65.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product territory detailed availability is active (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product territory detailed availability. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProdtTerritoryAvailabilityId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product territory availability associated with the product territory detailed availability. This field is a relationship field. - **Relationship Name**: ProdtTerritoryAvailability - **Refers To**: ProductTerritoryAvailability ### ProductId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The product for which the territory availability is defined . This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ProductType - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of the product associated with the product territory detailed availability. ### Purpose - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the purpose of the product territory detailed availability. - **Default value**: Visit - **Possible values**: - Visit - Quote ### RelatedTerritoryId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Stores the ID of the territory associated with the product territory detailed availability. This field is a relationship field. - **Relationship Name**: RelatedTerritory - **Refers To**: Territory2 ### SortOrder - **Type**: int - **Properties**: Filter, Group, Nillable, Sort, Update - **Description**: The order in which product territories are displayed. ### TerritoryId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The territory for which the product availability is defined . This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ### UsageType - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the usage type of the product territory detailed availability. - **Default value**: LifeSciences - **Possible values**: - LifeSciences ## 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. [ProductTerrDtlAvailabilityShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductTerritoryAvailability Represents information about the products aligned to territories. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Fields ### AlignmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the alignment type of a product in relation to a territory. A product can be made directly available to a territory, inherited, or specifically excluded. - **Default value**: Inclusion - **Possible values**: - Inclusion - Territory Exclusion - Territory and Subordinates Inclusion ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product territory availability. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product for which the territory availability is defined . This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### Purpose - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the purpose of the product territory availability. - **Default value**: Visit - **Possible values**: - Visit - Quote ### RelatedProduct2Id - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Represents the Product2 record associated with the LifeSciMarketableProduct record in the product territory availability. - **Relationship Name**: RelatedProduct2 - **Refers To**: Product2 ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the status of the product territory alignment record. - **Default value**: Draft - **Possible values**: - Active - Draft - Inactive - Queued ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The territory for which the product availability is defined . This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ### UsageType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the product territory availability. - **Default value**: LifeScience - **Possible values**: - LifeScience ## 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. [ProductTerritoryAvailabilityChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProductTerritoryAvailabilityFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductTerritoryAvailabilityShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProductTransfer Standard and custom fields extend the standard Product Transfer object to represent information about the transfer of inventory between locations. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() #### See Also - [_Object Reference for the Salesforce Platform_: ProductTransfer](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_producttransfer.htm) ## Fields ### InventoryCountReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory count record where the product transfer is recorded. This field is a relationship field. - **Relationship Name**: InventoryCountReference - **Refers To**: InventoryCntProdtBatchItem ### InventoryOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inventory operation associated with the product transfer. This field is a relationship field. - **Relationship Name**: InventoryOperation - **Refers To**: InventoryOperation ### ProductionBatchId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The production batch associated with the transferred products. This field is a relationship field. - **Relationship Name**: ProductionBatch - **Refers To**: ProductionBatch ### ReceivedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the transferred product is received at the destination location. ### TransferCause - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the cause of the product transfer. ### WarningMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The warning message displayed to the end user during product transfer. # ProductTransfer Represents the transfer of inventory between locations in field service. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Details not recorded in the provided fields. ### DestinationLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place the product is to be delivered. ### ExpectedPickupDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date that the transfer is being requested for. ### IsReceived - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Checkbox identifying that the product was received. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product request was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the product request was last viewed. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Owner of the product transfer. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup field for the product associated with the product transfer. ### ProductTransferNumber - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-assigned number that identifies the product transfer. ### QuantityReceived - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Amount of product received at the destination location. ### QuantitySent - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Amount of product that’s being requested. ### QuantityUnitOfMeasure - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The units of the product, for example grams, liters, or units. ### ReceivedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup field for the person who received the product at the destination location. ### ShipmentExpectedDeliveryDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date for which the transfer is being accepted.. ### SourceLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the location of the inventory making the transfer. ### SourceProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the inventory making the transfer. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the transfer request. - **Possible values**: - Accepted - Rejected - Requested ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ProductTransferFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProductTransferHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProductTransferOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProductTransferShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Program Enrollment Input Request body for care program enrollment. ## Root XML tag ## JSON example { "programId": "programId1", "sourceSystem": "source-system-name", "patientData": \[ { "patientId": "patient1", "careProgramProductData": \[ { "providerId": "provider1", "productId": "product1" }, { "providerId": "provider1", "productId": "product2" } \] }, { "patientId": "patient2", "careProgramProductData": \[ { "providerId": "provider3", "productId": "product4" } \] } \] } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | patientData | [Patient Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_patient_input.htm "Input containing data for a single patient.")\[\] | List of all objects that contain patients data. You can have up to 200 items in this list. | Yes | 46.0 | | programId | String | ID of the care program as configured in the care system field mappings. | Yes | 46.0 | | sourceSystem | String | Name of the source system as configured in the care system field mappings. | Yes | 46.0 | # Program Enrollment Result Result containing details of all patient enrollment status. If there is success, it contains id of new records created for each patient. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | careProgramEnrollmentResults | [Care Program Enrollment Result](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_care_program_enrollment_result.htm "Result containing details about a single patient enrollment.")\[\] | A list containing the results of all the patient enrollments. | Small, 46.0 | 46.0 | | error | [Error Message](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_error_output.htm "A generic error message containing error code and the message text.") | Error output containing the code and the message text. | Small, 46.0 | 46.0 | | isSuccess | Boolean | Indicates whether the enrollment was successful. | Small, 46.0 | 46.0 | # ProgramEnrlEligibilityCrit Represents a junction between Program and Enrollment Eligibility Criteria objects. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EnrollmentEligibilityCritId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The enrollment eligibility criteria associated with the program enrollment eligibility criteria. This field is a relationship field. - **Relationship Name**: EnrollmentEligibilityCrit - **Refers To**: EnrollmentEligibilityCriteria ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an enrollment eligibility criterion is mandatory (true) or optional (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the program enrollment eligibility criteria. ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The program associated with the program enrollment eligibility criteria. This field is a relationship field. - **Relationship Name**: Program - **Relationship Type**: Master-detail - **Refers To**: Program (the master object) ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the program enrollment eligibility criteria. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of enrollment eligibility criteria. # ProgramEnrollment Represents details of enrollment for benefits in a program. This object is available in API version 57.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.  ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the account that’s associated with an organization enrolled in the program. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### ApplicationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the enrollee applied to the program. ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program enrollee associated with the program enrollment. This field is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Refers To**: CareProgramEnrollee ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the contact that’s associated with an individual enrolled in the program. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the enrollment in the program. This field is accessible if you enabled Data Protection and Privacy in Setup. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the enrollment for the participant in the program is active (true) or not (false). This field is accessible if you enabled Data Protection and Privacy in Setup. - **Default value**: false ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the program enrollment record. ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The identifier of the program that's associated with the enrollee. This field is a relationship field. - **Relationship Name**: Program - **Relationship Type**: Master-Detail - **Refers To**: Program ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the enrollment in the program. This field is accessible if you enabled Data Protection and Privacy in Setup. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The enrollment status of the enrollee for the program. This field is accessible if you enabled Data Protection and Privacy in Setup. ## Associated Objects This object has these 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. [ProgramEnrollmentFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm) Feed tracking is available for the object. [ProgramEnrollmentHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm) History is available for tracked fields of the object. [ProgramEnrollmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_ownersharingrule.htm) Sharing rules are available for the object. [ProgramEnrollmentShare](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_share.htm) Sharing is available for the object. # ProgramRecommendationRule Represents the eligibility criteria and recommendation for a program. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country where the program is eligible for implementation. ### HasActiveCommercialIns - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this program has an active commercial insurance. - **Default value**: false ### IsInclusionRule - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether it's an inclusion rule (true) or an exclusion rule (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MaximumAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum age for enrolling in the program. ### MinimumAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum age for enrolling in the program. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the program recommendation rule. ### ProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The program associated with the program recommendation rule. This field is a relationship field. - **Relationship Name**: Program - **Relationship Type**: Master-detail - **Refers To**: Program (the master object) ### ProgramType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type of program associated with the program recommendation rule. - **Possible values**: - Copay - Patient Assistance Program - Quick Start ### RecommendedProgramPriority - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The recommended priority of the program. ### RuleType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the type of rule. - **Possible values**: - Eligibility - Recommendation # Provider Engagement Action Plan Status Updates the status of a Provider Engagement Compliance action plan. ## Resource /connect/life-sciences/commercial/prvd-engmt-compliance/action-plan/status ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST [Provider Engagement Compliance Action Plan Status Input](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_update_pec_action_plan_status.htm "Input representation for updating the status of a Provider Engagement Compliance action plan.") ## Response Body for POST [Provider Engagement Compliance Action Plan Status Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_update_pec_action_plan_status.htm "Output representation for the status update request.") # Provider Engagement Action Plan Status Output representation for the status update request. ## Properties | Property Name | Type | Description | | --- | --- | --- | | code | Integer | The request response code. | | message | String | The request response message. | ## Example { "code": 200, "message": "Status updated successfully." } # Provider Engagement Action Plan Status Input Input representation for updating the status of a Provider Engagement Compliance action plan. ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | actionPlan​Id | String | The ID of the action plan to update. | Required | | dateTime | Datetime | The date and time for the status change. | Required | | startedBy​Type | String | The type of user who started the action plan, such as a sales representative. | Optional | | status | String | The new status value for the action plan. | Required | ## Example { "actionPlanId": "07rxx0000004EFgAAM", "status": "In Progress", "dateTime": "2026-04-08T10:29:59.007Z", "startedByType": "Sales Representative" } # Provider Relationship Management Use the Provider Relationship Management data model along with standard Salesforce objects to manage your provider relationships. The Provider Relationship Management data model represents the practitioners, facilities, physician relationships, specialties, and organizational hierarchy 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 Provider information is also represented using existing standard Salesforce objects in addition to objects only available through Health Cloud and Life Sciences Cloud. - 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 healthcare facilities 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 contact record and connected to the physician using the contact-contact relationships. - Account Contact Relationship: Represents physician and health system business affiliations, such as attending and admitting privileges. - Person Education: Represents the educational details of a physician or licensed practitioner. - Identity Document: Represents all identifiers for a practitioner or facility, other than the NPI. - Location: Represents more details of a healthcare location, such as a clinic. - Associated Location: Represents the junction between an account and a location. - Operating Hours: Represents the hours that a facility is open. - Time Slot: Represents a range of time on a specified day of the week during which healthcare work can be performed. Operating hours consist of one or more time slots. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). ## Provider Relationship Management ![Provider entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/images/healthcloud_providerrelationshipmgmt_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/provider-relationship-management.html "HTML (New Window)"). - **[Use Composite API Requests to Import Data for Provider Relationship Cards](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_provider_search_import_card_data.htm)** If you’re setting up provider relationship cards to show practitioner information, you can use Composite API requests to create and link multiple records. # Provider Search Search for Healthcare providers and accounts based on a free-text input, either from internal Salesforce data or an external system. This API returns account information, including healthcare providers and matching contact point addresses. ## Resource /connect/life-sciences/commercial/provider-search ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/life-sciences/commercial/provider-search?externalSearch=true ## Available Version 65.0 ## HTTP Methods POST ## Query Parameters for POST | Parameter Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | external​Search | Boolean | Indicates whether to perform the search on an external system (true) or not (false. By default, this value is set to false and an internal search is performed. | Optional | ## Request Body for POST { "searchInput": "Acme.Corp Dermatology", "countryCodes": \[ "US", "IN" \] } | Name | Type | Description | Required | | --- | --- | --- | --- | | search​Input | String | Free-text input to search for accounts. | Required | | country​Codes | List | List of country codes to restrict the search to. | Required | ## Response Body for POST [Provider Search Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_provider_search.htm "Output representation for provider search request.") # ProviderAcctProductInfo Represents specific information for healthcare professionals or healthcare organizations at the territory and product levels. This information is used for segmentation and product-level rankings. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the account associated with the provider account product information. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of situations related to this provider account and product. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider account product information. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the product associated with the provider account product information. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the territory associated with the provider account product information. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. [ProviderAcctProductInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProviderAcctProductInfoFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderAcctProductInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderAcctProductInfoOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderAcctProductInfoShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderAcctTerritoryInfo Represents the engagement data between an account and a user within an assigned territory, which includes next provider visit date, preferred address, and planned activities. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account ID associated with provider account territory info. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AccountTerrUniqueIdentifier - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: The unique account territory ID associated with provider account territory info. This field is unique within your organization This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AssignmentApprovalStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The approval status when an account is added to the territory through manual request. - **Possible values**: - Approved - Pending - Rejected ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider account territory info is active. - **Default value**: false ### IsAvailableOffline - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this record will be downloaded to the mobile application. - **Default value**: true ### IsTargetedAccount - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the account is a target for the territory. - **Default value**: false ### LastProviderVisitDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date of the last submitted visit for this account in this territory. ### LastProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID associated with the last submitted visit for this account in this territory. This field is a relationship field. - **Relationship Name**: LastProviderVisit - **Refers To**: ProviderVisit ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider account territory info. ### NextProviderVisitDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date of the next planned visit for this account in this territory. ### NextProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the next planned provider visit record. This field is a relationship field. - **Relationship Name**: NextProviderVisit - **Refers To**: ProviderVisit ### NextProviderVisitObjective - **Type**: textarea - **Properties**: Filter, Nillable, Sort - **Description**: The objective for the next visit with the healthcare provider, derived from the next visit objective on the last visit in this territory. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PreferredAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID associated with the contact point record that stores the preferred address of the account for the specified territory. This field is a relationship field. - **Relationship Name**: PreferredAddress - **Refers To**: ContactPointAddress ### ProviderOrganizationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare facility associated with the provider account. This field is a relationship field. - **Relationship Name**: ProviderOrganization - **Refers To**: Account ### RecommendedPresentationInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The next best content recommended for sharing with the healthcare provider during a future visit. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record type ID of the provider account territory info. This field is a relationship field. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source of adding the account to the territory. ### TargetedPresentationInfo - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A list of IDs representing the targeted presentations for the account within the territory. ### Territory2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The territory ID associated with the provider account territory info. This field is a relationship field. - **Relationship Name**: Territory2 - **Refers To**: Territory2 ### YearToDateProviderVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the number of provider visits to the account during the current year to date. ## 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. [ProviderAcctTerritoryInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProviderAcctTerritoryInfoFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderAcctTerritoryInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderAcctTerritoryInfoOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderAcctTerritoryInfoShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderActivityGoal Represents the goals for the provider accounts. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the activity goal. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ActivityAttainmentPercentage - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the overall goal achieved by the completed activities for this account. Shows the progress towards the target. This field is a calculated field. ### ActivityPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The activity plan associated with the activity goal. This field is a relationship field. - **Relationship Name**: ActivityPlan - **Relationship Type**: Master-detail - **Refers To**: ActivityPlan (the master object) ### ActivityPlanType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The type or the category of the activity plan. - **Possible values**: - AccountGoal—Account Goal - AccountGoalShared—Account Goal Shared - WeightedTerritoryGoals—Weighted Territory Goals ### ActlNonProdtActvtyCapVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the completed non-product activities, which is capped at a limit. ### ActualActivityCappedValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total number of completed activities, which is capped at a limit. This field is a calculated field. ### ActualNonProdtActvtyValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the completed activities that aren’t related to any product associated with this account. ### ActualProdtActvtyCapValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the completed product-related activities, which is capped at a limit. ### ActualProductActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the completed activities related to products within this account. ### ActvtyAttainmentCappedPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the overall goal achieved, which is capped at 100 percent. This field is a calculated field. ### AssigneeChangeReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the change in the account goal, made by the assignee, during the review stage. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider activity goal. ### NonProdtActvtyProratedVal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The portion of the non-product goal adjusted for the current date within the activity plan. Shows the target value for the non-product activities considering the elapsed time. This field is a calculated field. ### NonProdtAttainmentCapPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the non-product goal achieved, which is capped at 100 percent. This field is a calculated field. ### NonProductAttainmentPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the non-product goal achieved through the completed activities. Indicates the progress towards the non-product target. This field is a calculated field. ### NonProductGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The target number for activities that aren't related to any products associated with this account. ### OverallGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total target number for all activities associated with the account. ### ProdtActvtyAttainmentPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the product-specific goal achieved through the completed activities. Indicates the progress towards the product target. This field is a calculated field. ### ProductActivityAtmtCapPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the product-specific goal achieved, which is capped at 100 percent. This field is a calculated field. ### ProductActvtyProratedValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The portion of the product-specific goal adjusted for the current date within the activity plan. Shows the target value for products considering the elapsed time. This field is a calculated field. ### ProductLevelGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The target number for activities related to the products associated with the account. ### ProratedOverallGoal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The portion of the overall goal adjusted for the current date within the plan cycle. Shows the target value considering the elapsed time. This field is a calculated field. ### ReviewerChangeReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the change in the account goal made by the reviewer during the review stage. ### SchdNonProdtActvtyCapVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of scheduled non-product activities, which is capped at a limit. ### SchdProdtActvtyCappedValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the scheduled product-related activities, which is capped at a certain limit. ### ScheduledActvtyCappedValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total number of scheduled activities, which is capped at a limit. This field is a calculated field. ### ScheduledNonProdtActvtyVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total value of all scheduled activities that aren’t related to any product associated with this account. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### TotalActlActvtyWeightedVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of the completed activities for this account adjusted by weights. Shows the difference in the importance of various activities. ### TotalActualActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of all completed activities associated with this account. ### TotalProjectedActivityValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The projected total number of activities associated with this account. Aggregates the values of completed and scheduled activities. This field is a calculated field. ### TotalSchdActvtyWeightedVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total value of scheduled activities for this account adjusted by weights. Shows the changes in the importance of different activities. ### TotalSchdProdtActvtyValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total value of all scheduled activities related to the products associated with this account. ### TotalScheduledActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of all scheduled activities associated with this account. ## 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. [ProviderActivityGoalFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderActivityGoalHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProviderActivityGoalLimit Represents the limits defined for provider activity goals. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivityLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum number of activities that can be associated with a provider. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### MonetaryLimit - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum monetary value that can be spent on a provider. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider activity goal limit. ### ProviderActivityGoalId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The provider activity goal associated with the limit. This field is a relationship field. - **Relationship Name**: ProviderActivityGoal - **Relationship Type**: Master-detail - **Refers To**: ProviderActivityGoal (the parent object) ### ProviderActivityMeasureTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The provider activity measure type associated with the provider activity goal limit. This field is a relationship field. - **Relationship Name**: ProviderActivityMeasureType - **Refers To**: ProviderActivityMeasureType ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ## 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. [ProviderActivityGoalLimitFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderActivityGoalLimitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProviderActivityGoalMeasure Represents the goal measurement for an activity type. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActivityAttainmentPercentage - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the activity goal that has been attained. This field is a calculated field. ### ActivityProratedAtmtGoal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The portion of the attained goal adjusted for the current date within the plan cycle. Shows the target goal considering the elapsed time. This field is a calculated field. ### ActivityProratedGoal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The activity goal attainment that is capped at 100 percent. This field is a calculated field. ### ActivityWeightValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the weightage of the activity. ### ActualActivityCappedValue - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The capped count of actual activities. This field is a calculated field. ### ActualActivityWeightedValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the weighted value of all actual activities. This field is a calculated field. ### ActualExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of money that's already expensed for one or more activities. ### ActvtyAtmtDifferenceValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The difference between the Expected and Actual Attainment of what has been completed against the Goal. This field is a calculated field. ### ActvtyAttainmentCappedPct - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the percentage of the activity goal that has been attained, capped at 100 percent. This field is a calculated field. ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Provides context for how an account's planned activity is used. ### AdjustedOverallGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the adjusted overall activity goal. ### AssigneeGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Assignee's activity goals set by the reviewer. ### CommittedExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of money that's approved for one or more activities. ### EstimatedExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of money that's estimated to be spent for one or more activities. ### ExpectedActvtyPrrtAtmtVal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The portion of the goal expected to be attained by the current date within the activity plan cycle. This field is a calculated field. ### GoalAdjustmentType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of adjustment requested for the activity goal. ### IsProductWeightagePopulated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether product weightage is populated. - **Default value**: false ### IsSuggestedActivity - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the activity plan is suggested to the account without a goal. - **Default value**: false ### LastProcessingDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the latest date when the activity plan calculation job was run. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider activity goal measure. ### OverallGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The overall goal for the provider activity. ### ProcessingJobIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the unique identifier for the activity plan calculation jobs. ### ProductList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: List of products included in the activity plan. ### ProviderActivityGoalId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The activity goal associated with the provider activity goal measure. This field is a relationship field. - **Relationship Name**: ProviderActivityGoal - **Relationship Type**: Master-detail - **Refers To**: ProviderActivityGoal (the master object) ### ProviderActivityMeasureTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The type of the provider activity goal measure. This field is a relationship field. - **Relationship Name**: ProviderActivityMeasureType - **Refers To**: ProviderActivityMeasureType ### ReviewerGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Assignee's activity goals set by the assignee. ### SchdTotalProdtActvtyWtVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the weighted value for all scheduled activities associated with the products. ### ScheduledActvtyCappedValue - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The capped count of scheduled activities. This field is a calculated field. ### ScheduledActvtyWeightedVal - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the weighted value of all scheduled activities. This field is a calculated field. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### TotalActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of utilized activities for an account in a plan cycle. ### TotalActlProdtActvtyWtVal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the weighted value for all actual activities associated with the products. ### TotalActualActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of actual activities. ### TotalCommittedActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of planned or scheduled activities for an account. ### TotalExpenseAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total amount of money spent, approved, and estimated to be spent for an account. ### TotalProjActvtyCappedValue - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The capped number of projected activities, which include actual and scheduled activities. This field is a calculated field. ### TotalProjectedActivityValue - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The total number of projected activities, which include actual and scheduled activities. This field is a calculated field. ### TotalScheduledActivityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total number of scheduled activities. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of the activity goal. - **Possible values**: - EventManagementLimit—Event Management Limit - Goal - WeightedGoal—Weighted Goal ## 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. [ProviderActivityGoalMeasureFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderActivityGoalMeasureHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProviderActivityMeasureType Represents the details of the activity goal measure type. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ActivityAccountField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the account associated with the activity. ### ActivityObject - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the activity to be measured for the account. - **Possible values**: - ExpenseParticipant—Expense Participant - Knowledge\_\_ka—Knowledge - Knowledge\_\_kav—Knowledge - LifeScienceEmail—Life Science Email - ProviderVisit—Provider Visit - ProviderVisitProdDetailing—Product Details - Visit - cdpactvstrgptnr\_\_ActivationPlatformCredential\_\_mdt—ActivationPlatformCredential - customcontentversion\_\_c—customcontentversion - lsc4ce\_\_AdminConsoleMenuItem\_\_mdt—Admin Console Menu Item ### ActivityParentObjRelaField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the parent lookup relationship of the activity. ### ActivityParentObject - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the parent object of the activity. - **Possible values**: - Knowledge\_\_ka—Knowledge - Knowledge\_\_kav—Knowledge - ProviderVisit—Provider Visit - Visit - cdpactvstrgptnr\_\_ActivationPlatformCredential\_\_mdt—ActivationPlatformCredential - customcontentversion\_\_c—customcontentversion - lsc4ce\_\_AdminConsoleMenuItem\_\_mdt—Admin Console Menu Item ### ActivityProductField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the product associated with the activity. ### ActivityTerritoryField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the territory associated with the activity. ### ActivityTypSchdStatusList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status list of the scheduled activity type. ### ActivityTypeDtTmField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the date and time associated with the activity. ### ActivityTypeExclusionField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the activity type that is excluded from the activity plan. ### ActivityTypeField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the type of activity associated with the account. ### ActivityTypeFieldValue - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Stores the criteria to identify a specific activity type. ### ActivityTypeStatusField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the status of the activity. ### ActivityTypeStatusList - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The list of statuses associated with the activity. ### AggregatedActivityActualFld - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field to which the actual activity count is copied. ### AggregatedActivitySchdField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field to which the scheduled activity goal count is copied. ### AggregatedGoalField - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the field to which the activity goal count is copied. ### AlertType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of alert that users see when a limit is reached for an account. Error prevents users from continuing, while Warning allows users to proceed. - **Possible values**: - Error - Warning ### Category - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category of the activity goal measure type and determines the types of provider activity goal measure records that can reference the provider activity measure type record. - **Default value**: ActivityGoal - **Possible values**: - AccountUtilizationLimit - ActivityGoal - MonetaryCapLimit ### Criteria - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The account utilization criteria configuration, in JSON format, for validation and total activity calculation. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ranks used to order the activity plan gauges on Account or Homepage. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the activity is active (True) or not (False). - **Default value**: false ### Level1RelatedAccountObject - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the Account object associated with the activity. - **Possible values**: - Knowledge\_\_ka—Knowledge - Knowledge\_\_kav—Knowledge - Visit - cdpactvstrgptnr\_\_ActivationPlatformCredential\_\_mdt—ActivationPlatformCredential - customcontentversion\_\_c—customcontentversion - lsc4ce\_\_AdminConsoleMenuItem\_\_mdt—Admin Console Menu Item ### Level2RelatedAccountObject - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the field that has a direct or indirect relationship to the Account object. ### Lvl1RelatedAccountObjField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the Account object associated with the activity measure. ### Lvl2RelatedAccountObjField - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The field that contains the API name of the field that has a direct or indirect relationship to the activity. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for the data change definition value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. # ProviderActvtyPlanAdjusment Represents the details of the adjustment requests for an activity plan. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the activity plan adjustment request. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ActivityPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The activity plan associated with the activity plan adjustment request. This field is a relationship field. - **Relationship Name**: ActivityPlan - **Refers To**: ActivityPlan ### AdjustmentReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the activity plan adjustment request. ### AdjustmentType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The purpose of the activity plan adjustment request. - **Possible values**: - Add - Reset - Update ### AssigneeGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Assignee's activity goals set by the assignee. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the activity plan adjustment request. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the provider activity plan adjustment. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProviderActivityMeasureTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of activity associated with the activity plan adjustment request. This field is a relationship field. - **Relationship Name**: ProviderActivityMeasureType - **Refers To**: ProviderActivityMeasureType ### ProviderActvtyGoalMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider activity goal measure associated with the activity plan adjustment request. This field is a relationship field. - **Relationship Name**: ProviderActvtyGoalMeasure - **Refers To**: ProviderActivityGoalMeasure ### ReviewerGoal - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Assignee's activity goals set by the reviewer. ### ShouldRsetActvtyGoalMeas - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the account must be removed from all activity plans. - **Default value**: false ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the activity plan adjustment request. - **Possible values**: - Approved - Rejected - Submitted ### StatusChangeReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the rejected activity plan adjustment request. ### TerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The territory associated with the activity plan being adjusted. This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ## 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. [ProviderActvtyPlanAdjusmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderActvtyPlanAdjusmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderActvtyPlanAdjusmentOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderActvtyPlanAdjusmentShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderAffiliation Represents the relationship between two healthcare professionals or healthcare organizations. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the from account of the provider affiliation. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AccountName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the account. ### AffiliationStrengthType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the strength of the affiliation between the two accounts. - **Possible values**: - High - Low - Medium ### AffiliationTitle - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The title associated with the provider affiliation record. ### AffiliationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the nature of the affiliation between accounts. - **Possible values**: - Hard - Soft ### CareSpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care specialty associated with the provider affiliation. This field is a relationship field. - **Relationship Name**: CareSpecialty - **Refers To**: CareSpecialty ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which the affiliation is no longer effective. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from which the affiliation becomes effective. ### InfluenceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The direction of the affiliation between accounts. - **Possible values**: - Bidirectional - Neutral - Unidirectional ### IsAccountPersonAccount - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the account is of person account type (true) or not (false). - **Default value**: false ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider affiliation record is active (true) or not (false). - **Default value**: false ### IsAutogenerated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider affiliation record is automatically generated. - **Default value**: false ### IsInstitutionDoctorAffl - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare provider and their affiliated facility are managed as a single account in specific markets. - **Default value**: false ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the affiliation is the primary affiliation between the healthcare provider and healthcare organization. - **Default value**: false ### IsRelatedAccountPersonAccount - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the related account is of person account type (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider affiliation. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RelatedAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the destination or to account of the provider affiliation. This field is a relationship field. - **Relationship Name**: RelatedAccount - **Refers To**: Account ### RelatedAccountName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the related account. ### RelatedInverseRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The inverse or reciprocal affiliation between accounts. This field is a relationship field. - **Relationship Name**: RelatedInverseRecord - **Refers To**: ProviderAffiliation ### Role - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The role of the affiliation between two accounts. - **Default value**: Employ - **Possible values**: - Consulting - Employ ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [ProviderAffiliationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProviderAffiliationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderAffiliationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderAffiliationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderAffiliationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderAffiliationProduct Represents the relationship between two healthcare professionals, where one influences the other regarding a product. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the provider affiliation product. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product ID associated with the provider affiliation product. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProviderAffiliationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The provider affiliation ID associated with the provider affiliation product. This field is a relationship field. - **Relationship Name**: ProviderAffiliation - **Refers To**: ProviderAffiliation ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [ProviderAffiliationProductChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProviderAffiliationProductFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderAffiliationProductHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderAffiliationProductOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderAffiliationProductShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Providers Use these resources to create practitioner or facility records, or update existing fields in provider records and insert new fields. - **[Create Provider](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_create_provider_api.htm#hc_create_provider_api)** This API creates healthcare provider records along with the corresponding Account records (for facilities) or Contact records (for practitioners). You can also use it to manage information about practitioner credentials. - **[Upsert Provider](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_upsert_provider_api.htm#hc_upsert_provider_api)** This business-level API enables you to upsert data in Salesforce to represent a practitioner and all the objects and fields in the Provider data model relevant to a Practitioner, such as NPI, provider specialty, and provider taxonomy. # ProviderSampleLimit Represents sample limits and remaining quantity applied to a given account and product. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The account that's linked to the sample limit. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the provider sample limit. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. The name of the provider visit sample limit record. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product that's linked to the sample limit. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### PrvdSampleLmtTemplateId - **Type**: reference - **Description**: Required. The provider sample limit template that's associated with provider sample limit. This field is a relationship field. - **Relationship Name**: PrvdSampleLimitTemplate - **Refers To**: ProviderSampleLimitTemplate ### PrvdSampleLmtTemplateName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The provider sample limit template associated with the provider sample limit. ### Rule - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. Stores the rules for allocating sample limits to the linked account. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ## 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. [ProviderSampleLimitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProviderSampleLimitTemplate Represents a template used to define sample limit rules for providers. ## Version ProviderSampleLimitTemplate components are available in API version 66.0 and later. ## Fields ### discrepancyAlertType - **Description**: Specifies whether discrepancies trigger an error or a warning. ### isActive - **Description**: Indicates whether the sample limit template is currently active. ### isAdvanced - **Description**: Indicates whether advanced rule logic is enabled for this template. ### isCloned - **Description**: Indicates whether this template was created by cloning another template. ### isLawBased - **Description**: Indicates whether the template enforces law-based sample limit rules. ### label - **Description**: Specifies the display name of the sample limit template. ### priorityNumber - **Description**: Defines the priority order in which this template is evaluated. ### ruleCondition - **Description**: Defines the condition that determines when the rule is applied. ### ruleExpression - **Description**: Specifies the expression used to evaluate the sample limit rule. ## Declarative Metadata Sample Definition The following is an example of a ProviderSampleLimitTemplate component. SampleLimitTemplate\_Standard Standard Sample Limit Template true false false true 1 Warning Account.Type = 'Provider' SampleQuantity <= 100 The following is an example package.xml that references the previous definition. SampleLimitTemplate\_Standard ProviderSampleLimitTemplate 66.0 # ProviderSampleLimitTemplate Setup object that represents the definition and rules of sample limits templates. This object is available in API version 65.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. ### DiscrepancyAlertType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether a rule violation in the template is flagged as an error or a warning. - **Default value**: Error - **Possible values**: - Error - Warning ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this template is active or not. - **Default value**: false ### IsAdvanced - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the type of custom template. Defines whether or not the template is advanced. - **Default value**: false ### IsCloned - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the template is a cloned generic template or not. Cloned generic templates and advanced templates not flagged as IsLawBased are flagged as True. - **Default value**: false ### IsLawBased - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an advanced template is a country regulation or not. If the template is law-based, the DiscrepancyAlertType setting is Error. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the ProviderSampleLimitTemplate record. ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for this provider sample limit template value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that aren’t Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### PriorityNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority order of the cloned generic template to be applied to a product. ### RuleCondition - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. The rules that establish the limits for this template. ### RuleExpression - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. Specifies the rules to be evaluated and the boolean operation (AND/OR) for combining multiple rules. # ProviderSampleLimitTemplate Contains definition and rules of sample limits templates. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. The name: - must be 40 characters or fewer - must begin with a letter - can contain only underscores and alphanumeric characters - can't include spaces - can't end with an underscore - can’t contain 2 consecutive underscoresIn managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. ### DiscrepancyAlertType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specify whether a rule violation in the template is flagged as an error or a warning. - **Default value**: Error - **Possible values**: - Error - Warning ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this template is active or not. - **Default value**: false ### IsAdvanced - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the type of custom template. Defines whether or not the template is advanced. - **Default value**: false ### IsCloned - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the template is a cloned generic template or not. Cloned generic templates and advanced templates not flagged as IsLawBased are flagged as True. - **Default value**: false ### IsLawBased - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an advanced template is a country regulation or not. (If the template is law-based, the DiscrepancyAlertType setting is Error.) - **Default value**: false ### ManageableState - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Indicates the manageable state of the specified component that is contained in a package. - **Possible values**: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Label for this provider sample limit template value. This display value is the internal label that doesn't get translated. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the NAMESPACE\_PREFIX\_\_COMPONENT\_NAME notation. Replace NAMESPACE\_PREFIX with the namespace prefix, and replace COMPONENT\_NAME with the component name. The namespace prefix can have one of the following values. - In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. - In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix. ### PriorityNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Priority order of the cloned generic template to be applied to a product. ### RuleCondition - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. The rules that establish the limits for this template. ### RuleExpression - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. Specifies the rules to be evaluated and the boolean operation (AND/OR) for combining multiple rules. # ProviderSearchSyncLog Represents a log with information about the provider search data sync status of a healthcare provider record. This object is available in API version 49.0 and later. ## Supported Calls delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete() ## Fields ### FacilityId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The business account of the facility. This field is a relationship field. - **Relationship Name**: Facility - **Relationship Type**: Lookup - **Refers To**: Account ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastSync - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp of the most recent data sync. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Message - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The message returned if an error occurred during the data sync. ### Name - **Type**: string - **Properties**: Filter, Group, idLookup, Sort - **Description**: Name of the provider search sync log. ### OwnerId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The ID of the owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProviderId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the healthcare organization or the practitioner. This field is a relationship field. - **Relationship Name**: Provider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### ProviderName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the healthcare provider. ### SyncStatus - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Sort - **Description**: The status of the data sync. - **Default value**: Success - **Possible values**: - Failure - Success ## 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. [ProviderSearchSyncLogChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [ProviderSearchSyncLogFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderSearchSyncLogHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderSearchSyncLogOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ProviderSearchSyncLogShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderSmplLmtTmplAssignment Junction that relates sample limit templates to products. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the provider sample limit template assignment. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider sample limit template assignment. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Product related to the sample limit template. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### PrvdSampleLimitTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. Related sample limit template. This field is a relationship field. - **Relationship Name**: PrvdSampleLimitTemplate - **Refers To**: ProviderSampleLimitTemplate ### RuleCondition - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. JSON structure with rules and configured limits from the template. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ## 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. [ProviderSmplLmtTmplAssignmentFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderSmplLmtTmplAssignmentHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderSmplLmtTmplAssignmentShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderVisit Represents the details of a field user's visit to a health care provider. For example, a sales representative visiting a health care provider to discuss product usage and efficacy to enhance adoption. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account associated with the provider visit. Derived from the related visit (Visit object). This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability including account name. ### BookingStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The booking status of the provider visit. - **Possible values**: - Accepted - Proposed - Rejected - Retrieved ### BookingStatusReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the reason for a rejection of the provider visit. ### Channel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the channel type for the provider visit. Derived from the related visit (Visit object). ### ComplianceStatements - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Compliance statements displayed to the field user. ### GeoLocOnSubmit - **Type**: location - **Properties**: Nillable - **Description**: The GPS location captured upon the provider visit submission. ### GeoLocOnSubmitLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The GPS latitude captured upon the provider visit submission. ### GeoLocOnSubmitLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The GPS longitude captured upon the provider visit submission. ### HasAttachments - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: On submission, indicates if the provider visit has attachments. - **Default value**: false ### InvitationEmailAddress - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Email address used to send an invitation for a remote visit. ### InvitationEmailBouncedRsn - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for a bounced email invitation for a remote visit. ### InvitationEmailStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Shows the status of an attendee’s email invitation for a remote visit. - **Possible values**: - Accepted - Bounced - Declined - Pending - Sent - Tentative ### IsAdhocProviderVisit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider visit was initiated spontaneously, without prior scheduling. - **Default value**: false ### IsBackdatedSbmtVldSkipped - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the backdated validation is skipped on provider visit submission. - **Default value**: false ### IsBackdatedSgnVldSkipped - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the backdated validation is skipped. - **Default value**: false ### IsConfirmed - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a confirmation is received from the provider for the scheduled date and time of the planned visit. - **Default value**: false ### IsOfflineModeSignature - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the provider visit is signed offline and online validation isn't applied to this visit. - **Default value**: false ### IsOfflineModeSubmit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that provider visit is submitted offline and online validation isn't applied to this visit. - **Default value**: false ### IsRecordOwner - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the user is the owner of the provider visit record. This field is a calculated field. - **Default value**: false ### IsSignedAwayFrmAllowDstn - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the provider visit is signed outside the allowed distance. - **Default value**: false ### IsSubmitAwayFrmAllowDstn - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the provider visit is submitted outside the allowed distance. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### LifeScienceAccountListId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account list that's associated with the provider visit. This field is a relationship field. - **Relationship Name**: LifeScienceAccountList - **Refers To**: LifeScienceAccountList ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider visit. ### NextProviderVisitObjective - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Next visit objective for the provider. ### NextPrvdVisitObjectiveType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Next visit objective type for the provider. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PhysicalFormIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the physical form signed instead of an electronic signature. ### PlannedEndTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The planned end date and time for the provider visit. Derived from the related visit (Visit object). ### PlannedStartTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The planned start date and time for the provider visit. Derived from the related visit (Visit object). ### PreProviderVisitNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The notes derived from the next provider visit objectives of the previous provider visit submitted on the account by the user. ### ProvVisitDlvrSampleCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The record count of delivered samples linked to the provider visit. Derived from the related visit (Visit object). ### ProvVisitMktItemCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The record count of marketing items linked to the provider visit. Derived from the related visit (Visit object). ### ProvVisitProdDtlCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The record count of detailing products linked to the provider visit. Derived from the related visit (Visit object). ### ProvVisitReqSampleCount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The record count of requested samples linked to the provider visit. Derived from the related visit (Visit object). ### RemoteAttendanceStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether an attendee joined the remote call or missed it. - **Possible values**: - Attended - NoShow ### RemoteChannelServiceProvider - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The service provider for the remote session. - **Possible values**: - MsTeams - Twilio ### RemoteSessionStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the remote session was created successfully. - **Possible values**: - AddAttendeeFailed - CreateFailed - Pending - Ready - RemoveAttendeeFailed - Retry - UpdateAccountFailed - UpdateChannelFailed - UpdateDateTimeFailed ### RemoteSessionStatusReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The reason that remote session creation failed. - **Possible values**: - Unauthorized ### ShippingAddressId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The shipping address of the requested samples for the provider visit. This field is a relationship field. - **Relationship Name**: ShippingAddress - **Refers To**: ContactPointAddress ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### Status - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The status of the provider visit. Derived from the related visit (Visit object). - **Default value**: Planned - **Possible values**: - Abandoned - Completed - Error - InProgress - None - Planned - Unscheduled ### SubmitDelayReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for a delay in submitting the provider visit. ### SubmitDelayReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason type for a delay in submitting the provider visit. ### SubmitGeolcMissingReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Reason populated when GPS is not captured upon the provider visit submission. - **Possible values**: - BadData - DeviceRestricted - Offline - UserRestricted ### SubmitGeolocationTimestamp - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when GPS is captured upon the provider visit submission. ### TerritoryId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The associated territory record. Derived from the related visit (Visit object). This field is a relationship field. - **Relationship Name**: Territory - **Refers To**: Territory2 ### TerritoryName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the territory associated with the provider visit. ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The associated visit record. This field is unique within your organization. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Master-detail - **Refers To**: Visit (the master object) ### VisitSubmitDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the provider visit is submitted. ## 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. [ProviderVisitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ProviderVisitFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderVisitHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ProviderVisitChangedEvent Represents an event for a data manipulation operation performed on a provider visit record. This object is available in API version 65.0 and later. ## Supported Calls create(), describeSObjects() ## Fields ### OperationType - **Type**: picklist - **Properties**: Create, Nillable, Restricted picklist - **Description**: Specifies the type of the data manipulation operation. - **Possible values**: - Delete - Insert - Update - Upsert ### SourceType - **Type**: picklist - **Properties**: Create, Nillable, Restricted picklist - **Description**: Specifies the source type of the event. - **Possible values**: - Mobile - Web ### UserIdentifier - **Type**: string - **Properties**: Create, Nillable - **Description**: The user ID of the Provider Visit record owner. It indicates the user who either created or last updated the visit. ### VisitId - **Type**: reference - **Properties**: Create, Nillable - **Description**: The ID of the Provider Visit record that triggered the event. It links the event to a specific visit. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit # ProviderVisitDtlProductMsg Represents delivered messages and reactions from the health care provider for products discussed during a visit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability. ### CapturedReaction - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Provider's reaction to detailing product message. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### IsGeneratedFromPresentation - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is generated based on an intelligent content presentation. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### MessageRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Reference to detailing product message record. This field is a relationship field. - **Relationship Name**: MessageRecord - **Refers To**: ProductGuidance ### MessageText - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The message text from the associated product guidance record displayed in related lists. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider visit detailing product message. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProviderVisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. Associated provider visit record. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Refers To**: ProviderVisit ### ProviderVisitProductDtlId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. Associated provider visit product detailing record. This field is a relationship field. - **Relationship Name**: ProviderVisitProductDtl - **Relationship Type**: Master-detail - **Refers To**: ProviderVisitProdDetailing (the master object) ### ReactionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Provider's reaction to detailing product message. - **Possible values**: - Negative - Neutral - Positive ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### VisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. Associated visit record. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [ProviderVisitDtlProductMsgFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderVisitDtlProductMsgHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderVisitDtlProductMsgShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderVisitMarketingItem Represents marketing items provided to the health care provider as part of a visit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### IsSignatureCaptured - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the signature has been captured. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider visit marketing item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The marketing item disbursed to the provider. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The associated provider visit record. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Relationship Type**: Master-detail - **Refers To**: ProviderVisit (the master object) ### Quantity - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Required. Quantity of marketing items disbursed to the provider. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### VisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. The associated visit record. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [ProviderVisitMarketingItemFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderVisitMarketingItemHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderVisitMarketingItemShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderVisitProdDetailing Represents products discussed during a visit with a health care provider, including key details such as the product brand, therapeutic area, and other relevant information. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability including product name. ### BrandId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The brand discussed during the provider visit. This field is a polymorphic relationship field. - **Relationship Name**: Brand - **Refers To**: LifeSciMarketableProduct ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### IsGeneratedFromPresentation - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is generated based on an intelligent content presentation. - **Default value**: false ### IsOffLabel - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the product detailing is off-label. - **Default value**: false ### IsSignatureCaptured - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the signature was captured. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider visit product detailing. ### NextPrvdVisitObjectives - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Next visit objectives for the provider regarding the detailing product. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Priority - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Indicates the order in which the product information is delivered to the provider. ### ProductHierarchyName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The generated name of the brand, indication and therapeutic area combination discussed during the provider visit. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The product discussed during the provider visit. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ProductIndicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indication discussed during the provider visit. This field is a polymorphic relationship field. - **Relationship Name**: ProductIndication - **Refers To**: LifeSciMarketableProduct ### ProductTherapeuticAreaId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Therapeutic area discussed during the provider visit. This field is a polymorphic relationship field. - **Relationship Name**: ProductTherapeuticArea - **Refers To**: LifeSciMarketableProduct ### ProviderVisitAccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account associated with the provider visit. Derived from the related visit (ProviderVisit object). This field is a relationship field. - **Relationship Name**: ProviderVisitAccount - **Refers To**: Account ### ProviderVisitChannel - **Type**: picklist - **Properties**: Filter, Group, Nillable, Sort - **Description**: Specifies the channel type for the provider visit. Derived from the related visit (ProviderVisit object). ### ProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The associated provider visit record. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Relationship Type**: Master-detail - **Refers To**: ProviderVisit (the master object) ### ProviderVisitStatus - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The status of the provider visit. Derived from the related visit (ProviderVisit object). - **Default value**: Planned - **Possible values**: - Abandoned - Completed - Error - InProgress - None - Planned - Unscheduled ### ProviderVisitTerritoryId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The territory associated with the provider visit. Derived from the related visit (ProviderVisit object). This field is a relationship field. - **Relationship Name**: ProviderVisitTerritory - **Refers To**: Territory2 ### PrvdVisitPlannedEndTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The planned end date and time for the provider visit. Derived from the related visit (ProviderVisit object). ### PrvdVisitPlannedStartTime - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The planned start date and time for the provider visit. Derived from the related visit (ProviderVisit object). ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### VisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. Associated visit record. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [ProviderVisitProdDetailingFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderVisitProdDetailingHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderVisitProdDetailingShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderVisitProdDiscussion Represents any additional notes or information regarding the products discussed during a visit to a health care provider. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider visit product discussion. ### Note - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. Notes associated with the product discussion. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProviderVisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The provider visit associated with the product discussion. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Refers To**: ProviderVisit ### ProviderVisitProductDtlId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The detailing product associated with the product discussion. This field is a relationship field. - **Relationship Name**: ProviderVisitProductDtl - **Relationship Type**: Master-detail - **Refers To**: ProviderVisitProdDetailing (the master object) ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### VisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. Associated visit record. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: Visit ## 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. [ProviderVisitProdDiscussionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ProviderVisitProdDiscussionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ProviderVisitProdDiscussionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ProviderVisitRqstSample Represents sample products requested to be shipped to the health care provider during a visit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActualDeliveryDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date when the samples are delivered to the provider. ### AdditionalInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information captured on signature capture or provider visit submission for auditability. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### DeliveryStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Delivery status of the sample order. ### DistributorName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the distributor for the samples. ### ExpectedDeliveryDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Expected delivery date of the samples. ### IsCalcForDirToPhysician - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the samples have been calculated for territory product quantity allocation. - **Default value**: false ### IsSignatureCaptured - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the signature was captured. - **Default value**: false ### IsTrackedForSmplTrxnLimit - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the samples are tracked in sample limit transaction. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastShippedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Indicates the number of items in the previous shipment. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider visit requested sample. ### OrderTrackingIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Tracking number of the sample shipment. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The sample product requested by the provider. This field is a relationship field. - **Relationship Name**: Product - **Refers To**: Product2 ### ProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The associated provider visit record. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Relationship Type**: Master-detail - **Refers To**: ProviderVisit (the master object) ### RequestedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Requested quantity of samples. ### ShippedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Shipped quantity of the samples. ### ShippingAddressId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The shipping address associated with the provider visit requested sample. This field is a relationship field. - **Relationship Name**: ShippingAddress - **Refers To**: ContactPointAddress ### ShippingDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date when the samples are shipped. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: An external ID from the source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system for data integrations. ### ViolationType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The type of violation. ### VisitId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Required. The associated visit record. This field is a relationship field. - **Relationship Name**: Visit - **Relationship Type**: Master-detail - **Refers To**: Visit (the master object) ### WarningMessage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Warning message displayed for the validation of territory product quantity allocation. ## 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. [ProviderVisitRqstSampleHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PrstCntntDefAssignment Represents assignment of presentation content definition, such as a Podcast or Text Summary to the users, profiles, or groups authorized to access or view, enforcing content visibility and entitlement rules. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### AssignedToId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the profile the content definition is assigned to. This field is a relationship field. - **Relationship Name**: AssignedTo - **Refers To**: Profile ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Represents whether the assignment is active or not. - **Default value**: false ### PrstContentDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents the parent definition record for the presentation content. This field is a relationship field. - **Relationship Name**: PrstContentDefinition - **Relationship Type**: Master-detail - **Refers To**: PrstContentDefinition (the master object) # PrstCntntUsageSummary Represents information about the usage of the content asset, including number of times it has been consumed and the point till which it has been consumed. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### LastConsumedPosition - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the last position of the consumed presentation content. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastUsedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the date and time the presentation content was consumed. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the presentation content. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PresentationContentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the presentation content that's played. This field is a relationship field. - **Relationship Name**: PresentationContent - **Refers To**: PresentationContent ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the external system that generated the record. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Represents the usage status of the presentation content. - **Possible values**: - Completed - InProgress - NotStarted ### UsageCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the number of times the presentation content was consumed. ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the user consuming the presentation content. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User # PrstContentDefinition Represents the reusable configuration required to generate an end-user content asset, such as an audio summary. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Fields ### ContentType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Represents the type of content for which the content definition record is created. - **Possible values**: - Podcast - Video - Text ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the content definition. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique name of the object in the API. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Represents whether the content definition is active or not. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Language of the presentation content definition. - **Possible values**: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label for this Presentation Content Definition value. ### NamespacePrefix - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The prefix of the namespace. ### RetentionDayCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the number of days for which the content is available # PrvdAccountTerritorySummary Represents the summaries generated for a provider account for the terrories it is aligned to. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Account for which the summary is generated. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ChangeInfoSummaryDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time at which change information summary is generated. ### ChangeInfoSummaryHistory - **Type**: textarea - **Properties**: Nillable - **Description**: History of latest change history summaries. ### ChangeInformationHash - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Hash of the change information for which summary is generated. ### ChangeInformationSummary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Summary of the change information of the account since the user's last interaction. ### KeyInfoSummaryDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time at which key information summary is generated. ### KeyInfoSummaryHistory - **Type**: textarea - **Properties**: Nillable - **Description**: History of latest Key info summaries. ### KeyInformationHash - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Hash of the key information for which the summary is generated. ### KeyInformationSummary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Summary of the key information of the account. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, this record may have been referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the provider account territory summary. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the external system that generated the record. ### Territory2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Territory of the account for which the summary is generated. This field is a relationship field. - **Relationship Name**: Territory2 - **Refers To**: Territory2 ### UserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Context of the user for which the account summary is generated. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User ## 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. [PrvdAccountTerritorySummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [PrvdAccountTerritorySummaryFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdAccountTerritorySummaryHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PrvdAccountTerritorySummaryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PrvdAccountTerritorySummaryShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PrvdAccountUserGroupInfo Represents the classification values for the provider account user group. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The provider account associated with the user group. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### Advocacy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the level of advocacy of the healthcare provider for the products and services offered by the company. ### GroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The user group used for classification. This field is a relationship field. - **Relationship Name**: Group - **Refers To**: Group ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider account user group info. ### OpportunityScore - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description** ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ## 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. [PrvdAccountUserGroupInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PrvdAccountUserGroupInfoOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PrvdAccountUserGroupInfoShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PrvdActvtyGoalMeasureProdt Represents the details of the products associated with the activity goal measure. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider activity goal measure product. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the provider activity goal measure. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ProductWeightage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The weightage for all product-related activities associated with the provider activity goal measure. ### ProviderActvtyGoalMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The provider activity goal measure associated with the provider activity goal measure product. This field is a relationship field. - **Relationship Name**: ProviderActvtyGoalMeasure - **Relationship Type**: Master-detail - **Refers To**: ProviderActivityGoalMeasure (the master object) ## 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. [PrvdActvtyGoalMeasureProdtFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdActvtyGoalMeasureProdtHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PrvdActvtyPlanAdjProdt Represents the details of the products associated with the provider activity plan adjustment. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Timestamp when the current user last viewed the record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the product-related activity plan adjustment request. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product associated with the provider activity plan adjustment. This field is a polymorphic relationship field. - **Relationship Name**: Product - **Refers To**: LifeSciMarketableProduct, Product2 ### ProductWeightage - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The weightage for all product-related activities associated with the provider activity plan adjustment. ### ProviderActvtyPlanAdjusmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The provider activity plan adjustment associated with the provider activity plan adjustment product. This field is a relationship field. - **Relationship Name**: ProviderActvtyPlanAdjusment - **Relationship Type**: Master-detail - **Refers To**: ProviderActvtyPlanAdjusment (the parent object) ## 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. [PrvdActvtyPlanAdjProdtFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdActvtyPlanAdjProdtHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PrvdEngmtComplianceCycle Represents the duration and progress of compliance cycles for a provider, which captures essential metadata to ensure effective monitoring and management of compliance-related activities. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionDelayReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the reason why the account was not visited. ### ActualContactPointType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel used to interview the account. ### CompletionAssessmentTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the assessment task that completes the provider engagement compliance cycle. This field is a relationship field. - **Relationship Name**: CompletionAssessmentTask - **Refers To**: AssessmentTask ### CompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the compliance cycle was completed. ### DurationInDays - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration of the compliance cycle in days. ### EffectiveEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the compliance cycle ends. ### EffectiveStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the compliance cycle begins. ### IsStoppedOnCurrentCycle - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the compliance process was stopped in the current cycle. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the compliance cycle. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the compliance cycle. - **Default value**: New - **Possible values**: - Completed - New - Skipped ## 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. [PrvdEngmtComplianceCycleChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [PrvdEngmtComplianceCycleFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdEngmtComplianceCycleHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PrvdEngmtComplianceCycleShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PrvdManagedEventVldEvent Represents an event that's generated when a provider-related managed event fails or breaches its validation limits. This triggers notifications to users to take prompt action to rectify the breach. This object is available in API version 67.0 and later. ## Supported Calls create(), describeSObjects() ## Special Access Rules This object is available to users with the Life Sciences Commercial Admin permission set. ## Fields ### EventUuid - **Type**: string - **Properties**: Nillable - **Description**: A universally unique identifier (UUID) that identifies a platform event message. ### MngEventId - **Type**: reference - **Properties**: Create, Nillable - **Description**: Represents the related managed event. This field is a relationship field. - **Relationship Name**: MngEvent - **Refers To**: MngEvent ### ReplayId - **Type**: string - **Properties**: Nillable - **Description**: Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window. ### ValidationMessage - **Type**: textarea - **Properties**: Create, Nillable - **Description**: Represents a string that contains the validation message displayed for the event. ### ValidationType - **Type**: string - **Properties**: Create, Nillable - **Description**: Represents the type of validation message that's displayed for the event. # PrvdVstSmplLmtDiscrepancy Represents discrepancies that occur when samples or sample shipment requests exceed a sample limit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AlertMessage - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. A description of the discrepancy that occurred. ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the provider visit sample limit discrepancy. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### DiscrepancyAlertType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Specifies whether the discrepancy is an error or a warning. - **Default value**: Error - **Possible values**: - Error - Warning ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Required. ### ProviderSampleLimitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The sample limit record on which this discrepancy occurred. This field is a relationship field. - **Relationship Name**: ProviderSampleLimit - **Relationship Type**: Master-detail - **Refers To**: ProviderSampleLimit (the master object) ### PrvdVisitSampleRefRecId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The call sample or call sample order on which the discrepancy occurred. This field is a polymorphic relationship field. - **Relationship Name**: PrvdVisitSampleRefRec - **Refers To**: ProductDisbursement, ProviderVisitRqstSample ### PrvdVstSmplLmtTransactionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated provider visit sample limit transaction record related to sample discrepancy. This field is a relationship field. - **Relationship Name**: PrvdVstSmplLmtTransaction - **Refers To**: PrvdVstSmplLmtTransaction ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Indicates the status of a provider visit sample limit discrepancy as it is triaged by an admin. - **Default value**: Open - **Possible values**: - Closed - InProgress - Open ## 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. [PrvdVstSmplLmtDiscrepancyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdVstSmplLmtDiscrepancyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # PrvdVstSmplLmtTransaction Represents samples or sample shipment requests captured in a visit. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrencyIsoCode - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The ISO currency code associated with the currency values in the provider visit sample limit transaction. - **Default value**: USD - **Possible values**: - USD—U.S. Dollar ### IsRollback - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is a rollback transaction. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the provider visit sample limit transaction. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner or creator of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ProviderSampleLimitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. The sample limit related to this transaction. This field is a relationship field. - **Relationship Name**: ProviderSampleLimit - **Refers To**: ProviderSampleLimit ### ProviderVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. Related call record. This field is a relationship field. - **Relationship Name**: ProviderVisit - **Refers To**: ProviderVisit ### RelatedTransactionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the original sample limit transaction. This field is a relationship field. - **Relationship Name**: RelatedTransaction - **Refers To**: PrvdVstSmplLmtTransaction ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external source system for data integrations. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external source system from which the record was imported. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Required. Indicates the status of the transaction. - **Possible values**: - Failed - New - Pending - Success ### TransactionInfo - **Type**: textarea - **Properties**: Create, Update - **Description**: Required. This information is used to create sample limit events and updates to sample limit records. ## 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. [PrvdVstSmplLmtTransactionFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PrvdVstSmplLmtTransactionHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PrvdVstSmplLmtTransactionShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Purchaser A 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. # Purchaser Group A purchaser group is a subset of the purchaser. For example, your company may have individual employee groups in different regions of 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_account.htm "HTML (New Window)") To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Purchaser Group Member Association An association that records the members who belong to a purchaser group. This association is represented by records on the AccountContactRelation object. To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Purchaser Payer Association An association that records the purchasers who purchase plans from payers. This association is represented by records on the AccountAccountRelation object. # PurchaserPlan Represents the payer plan that a purchaser makes available to its members and members’ dependents. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() # PurchaserPlanAssn Represents a junction object that associates the purchaser to the plans they offer to members. ## Supported Calls create(),  delete(),  describeLayout(),  describeSObjects(),  getDeleted(),  getUpdated(),  query(),  retrieve(),  search(),  undelete(),  update(),  upsert() ## Fields ### LastReferencedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: datetime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, Sort - **Description**: The name of this purchaser to purchaser plan association. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PurchaserId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the plan purchaser’s Account object record. ### PurchaserPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the associated plan on the Purchaser Plan object. ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the purchaser plays a primary or secondary role in the plan. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system this record came from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of this record on its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed on the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether this purchaser plan relationship is active. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PurchaserPlanAssnChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [PurchaserPlanAssnFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PurchaserPlanAssnHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PurchaserPlanAssnOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PurchaserPlanAssnShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # PV1 - Patient Visit The Patient Visit (PV1) HL7 segment maps to the Encounter object, among other objects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for PV1 map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the Segments supported by Salesforce are mentioned below. Table 1. PV1 - Salesforce | PV1 | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | PV1.2 - Patient Class | ​​Clinical​Encounter​​.​Category | Picklist | N/A | | PV1.3 - Assigned Patient Location | ​​Clinical​Encounter​​Facility | Object | The facility information for a patient visit is represented as ​​Clinical​Encounter​​Facility records that reference the encounter record using their ​​Clinical​Encounter​​Facility​.​​Clinical​Encounter​Id field​. | | PV1.4 - Admission Type | ​​Clinical​Encounter​​.​TypeId | Lookup: ​CodeSet​Bundle | N/A | | PV1.5 - Preadmit Number | Clinical​Encounter​​.​Pre​Admission​Identifier​Id | Lookup: ​Identifier | N/A | | PV1.7 - Attending Doctor | Clinical​Encounter​​Provider | Object | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. | | PV1.8 - Referring Doctor | Clinical​Encounter​​Provider | Object | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. | | PV1.9 - Consulting Doctor | Clinical​Encounter​​Provider | Object | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. | | PV1.10 - Hospital Service | Clinical​Encounter​​.Service​Type | Picklist | N/A | | PV1.13 - Readmission Indicator | Clinical​Encounter​​.​Readmission​CodeId | Lookup: CodeSetBundle | N/A | | PV1.14 - Admit Source | ​​Clinical​Encounter​​.​Admission​Source | Picklist | N/A | | PV1.16 - VIP Indicator | ​​Clinical​Encounter​​.Special​Courtesy | Picklist | N/A | | PV1.17 - Admitting Doctor | Clinical​Encounter​​Provider | Object | The participant information for an encounter is represented as ​​Clinical​Encounter​​Provider records that reference the encounter record using their ​​Clinical​Encounter​​Provider​.​​Clinical​Encounter​Id field​. | | PV1.18 - Patient Type | ​​Clinical​Encounter​​.​TypeId | Lookup: ​CodeSet​Bundle | N/A | | PV1.19 - Visit Identifier | ​​Clinical​Encounter​Identifier | Object | The identifier information for an encounter is represented as ​​Clinical​Encounter​Identifier records that reference the encounter record using their ​​Clinical​Encounter​Identifier​.​Parent​RecordId field​. | | PV1.22 - Courtesy Code | ​​Clinical​Encounter​​.Special​Courtesy | Picklist | N/A | | PV1.36 - Discharge Disposition | Clinical​Encounter​​.​Discharge​Disposition​Id | Lookup: ​CodeSet​Bundle | N/A | | PV1.37 - Discharged to Location | ​​Clinical​Encounter​​.​Destination​FacilityId | Lookup: HealthcareFacility | N/A | | PV1.37 - Discharged to Location | ​​Clinical​Encounter​​.​Destination​Organization​Id | Lookup: Account | N/A | | PV1.38 - Diet Type | ​​​​Clinical​Encounter​​.​Diet​Preference | Picklist | N/A | | PV1.44 - Admit Date/Time | ​​Clinical​Encounter​​.Start​Date | DateTime | N/A | | PV1.45 - Discharge Date/Time | ​​Clinical​Encounter​​.End​Date | DateTime | N/A | | PV1.50 - Alternate Visit ID | ​​Clinical​Encounter​Identifier | Object | The identifier information for an encounter is represented as ​​Clinical​Encounter​Identifier records that reference the encounter record using their ​​Clinical​Encounter​Identifier​.​Parent​RecordId field​. | # PV2 - Patient Visit - Additional Information The Patient Visit - Additional Information (PV2) HL7 segment maps primarily to the ClinicalEncounter object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for PV2 map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below. Table 1. PV2 - Salesforce | PV2 | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | PV2.3 - Admit Reason | ​​Clinical​Encounter​​Reason​.​Reason​CodeId | Lookup: CodeSetBundle | N/A | | PV2.7 - Visit User Code | ClinicalAlert.CodeId | Lookup: CodeSetBundle | N/A | | PV2.11 - Actual Length of Inpatient Stay | ​​Clinical​Encounter​​.​Duration | Double | N/A | | PV2.11 - Actual Length of Inpatient Stay | Clinical​Encounter​​.​Duration​UnitId | Lookup: UnitOfMeasure | N/A | | PV2.25 - Patient Status Code | Clinical​Encounter​​.​PriorityId | Lookup: CodeSetBundle | N/A | # QuoteDocumentCreationEvent Represents the event that's generated when a quote document is created. This object is available in API version 68.0 and later. ## Supported Calls create(), describeSObjects() ## Fields ### DocumentType - **Type**: picklist - **Properties**: Create, Nillable, Restricted picklist - **Description**: The type of the quote document being generated. - **Possible values**: - QUOTE\_DOCUMENT - SFS\_QUOTE\_DOCUMENT ### QuoteDocument - **Type**: reference - **Properties**: Create, Nillable - **Description**: Stores the data of the generated quote document in PDF format. This field is a relationship field. - **Relationship Name**: QuoteDocument - **Refers To**: QuoteDocument ### Title - **Type**: string - **Properties**: Create, Nillable - **Description**: A readable name of the quote document. # ReceivedDocument Contains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Direction - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the org is receiving or sending the document. - **Possible values**: - INCOMING—Incoming - OUTGOING—Outgoing ### DocumentNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique document identification number. ### HasAutoOcrDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Determines whether text is extracted from the document automatically. Default is False. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the document is being processed. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it's possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the received document. ### OcrStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Current state of the text extraction process. Possible values are: Draft, Approved, In Approval, In Review, Obsolete, Superseded, Archived. Default is Draft. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns the ReceivedDocument record. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the order in which the document is processed when it is part of a queue. - **Possible values**: - ONE—1 - THREE—3 - TWO—2 ### Source - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Origin of the incoming document. Can be used to specify processing priority. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Current stage of processing. - **Possible values**: - APPROVED - ARCHIVED - COMPLETED—Document processing is complete. - DRAFT - IN\_REVIEW - NEEDS\_REVIEW—Document requires review, for example because processing couldn’t be completed. - OBSOLETE - PROCESSING—Document processing is in progress. - SUPERSEDED ### StatusReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Reason for the status when processing and transforming the document. ## 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. [ReceivedDocumentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. # ReceivedDocumentType Represents a junction object between Received Document and Document Type. This object is available in API version 58.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DocumentTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the document type for the document checklist item. This field is a relationship field. - **Relationship Name**: DocumentType - **Relationship Type**: Lookup - **Refers To**: DocumentType ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the received document type. ### PageNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Page number of the received document. ### ReceivedDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the received document for the received document type. This field is a relationship field. - **Relationship Name**: ReceivedDocument - **Relationship Type**: Lookup - **Refers To**: ReceivedDocument ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [ReceivedDocumentTypeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. # RecordAlert Represents an alert message about a specific record and tracks the status and active period of the alert. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdditionalMessage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional details of the message that are communicated in the alert. This field contains information such as the tag, alert action, URL, or color. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The detailed description of the alert. ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time that the alert was generated or became active. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the alert is still active (true) or has been dismissed (false). - **Default value**: false ### IsSilent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the alert is silent or not. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record alert. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of the record alert. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user, account, or contact associated with the alert. This field is a polymorphic relationship field. - **Relationship Name**: Parent - **Refers To**: Account, ApplicationForm, Asset, BenefitAssignment, BenefitDisbursement, BenefitManagementRecertification\_\_c, BusinessMilestone, Case, Claim, Contact, Contract, GoalAssignment, IndividualApplication, InsurancePolicy, InsurancePolicyCoverage, Lead, LoanApplicant, LoanApplicantEmployment, LoanApplicantIncome, LoanApplicationAsset, LoanApplicationFinancial, LoanApplicationLiability, LoanApplicationProperty, Opportunity, PersonLifeEvent, ResidentialLoanApplication, User, lsc4ce\_\_Foo\_\_c, omnistudio\_\_CardFrameworkConfiguration\_\_c, omnistudio\_\_DRBatchQueue\_\_c, omnistudio\_\_DRBulkData\_\_c, omnistudio\_\_DREncryption\_\_c, omnistudio\_\_DRWorker\_\_c, omnistudio\_\_Interface\_DRGeneric\_\_c, omnistudio\_\_TestResult\_\_c, omnistudio\_\_TriggerSetup\_\_c, omnistudio\_\_UISettings\_\_c, omnistudio\_\_VlocityDataPack\_\_c, omnistudio\_\_VlocityDocuSignTemplate\_\_c, omnistudio\_\_VlocityErrorLogEntry\_\_c, omnistudio\_\_VlocityScheduledJob\_\_c, omnistudio\_\_VlocityTrackingEntry\_\_c ### RecordAlertCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category for the alert. This field is a relationship field. - **Relationship Name**: RecordAlertCategory - **Refers To**: RecordAlertCategory ### Severity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The severity of the alert. - **Possible values**: - Error - Info - Warning ### SnoozeUntilDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date until which the alert is snoozed. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### Subject - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The subject of the alert. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the alert type. - **Possible values**: - GuidedAction - Notification - Recommendation ### ValidUntilDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the alert becomes invalid. ### WhatId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record that the alert pertains to. This field is a polymorphic relationship field. - **Relationship Name**: What - **Refers To**: Account, AccountPlan, AccountPlanObjective, ActionPlan, ApplicationForm, ApplicationFormProduct, AssessmentTask, Asset, BenefitAssignment, BenefitDisbursement, BenefitManagementRecertification\_\_c, BusinessMilestone, Case, Claim, Contact, Contract, Event, GoalAssignment, IndividualApplication, InsurancePolicy, InsurancePolicyCoverage, Lead, LifeScienceEmail, LoanApplicant, LoanApplicantEmployment, LoanApplicantIncome, LoanApplicationAsset, LoanApplicationFinancial, LoanApplicationLiability, LoanApplicationProperty, MedicalInsight, OmniScriptSavedSession, Opportunity, Order, PartyRelationshipGroup, PersonLifeEvent, Presentation, ResidentialLoanApplication, User, Visit, lsc4ce\_\_Foo\_\_c, omnistudio\_\_CardFrameworkConfiguration\_\_c, omnistudio\_\_DRBatchQueue\_\_c, omnistudio\_\_DRBulkData\_\_c, omnistudio\_\_DREncryption\_\_c, omnistudio\_\_DRWorker\_\_c, omnistudio\_\_Interface\_DRGeneric\_\_c, omnistudio\_\_TestResult\_\_c, omnistudio\_\_TriggerSetup\_\_c, omnistudio\_\_UISettings\_\_c, omnistudio\_\_VlocityDataPack\_\_c, omnistudio\_\_VlocityDocuSignTemplate\_\_c, omnistudio\_\_VlocityErrorLogEntry\_\_c, omnistudio\_\_VlocityScheduledJob\_\_c, omnistudio\_\_VlocityTrackingEntry\_\_c # RecordApexRepresentation Class Contains properties and a method to create a serializable representation of a record and its associated data for AI service integration and data processing. ## Namespace [embeddedai](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_namespace_embeddedai.htm "The embeddedai namespace provides classes and methods to manage and represent records and data in Apex to support embedded AI features.") - **[RecordApexRepresentation Constructors](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_constructors)** Learn more about the constructors available with the RecordApexRepresentation class. - **[RecordApexRepresentation Properties](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_properties)** - **[RecordApexRepresentation Methods](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_methods)** Create detailed, hierarchical record objects and convert them to a custom JSON string for structured AI input. ## RecordApexRepresentation Constructors Learn more about the constructors available with the RecordApexRepresentation class. The RecordApexRepresentation class includes these constructors. - **[RecordApexRepresentation(objectType, recordData, relatedRecordData)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_ctor)** Initializes a new instance of the RecordApexRepresentation class with the specified object type, primary record data, and related record data. This constructor represents a structured record and its relationships for consumption by embedded AI logic. - **[RecordApexRepresentation()](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_ctor_2)** Initializes the RecordApexRepresentation class. ### RecordApexRepresentation(objectType, recordData, relatedRecordData) Initializes a new instance of the RecordApexRepresentation class with the specified object type, primary record data, and related record data. This constructor represents a structured record and its relationships for consumption by embedded AI logic. #### Signature public RecordApexRepresentation(String objectType, List recordData, List relatedRecordData) #### Parameters - **objectType**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) The object type represented by this record (for example, Account, Case, or a custom object). This value defines the context in which the record data is interpreted by embedded AI processing. - **recordData**: Type: List<[embeddedai.ApexMap](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_class_embeddedai_ApexMap "Create, clone, and convert string based key-value pairs to a JSON string format.")\> The field-level data for the primary record as a collection of key–value pairs. Each ApexMap entry corresponds to a field name and its associated value used to construct the record context. - **relatedRecordData**: Type: List<[embeddedai.RecordApexRepresentation](#apex_class_embeddedai_RecordApexRepresentation "Contains properties and a method to create a serializable representation of a record and its associated data for AI service integration and data processing.")\> Related records associated with the primary record. Each entry represents a related object and its data, enabling hierarchical or relational record context to be passed to embedded AI logic. ### RecordApexRepresentation() Initializes the RecordApexRepresentation class. #### Signature public RecordApexRepresentation() ## RecordApexRepresentation Properties The following are properties for RecordApexRepresentation. - **[objectType](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_objectType)** Stores the type of the object. - **[recordData](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_recordData)** Stores a list of objects, where each object holds a key-value pair. - **[relatedRecordData](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_relatedRecordData)** Stores a list that contains a child or related records associated with the record data. ### objectType Stores the type of the object. #### Signature public String objectType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### recordData Stores a list of objects, where each object holds a key-value pair. #### Signature public List recordData {get; set;} #### Property Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_ApexMap.htm#apex_class_embeddedai_ApexMap "Create, clone, and convert string based key-value pairs to a JSON string format.") ### relatedRecordData Stores a list that contains a child or related records associated with the record data. #### Signature public List relatedRecordData {get; set;} #### Property Value Type: [List](#apex_class_embeddedai_RecordApexRepresentation "Contains properties and a method to create a serializable representation of a record and its associated data for AI service integration and data processing.") ## RecordApexRepresentation Methods Create detailed, hierarchical record objects and convert them to a custom JSON string for structured AI input. The following are methods for RecordApexRepresentation. - **[toRecordApexRep(jsonString)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_toRecordApexRep)** Converts a JSON-formatted string into a RecordApexRepresentation instance. This method parses the provided JSON and constructs a structured record representation that can be used by embedded AI logic. - **[toString()](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_toString)** Returns a structured JSON string representation of the RecordApexRepresentation object and its nested related records. ### toRecordApexRep(jsonString) Converts a JSON-formatted string into a RecordApexRepresentation instance. This method parses the provided JSON and constructs a structured record representation that can be used by embedded AI logic. #### Signature public static embeddedai.RecordApexRepresentation toRecordApexRep(String jsonString) #### Parameters - **jsonString**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) The JSON-formatted string containing record data and related record information to be converted into a RecordApexRepresentation object. #### Return Value Type: embeddedai.RecordApexRepresentation Returns a RecordApexRepresentation instance populated with the data parsed from the provided JSON string. ### toString() Returns a structured JSON string representation of the RecordApexRepresentation object and its nested related records. #### Signature public String toString() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # Rejected Merge Request Output A merge request that was rejected due to invalid input. ![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | winningId | String | The Salesforce ID of the Consolidated Account that was part of the rejected request. | Small, 65.0 | 65.0 | | winningExternalIdField | String | The external ID of the Consolidated Account that was part of the rejected request. | Small, 65.0 | 65.0 | | losingId | String | The Salesforce ID of the Merged Account that was part of the rejected request. | Small, 65.0 | 65.0 | | losingExternalIdField | String | The external ID of the Merged Account that was part of the rejected request. | Small, 65.0 | 65.0 | | errorMessage | String | The error message explaining why the request was rejected. | Small, 65.0 | 65.0 | # RelatedPerson The relatedPerson FHIR resource maps to the Account and Contact objects in Salesforce, and is connected to the person that person’s related to using the ContactContactRelation\_\_c object​. ## FHIR V4​.0 - Clinical ​Data Model Mapping Here’s how the fields defined by FHIR for [RelatedPerson](https://www.hl7.org/fhir/relatedperson.html) map to the fields in Salesforce​. Table 1. RelatedPerson - Salesforce | RelatedPerson Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0​.M | The identifier information for a related person is represented as Identifier records that reference the related person’s person account using their Identifier​.Parent​RecordId field​. | | active | Account​.IsActive | Boolean | 0​.1 | N/A | | patient | Contact​Contact​Relation\_\_c​.Contact\_\_c | Lookup: Contact | 1.1 | Though Salesforce can tehnically accommodate patient as a zero-to-many association, it is recommended to align with the FHIR defined one-to-one association. | | relationship | Contact​​Contact​​Relation\_\_c​​.Role\_\_c | Lookup: ReciprocalRole\_\_c | 0​.M | While FHIR defines relatedPerson​.relationship as a code set bundle, its Salesforce implementation is a reference to ReicprocalRole\_\_c​. | | name | Person​Name | Object | 0​.M | The name information for a related person is represented as Person​Name records that reference the related person’s person account using their Person​Name​.Parent​RecordId field​. | | telecom | Contact​Point​Phone | Object | 0​.M | The telecom information for a related person is represented as Contact​Point​Phone records that reference the related person’s person account using their Contact​Point​Phone​.ParentId field​. | | gender | Contact​.Gender | Picklist | 0​.1 | While FHIR defines relatedPerson​.gender as a code set, its Salesforce implementation is a picklist​. | | birth​Date | Contact​.Birthdate | ​Date | 0​.1 | N/A | | address | Contact​Point​Address | Object | 0​.M | The address information for a related person is represented as Contact​Point​Address records that reference the related person’s person account using their Contact​Point​Address​.ParentId field​. | | photo | N/A | N/A | N/A | Not supported | | period | Contact​​Contact​​Relation\_\_c​​.StartDate\_\_c | ​Date | 0​.1 | Because Salesforce doesn’t support a native period data type, the relatedPerson.period FHIR resource is flattened to a set of strart and end dates​. | | period | Contact​​Contact​​Relation\_\_c​​.EndDate\_\_c | ​Date | 0​.1 | Because Salesforce doesn’t support a native period data type, the relatedPerson.period FHIR resource is flattened to a set of strart and end dates​. | | communication | Person​Language | Object | 0​.M | The language information for a related person is represented as Person​Language records that reference the related person’s person account using their Person​Language​.IndividualId field​. | | communication​.language | Person​Language​.​Language | Picklist | 0​.1 | While FHIR defines relatedPerson​.communication​.language as a code set bundle, its Salesforce implementation is a picklist​. | | communication​.preferred | Person​Language​.Rank | Double | 0​.1 | While FHIR defines relatedPerson​.communication​.preferred as a boolean, its Salesforce implementation is an integer field that ranks the degree of preference​. | # Remote Engagement Enable sales and medical teams to connect with healthcare professionals virtually across multiple channels, with interactive and compliant content, data collection capabilities, and technology flexibility. The benefits of Remote Engagement include accessibility, compliance with regulations like GDPR, increased productivity, convenience in scheduling, and the ability to create interactions through video, voice, and digital assets. Users can plan, launch, conduct, and finish remote calls or meetings, by using tracking, screen sharing, remote signatures, and feedback capture. ![Remote Engagement entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_remote_engagement.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/remote-engagement.html "HTML (New Window)"). ## Remote Engagement Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Digital Signature](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_digitalsignature.htm) - [Video Call](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocall.htm) - [Video Call Participant](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocallparticipant.htm) - [Video Call Participant Request](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_videocallptcprequest.htm) - [Video Call Participant Session](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_videocallptcpsession.htm) - [Video Call Recording](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_videocallrecording.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Reopened By Input The name of the person who reopened the care request. ## Root XML tag ## JSON example "reopenedBy": { "username": "admin@um.org" } ## Properties
Name Type Description Required or Optional Available Version
username String The user who reopened the care request. No

Note: This field is required if reopenedBy is passed in the request.

 52.0
# Reopened By Output The name of the person who reopened the care request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | username | String | The user who reopened the care request. | Big, 52.0 | 52.0 | # Request Bodies This section lists the request bodies for Life Sciences Cloud Business APIs. The query parameters for an endpoint are listed along with each resource. To create a JSON request body, specify the properties of the request body in JSON format. If a request body is top-level, it has a root XML tag listed. To create an XML request body, nest the properties as XML tags inside the root XML tag. This guide documents request bodies unique to Life Sciences Cloud. Life Sciences Cloud includes features that are also availble in other Industries products. We document these shared features in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm "HTML (New Window)"). You can find request body reference for these features in that guide. ## Intelligent Form Reader These request bodies are documented in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm "HTML (New Window)"). - [Document Process Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_document_process_input.htm "HTML (New Window)") - [Fields Without Conflict Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_fields_without_conflict.htm "HTML (New Window)") ## Discovery Framework This request body is documented in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm "HTML (New Window)"). - [Assessment Links Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_links_input.htm "HTML (New Window)") # Requesting Practitioner Ordering or referring practitioner for the request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | healthCareProviderId | String | The provider associated with request creation for this prior authorization. This field is a lookup to HealthcareProviderId. | Big, 55.0 | 55.0 | | requestingPractitionerNpi | String | Requesting Practitioner NPI number. | Big, 46.0 | 46.0 | # Requesting Practitioner Input Ordering or referring practitioner for the request. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | healthCareProviderId | String | The provider associated with request creation for this prior authorization. This field is a lookup to HealthcareProviderId. | Yes | 55.0 | | npi | String | Requesting Practitioner‘s NPI number. | Yes | 46.0 | # ResearchStdyCmprGroupCndt Represents the junction between a research study control group and a research study candidate. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CandidateAllocSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The context through which the research study candidate is mapped to the research study group. This field is a polymorphic relationship field. - **Relationship Name**: CandidateAllocSource - **Refers To**: ResearchStudyRndmBlockSlot, devopsimpkg11\_\_CardFrameworkConfiguration\_\_c, devopsimpkg11\_\_DRBatchQueue\_\_c, devopsimpkg11\_\_DRBulkData\_\_c, devopsimpkg11\_\_DREncryption\_\_c, devopsimpkg11\_\_DRWorker\_\_c, devopsimpkg11\_\_Interface\_DRGeneric\_\_c, devopsimpkg11\_\_TestResult\_\_c, devopsimpkg11\_\_TriggerSetup\_\_c, devopsimpkg11\_\_UISettings\_\_c, devopsimpkg11\_\_VlocityDataPack\_\_c, devopsimpkg11\_\_VlocityDocuSignTemplate\_\_c, devopsimpkg11\_\_VlocityErrorLogEntry\_\_c, devopsimpkg11\_\_VlocityScheduledJob\_\_c, devopsimpkg11\_\_VlocityTrackingEntry\_\_c ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study comparison group candidate. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResearchStudyCandidateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study candidate associated with the research study candidate group. This field is a relationship field. - **Relationship Name**: ResearchStudyCandidate - **Refers To**: ResearchStudyCandidate ### ResearchStudyCmprGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study group associated with the research study candidate group. This field is a relationship field. - **Relationship Name**: ResearchStudyCmprGroup - **Refers To**: ResearchStudyCmprGroup ## 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. [ResearchStdyCmprGroupCndtFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStdyCmprGroupCndtHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStdyCmprGroupCndtShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStdyCndtStatusPrd Represents the time duration during which a research study candidate is assigned a specific status. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The effective end date and time of the candidate status. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The effective start date and time of the candidate status. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study candidate status period. ### ResearchStudyCandidateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The research study candidate associated with the research study candidate status period. This field is a relationship field. - **Relationship Name**: ResearchStudyCandidate - **Relationship Type**: Master-detail - **Refers To**: ResearchStudyCandidate (the master object) ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the candidate. - **Possible values**: - Dropped - Eligible - Enrolled - Evaluation Completed - Evaluation In Progress - In Consideration - Ineligible - New - Pre-screening - Randomized - Rejected - Screening ### StatusReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the candidate was assigned the status. ## 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. [ResearchStdyCndtStatusPrdChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. # ResearchStdyRandomization Represents the randomization algorithm configuration defined for a research study. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AlgorithmFlowDefinition - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The flow definition that contains the block generation algorithm. ### AlgorithmType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the algorithm type of the research study randomization. - **Possible values**: - Block - Custom ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the research study randomization. ### DoesAsgnCandidatesToGroups - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the randomization procedure should create a Research Study Comparison Group Candidate record for candidates for the matching group. - **Default value**: false ### DoesGenerateBlockOnDemand - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the algorithm can generate new blocks during randomization (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MaximumBlockSizeMultiplier - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum multiplier that's applied to decide the size of a block type research study randomization. ### MinimumBlockSizeMultiplier - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum multiplier that's applied to decide the size of a block type research study randomization. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the research study randomization. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RandomizationLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the randomization level of the research study randomization. - **Possible values**: - Central - Noncentral ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The research study associated with the research study randomization. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Refers To**: ResearchStudy ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the research study randomization. - **Possible values**: - Active - Draft - Inactive ## 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. [ResearchStdyRandomizationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStdyRandomizationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStdyRandomizationShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStdySearchableField Represents a common dataset that includes multiple fields and values from multiple objects and serves as the basis for searches related to research studies. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentEnrolleCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The current enrollment count of the research study. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the research study. ### DoesAcceptHealthyCandidates - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the research study accepts healthy candidates (true) or not (false). - **Default value**: false ### EligibleGender - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The eligible gender for the research study. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the research study. ### Focus - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The focus of the research study. ### Intent - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The intent of the research study. ### Keywords - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The keywords that are used to search for the research study. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MaximumEligibleAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum eligible age for the research study. ### MinimumEligibleAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum eligible age for the research study. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the research study searchable field. ### OmniProcess - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the Omni Process associated with the research study. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Phase - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The phase of the research study. ### PrimaryConditionArea - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The focus area of the research study. ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study associated with the research study searchable field. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Refers To**: ResearchStudy ### ResearchStudyNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier number of the research study. ### ResearchStudyType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of research study. ### SiteCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of sites where the research study is conducted. ### Sponsor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sponsor of the research study. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the research study. ### Status - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the research study. ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The summary of the research study. ### TargetEnrolleeCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum enrollment count of the research study. ### Title - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The title of the research study. ## 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. [ResearchStdySearchableFieldChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ResearchStdySearchableFieldFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStdySearchableFieldHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStdySearchableFieldShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStudy The ResearchStudy FHIR resource maps to the ResearchStudy objects in Salesforce. ## FHIR V4.0 - Clinical Data Model Mapping Here’s how the fields defined by FHIR for [researchStudy](https://build.fhir.org/researchstudy.html) map to the fields in Salesforce. Table 1. researchStudy - Salesforce | Research​Study ​Resource | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | url | Research​Study​.Uniform​Resource​Identifier | URL | 0.1 | N/A | | identifier | Research​Study​.Identifier | Object | 0.M | The identifier information for a research study is represented as Identifier records that reference the ResearchStudy record using their Identifier​.Parent​RecordId field. | | name | Research​Study​.Name | Text | 1.1 | While FHIR defines researchStudy​.name as a zero-to-one resource, the Salesforce implementation of ResearchStudy​.Name is one-to-one. | | title | Research​Study​.Title | Long Text Area | 0.1 | While FHIR defines researchStudy.type as a text, the Salesforce implementation of ResearchStudy​.Title is a long text area. | | date | Research​Study​.Source​System​Modified | Date/Time | 1.1 | N/A | | status | Research​Study​.Publication​Status | Picklist | 1.1 | N/A | | primary​Purpose​Type | Research​Study​​.Intent​Type | Picklist | 0.1 | N/A | | phase | Research​Study​.Phase | Picklist | 0.1 | N/A | | study​Design | Care​Program​Detail​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | 1.M | While FHIR defines researchStudy​.studyDesign as a zero-to-many resource, the Salesforce implementation of CareProgram​Detail.Detail​Record is one-to-many. | | focus | Care​Program​​Detail​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | 1.M | While FHIR defines researchStudy​.focus as a zero-to-many resource, the Salesforce implementation of CareProgramDetail.Detail​Record is one-to-many. | | condition | Care​Program​​Detail​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | 1.M | While FHIR defines researchStudy​.condition as a zero-to-many resource, the Salesforce implementation of CareProgramDetail.Detail​Record is one-to-many. | | keyword | Care​Program​​Detail​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | 1.M | While FHIR defines researchStudy​.keyword as a zero-to-many resource, the Salesforce implementation of CareProgramDetail.Detail​Record is one-to-many. | | region | Care​Program​​Detail​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | | While FHIR defines researchStudy​.region as a zero-to-many resource, the Salesforce implementation of CareProgramDetail.Detail​Record is one-to-many. | | description​.Summary | Research​Study​.Summary | Long Text Area | 0.1 | N/A | | description | Research​Study​.Description | Long Text Area | 0.1 | N/A | | period | Research​Study​.Start​Date | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of researchStudy​.period​Date​Time. | | period | Research​Study​.End​​Date | Date​/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​Period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of researchStudy​.period​Date​Time. | | site | Care​Program​Site.​Health​Care​Facility | Lookup: HealthCareFacility | 0.M | N/A | | classifier | Care​Program​Site​.Detail​Record | Lookup: CodeSet, CodeSetBundle, OmniProcess, CarePlanTemplate | 1.M | While FHIR defines researchStudy​.classifier as a zero-to-many resource, the Salesforce implementation of CareProgramSite.DetailRecord is one-to-many. | | associated​Party.name | Care​Program​Team​​Member.​Member | Polymorphic Lookup | 0.1 | While FHIR defines researchStudy.associatedParty.name as a text, the Salesforce implementation of CareProgramTeamMember.Member is a polymorphic lookup. | | associated​Party.role | Care​Program​Team​Member​Role​​Period​.Role | DynamicEnum | 1.1 | N/A | | associated​Party.period | CareProgram​Team​Member​Role​​Period​.Effective​Start​Date | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​associatedParty.period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of researchStudy​.period​Date​Time. | | associated​Party.period | Care​Program​Team​Member​Role​​Period​.Effective​​End​Date | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​associatedParty.period is flattened into a set of start date and end date fields. The start date field is also used as the equivalent of researchStudy​.period​Date​Time. | | associated​Party.classifier | Care​Program​Team​​Member​.Category | Multi-Select | 0.M | While FHIR defines researchStudy.associatedParty.name as a CodeSetBundle, the Salesforce implementation of CareProgramTeamMember.Category is Multi-Select. | | progress​Status​.state | Care​Program​Status​Period​.Status | DynamicEnum | 1.M | While FHIR defines researchStudy​.state as a zero-to-many resource, the Salesforce implementation of CareProgramDetail.Detail​Record is one-to-many. | | progress​Status​.actual | Care​Program​Status​​Period​.Are​Dates​Tentative | Boolean | 0.1 | N/A | | progress​Status​.period | Care​Program​Status​Period​.Effective​Start​Date​Time | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​progressStatus.period is flattened into effective start date time field. | | progress​Status​.period | Care​Program​Status​Period​.Effective​End​Date​Time | Date/Time | 0.1 | Since Salesforce doesn’t natively support the period data type, researchStudy​.​progressStatus.period is flattened into an effective end date time field. | | why​Stopped | Research​Study​.Discontinuation​Reason | Picklist | 0.1 | While FHIR defines researchStudy.whyStopped as a code set bundle, the Salesforce implementation of ResearchStudy​.DiscontinuationReason is a picklist. | | recruitment​.target​​number | Care​Program.​Target​​Enrollee​Count | Number | 0.1 | N/A | | recruitment​.actual​​number | Care​​Program​.Current​​Enrollee​​Count | Number | 0.1 | N/A | | recruitment​.eligibility | Research​Study​.Inclusion​Exclusion​Criteria | Rich Text Area | 0.1 | N/A | | comparison​Group​.name | Research​Study​Comparison​Group​.Name | Text | 1.1 | N/A | | comparison​Group​.type | Research​Study​Comparison​Group​.Type​Code | Lookup: CodeSet | 1.1 | While FHIR defines researchStudy​.comparisonGroup.type as a zero-to-one resource, the Salesforce implementation of CareProgramDetail.TypeCode is one-to-one. | | comparison​Group​.description | Research​Study​Comparison​Group​.Description | Text | 0.1 | N/A | | objective​.name | Care​Program​Goal​.Name | Long Text Area | 1.1 | While FHIR defines researchStudy​.objective.name as a zero-to-one resource, the Salesforce implementation of CareProgramGoal.Name is one-to-one. | | objective​.type | Care​Program​Goal​.Type | Picklist | 0.1 | N/A | | objective​.description | Care​Program​Goal​.Description | Long Text Area | 0.1 | N/A | | result | Diagnostic​​Summary​.Based​On | Lookup: Medication Statement, Clinical Service Request | 0.1 | N/A | # ResearchStudy Represents the details of a research study that include its design, execution, and oversight. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActlFirstPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first participant was enrolled in the study at a participating clinical trial site. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlFstPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first enrolled participant across all sites had their initial study visit, as specified in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlFstPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the first enrolled participant across all sites completed their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the final participant was enrolled in the study across all participating clinical trial sites. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the last enrolled participant across all sites had their initial study visit, as defined by the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActlLastPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the last enrolled participant across all sites completed their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ActualFinalDbLockDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The actual date when the final database lock is implemented across the clinical trial sites. This field is available in API version 64.0 and later when Site Management is enabled. ### BiospecRetention - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the retention of the collected participant samples in a biorepository. This field is available in API version 62.0 and later. - **Possible values**: - None Retained - Samples With DNA - Samples Without DNA ### BlindingTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Blinding Type of the Care Program. This field is a polymorphic relationship field. - **Relationship Name**: BlindingTypeCode - **Refers To**: CodeSet, CodeSetBundle ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program associated with the research study. This field is a relationship field. - **Relationship Name**: CareProgram - **Refers To**: CareProgram ### CareSpecialtyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care specialty associated with the research study. This field is available in API version 62.0 and later. This field is a relationship field. ### Description - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A detailed description of the research. ### DiscontinuationReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The reason why the research was discontinued. - **Possible values**: - Accrual Goal Met - Lack of Progress - Temporarily Closed as per Study Design - Toxicity ### EligibleGender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the gender that's eligible for the research study. - **Possible values**: - Any - Female - Male - Transgender ### EligibleMaximumAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum eligibility age of a candidate for the research study. ### EligibleMinimumAge - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The minimum eligibility age of a candidate for the research study. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the research ends. ### ForcstFirstPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the first participant enrolls in the study at a participating clinical trial site. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstFstPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The initially projected date when the first enrolled participant across all sites completes their final scheduled study visit, as defined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstFstPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the first enrolled participant across all sites has their initial study visit, such as a screening or baseline visit. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpEnrlDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the final participant enrolls in the study across all participating clinical trial sites. This forecast is based on the planned sample size and recruitment rate. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpFstVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The projected date when the last enrolled participant across all sites has their initial study visit, as defined by the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### ForcstLastPtcpLastVstDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The initially projected date when the last enrolled participant across all sites completes their final scheduled study visit, as outlined in the study protocol. This field is available in API version 64.0 and later when Site Management is enabled. ### InclusionExclusionCriteria - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The inclusion criteria and exclusion criteria of the research study. ### IntentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the research, based on the intent of its activities. - **Possible values**: - Basic Science - Device Feasibility - Diagnostic Study - Health Services Research - Prevention - Screening - Supportive Care - Treatment ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the research study. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### Phase - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The current phase of the research. - **Possible values**: - Early Phase 1 - Not Applicable - Phase 1 - Phase 1/Phase 2 - Phase 2 - Phase 2/Phase 3 - Phase 3 - Phase 4 ### PlannedFinalDbLockDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The planned date when the final database lock is implemented across the clinical trial sites. This field is available in API version 64.0 and later when Site Management is enabled. ### PrimaryContactInformationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary phone number of the candidate. This field is a relationship field. - **Relationship Name**: PrimaryContactInformation - **Refers To**: ContactPointPhone ### ProtocolDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The protocol content document associated with the research study. This field is a relationship field. - **Relationship Name**: ProtocolDocument - **Refers To**: ContentDocument ### PublicationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The publication status of the research study's record. - **Possible values**: - Active - Draft - Retired - Unknown ### ResearchStudyNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the research study. ### ShouldAcptHealthyCandidates - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the research study should accept healthy candidates (true) or not (false). - **Default value**: false ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the research starts. ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A brief summary of the research. ### Title - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The human-readable name of the research study. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of research study. - **Possible values**: - Interventional - Observational ### UniformResourceIdentifier - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The canonical identifier of the research study. ## 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. [ResearchStudyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ResearchStudyFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStudyHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStudyShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStudyCandidate Represents the details of the research participant which includes the associated account and the status of the subject. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CandidateId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The candidate of the research study. This field is a polymorphic relationship field. - **Relationship Name**: Candidate - **Refers To**: Account ### CareProgramSiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the study happens. This field is a relationship field. - **Relationship Name**: CareProgramSite - **Refers To**: CareProgramSite ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### MatchedExclusionCritCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of exclusion criteria fulfilled by the candidate during automatic evaluation. This field is available in API version 62.0 and later. ### MatchedInclusionCritCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of inclusion criteria fulfilled by the candidate during automatic evaluation. This field is available in API version 62.0 and later. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study candidate. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study that the Candidate is a part of. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Refers To**: ResearchStudy ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed in the source system. ### SourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of source from where the information about the candidate is obtained. - **Possible values**: - Others - Participant Registry - Referrals - Site Patient Pool ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the research study candidate. - **Possible values**: - Consent - Enrolled - New - Randomization - Referral Accepted - Rejected - Screening ## 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. [researchstudycandidateChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [researchstudycandidateFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [researchstudycandidateHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [researchstudycandidateShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStudyCmprGroup Represents the details of a research study comparison group. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AllocationRatioValue - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comparison group's allocation ratio in the research study randomization. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the research study comparison group. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the research study randomization comparison group. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The research study associated with the research study comparison group. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Refers To**: ResearchStudy ### TypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code set associated with the research study comparison group. This field is a relationship field. - **Relationship Name**: TypeCode - **Refers To**: CodeSet ## 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. [ResearchStudyCmprGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStudyCmprGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStudyCmprGroupShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # ResearchStudyProtocolInfo Represents details of the research study protocol document. This object is available in API version 62.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Content - **Type**: textarea - **Properties**: Create, Update - **Description**: The content text for the research study protocol. ### ContentType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the content stored. - **Possible values**: - Abbreviations - Adverse Events Classification - Adverse Events Definition - Adverse Events Participant Reporting - Adverse Events Reporting - Analysis Dataset Criteria - Analysis Population Criteria - Background - Biospecimen Sample Retention - Clinical Masking Description - Clinical Monitoring - Confidentiality and Privacy - Conflict of Interest Policy - Data Handling and Record Keeping - Dosage Justification - End of Study Procedure - Event Assessment Frequency and Time Period - Gender Eligibility Description - Informed Consent Process - Intervention Benefits - Intervention Compliance - Intervention Discontinuation - Intervention Dosing and Administration - Intervention Preparation - Intervention Risks - Intervention Risks and Benefits Assessments - Intervention Storage and Stability - Lost to Follow-up - Pregnancy Reporting - Primary Endpoint Analysis - Protocol Deviations - Publication and Data Sharing Policy - Quality Assurance and Control - Safety Analysis - Safety Oversight - Sample Size Determination - Secondary Endpoint Analysis - Serious Adverse Events Definition - Serious Adverse Events Reporting - Special Interest Reporting - Statistical Analysis Summary - Study Design - Study Discontinuation and Closure - Study Population - Study Population Description - Study Record Retention Period - Study Scientific Rationale - Subgroup Analysis - Summary ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study protocol information. ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The research study associated with the content. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Relationship Type**: Master-detail - **Refers To**: ResearchStudy (the master object) # ResearchStudyRelation Represents different related research studies. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study relation. ### RelatedResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The smaller research study that's a part of the larger study. This field is a relationship field. - **Relationship Name**: RelatedResearchStudy - **Refers To**: ResearchStudy ### ResearchStudyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The larger research study that the smaller study is a part of. This field is a relationship field. - **Relationship Name**: ResearchStudy - **Relationship Type**: Master-detail - **Refers To**: ResearchStudy (the master object) ## 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. [ResearchStudyRelationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ResearchStudyRelationFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStudyRelationHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. # ResearchStudyRndmBlockSlot Represents the individual randomization block items corresponding to a Research Study Randomization Block This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ItemAssignmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the research study randomization block item. - **Possible values**: - Abandoned - Assigned - Available ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study randomization block slot. ### ResearchStudyCmprGroupId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study comparison group associated with the research study randomization block item. This field is a relationship field. - **Relationship Name**: ResearchStudyCmprGroup - **Refers To**: ResearchStudyCmprGroup ### RsrchStdyRandomizationBlkId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The research study randomization block associated with the research study randomization block item. This field is a relationship field. - **Relationship Name**: RsrchStdyRandomizationBlk - **Relationship Type**: Master-detail - **Refers To**: RsrchStdyRandomizationBlock (the master object) ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The sequence number of the research study randomization block item. ## 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. [ResearchStudyRndmBlockSlotChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ResearchStudyRndmBlockSlotFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ResearchStudyRndmBlockSlotHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ResearchStudyRndmBlockSlotOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ResearchStudyRndmBlockSlotShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Resources Use these resources of Life Sciences Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications. - **[Account Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_management_intro.htm)** Use these resources to manage customer accounts. - **[Account Manual Alignment](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_customer_manual_alignment.htm)** Manually align an account to a territory in the Life Sciences package to create a Provider Account Territory Info record. - **[Account User Territory Information (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_account_user_territory_information.htm)** Get user details, including territories and additional user information. - **[Advanced Provider Search](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_advanced_provider_search.htm)** Facilitate three distinct types of account searches: Healthcare Provider (HCP), Healthcare Organization (HCO), and license-based searches. For HCP and HCO searches, the API processes fields from the account, healthcare provider, and contact point address entities.The license-based searches use fields from the business license entity. - **[Book Slot Chain (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_book_slot_chain.htm)** Create service appointments for a care program enrollee in advanced therapy management based on the provided appointment slots. - **[Contact Encounter (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_erm_resource_contact_encounter_business_api.htm)** Load details of contact encounters into the system. - **[Content Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_content_management_intro.htm)** Use these resources to manage customer content. - **[Care Program Enrollments (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_careprogram_enrollment_intro.htm)** Use this API to enroll multiple patients in a care program. - **[Digital Verification (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_digital_verification.htm)** Perform verification for the digital verification records within advanced therapy management. - **[Download Provider (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_download_provider.htm)** Download Health Care provider data from an external system to a Salesforce org after a search is performed. - **[Benefit Verification](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/benefit_verification_api_intro.htm)** Use these resources to verify the health benefits covered by the patient's insurer. The call center agent can view the coverages in the patient's record page. - **[Intelligent Document Management](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/intelligent_doc_management_apis.htm)** Use the Intelligent Document Management resources to create or update records in Salesforce objects based on the content document records or received document records. - **[Patients (GET, POST, PUT)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_create_get_update_patients.htm)** Retrieve the FHIR patient resource record details. Create or update a patient record rather than making multiple separate calls to the objects in Salesforce. - **[Provider Engagement Action Plan Status](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resource_update_pec_action_plan_status.htm)** Updates the status of a Provider Engagement Compliance action plan. - **[Provider Search](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_ls_provider_search.htm)** Search for Healthcare providers and accounts based on a free-text input, either from internal Salesforce data or an external system. This API returns account information, including healthcare providers and matching contact point addresses. - **[Providers](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_providers_api_intro.htm)** Use these resources to create practitioner or facility records, or update existing fields in provider records and insert new fields. - **[Sample Limits Validation (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_sample_limits_validation.htm)** Validate the samples requested during a visit against the sample limits for that account, product, and sample limit template. - **[Visits (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_create_visit.htm)** Create visits for sales representatives. For example, for a medical device visit, a sales representative visits the surgeon or a hospital location. - **[Waterfall Download (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_waterfall_download.htm)** Retrieves pricing waterfall data for multiple line items in a single request. - **[Work Type Lead Time (POST)](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_resources_work_type_lead.htm)** Get a list of work types and their associated lead times that are optimized across regions for a specific advanced therapy. # Response Bodies A resource can return a response body in either JSON or XML format. Refer to [HTTP response code](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_error_responses.htm "HTML (New Window)") to find out whether the request was successful or not, as well as the error messages for the failed requests. This guide documents response bodies unique to Life Sciences Cloud. Life Sciences Cloud includes features that are also availble in other Industries products. We document these shared features in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm "HTML (New Window)"). You can find response body reference for these features in that guide. ## Intelligent Form Reader These response bodies are documented in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm "HTML (New Window)"). - [Document Conflict Field](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_document_conflict_field.htm "HTML (New Window)") - [Document Conflict Field List](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_document_conflict_field_list.htm "HTML (New Window)") - [Document Process Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_document_process_output.htm "HTML (New Window)") - [Object Field](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_object_field.htm "HTML (New Window)") - [Object Field List](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_object_field_list.htm "HTML (New Window)") - [OCR Document Scan Result](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_ocr_document_scan_result_id.htm "HTML (New Window)") - [OCR Document Scan Result List](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_ocr_document_scan_result_id_list.htm "HTML (New Window)") # RestrictedParty Represents a party such as a participant, a speaker, or a vendor that's restricted from taking part in a managed event. This object is available in API version 67.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the account who is restricted from performing a specific role at managed events. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### ContactId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the contact who is restricted from performing a specific role at managed events. This field is a relationship field. - **Relationship Name**: Contact - **Refers To**: Contact ### CountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the country in which the party is restricted. This field is a relationship field. - **Relationship Name**: Country - **Refers To**: GeoCountry ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time until when the restriction is effective for the party. ### ExpertId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The expert who is restricted from performing a specific role at managed events. This field is a relationship field. - **Relationship Name**: Expert - **Refers To**: Expert ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastVerificationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last date and time when the party's restricion status was verified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record. ### LeadId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the lead who is restricted from performing a specific role at managed events. This field is a relationship field. - **Relationship Name**: Lead - **Refers To**: Lead ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the restricted party ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ParticipantRoleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The participant role that the party is restricted from performing at managed events This field is a relationship field. - **Relationship Name**: ParticipantRole - **Refers To**: ParticipantRole ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the party who is restricted from performing a specific role at managed events. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Refers To**: Account, Contact, Expert, Lead, User ### PartyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of party that's restricted from taking part in managed events. ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason due to which the party is restricted. ### ReasonCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of restriction placed on the participant. ### RestrictionResolutionReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason due to which the party has been removed from restriction. ### RestrictionResolutionStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the process that checks whether the party can be moved from restriction ### RoleId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role that the party is restricted from performing at managed events. If a value isn't specified, it indicates that all roles are restircted. This field is a relationship field. - **Relationship Name**: Role - **Refers To**: ParticipantRole ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the external system that generated the record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of the record in the external system. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the date and time from when the restriction is effective for the participant. ### StateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the State in which the party is restricted. This field is a relationship field. - **Relationship Name**: State - **Refers To**: GeoState ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of application that the record is for. - **Possible values**: - ManagedEvent— ### UserId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the user who is restricted from performing a specific role at managed events. This field is a relationship field. - **Relationship Name**: User - **Refers To**: User ### VerificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of verification that's performed to determine whether the party must remain in restriction. ## 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. RestrictedPartyFeed Feed tracking is available for the object. RestrictedPartyHistory History is available for tracked fields of the object. RestrictedPartyShare Sharing is available for the object. # RsrchStdyRandomizationBlock Represents the details of a block that’s generated through the parameters specified in the research study randomization. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CurrentBlockItemSeqNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The sequence number of the item in the research study randomization block. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study randomization block. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResearchStdyRandomizationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study randomization associated with the research study randomization block. This field is a relationship field. - **Relationship Name**: ResearchStdyRandomization - **Refers To**: ResearchStdyRandomization ### RsrchStdyRndmCriteriaSrcId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Research study criteria source associated with the research study randomization block. This field is a polymorphic relationship field. - **Relationship Name**: RsrchStdyRndmCriteriaSrc - **Refers To**: CareProgramSite, RsrchStdyRandomizationCrit, devopsimpkg11\_\_CardFrameworkConfiguration\_\_c, devopsimpkg11\_\_DRBatchQueue\_\_c, devopsimpkg11\_\_DRBulkData\_\_c, devopsimpkg11\_\_DREncryption\_\_c, devopsimpkg11\_\_DRWorker\_\_c, devopsimpkg11\_\_Interface\_DRGeneric\_\_c, devopsimpkg11\_\_TestResult\_\_c, devopsimpkg11\_\_TriggerSetup\_\_c, devopsimpkg11\_\_UISettings\_\_c, devopsimpkg11\_\_VlocityDataPack\_\_c, devopsimpkg11\_\_VlocityDocuSignTemplate\_\_c, devopsimpkg11\_\_VlocityErrorLogEntry\_\_c, devopsimpkg11\_\_VlocityScheduledJob\_\_c, devopsimpkg11\_\_VlocityTrackingEntry\_\_c ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the research study randomization block. - **Possible values**: - AllocationComplete—Allocation Complete - Available - InProgress—In Progress ## 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. [RsrchStdyRandomizationBlockChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [RsrchStdyRandomizationBlockFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [RsrchStdyRandomizationBlockHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [RsrchStdyRandomizationBlockShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # RsrchStdyRandomizationCrit Represents the criteria definition for grouping the candidates participating in the research study. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareProgramSiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program site associated with the research study randomization criteria. This field is a relationship field. - **Relationship Name**: CareProgramSite - **Refers To**: CareProgramSite ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the research study randomization criteria. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the object assigned to the territory. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResearchStdyRandomizationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The research study randomization associated with the research study randomization criteria. This field is a relationship field. - **Relationship Name**: ResearchStdyRandomization - **Refers To**: ResearchStdyRandomization ## 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. [RsrchStdyRandomizationCritChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [RsrchStdyRandomizationCritFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [RsrchStdyRandomizationCritHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [RsrchStdyRandomizationCritShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # RXA - Pharmacy Administration Segment The Pharmacy Administration Segment (RXA) HL7 segment maps primarily to the PatientImmunization and Medication objects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for RXA map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below.
Table 1. RXA - Salesforce
RXA Salesforce Field Type Notes
RXA.3 - Date/Time Start of Administration Patient​Immunization​.Vaccination​Date DateTime N/A
RXA.5 - Administered Code
  • ​​Patient​Immunization​.Vaccine​CodeId
  • ​​​Medication​​.​Medication​CodeId
 Lookup: CodeSetBundle N/A
RXA.6 - Administered Amount ​​​Patient​Immunization​.​Dose Double N/A
RXA.7 - Administered Unit Patient​Immunization​.​Dose​UnitId Lookup:UnitOfMeasure N/A
RXA.8 - Administered Dosage Form ​​​Medication​​.​Medication​FormId Lookup: CodeSetBundle N/A
RXA.10 - Administering Provider ​​​Care​Performer Object The performer information for an immunization is represented as ​Care​Performer records that reference the Patient​Immunization record using their ​Care​Performer​.Parent​RecordId field​.
RXA.11 - Administered-at Location ​​​Patient​Immunization​.FacilityId Lookup: Healthcare Facility N/A
RXA.15 - Substance Lot Number ​​​Patient​Immunization​.Lot​Number String N/A
RXA.16 - Substance Expiration Date ​​​Patient​Immunization​.Expiration​Date DateTime N/A
RXA.17 - Substance Manufacturer Name
  • ​​Patient​Immunization​.Manufacturer
  • ​​​Medication​​.​ManufacturerId
  • String
  • Lookup: Account
 N/A
RXA.18 - Substance Refusal Reason ​​Patient​Immunization​.Status​Reason​​CodeId
  • Lookup: CodeSetBundle
 N/A
RXA.20 - Completion Status ​​Patient​Immunization​.Status Picklist N/A
# RXC - Pharmacy Component Order Segment The Pharmacy Component Order Segment (RXC) HL7 segment maps to the Medication and MedicationRequestobjects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for RXC map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below.
Table 1. RXC - Salesforce
RXC Salesforce Field Type Notes
RXC.2 - Component Code
  • Medication​.Medication​CodeId
  • MedicationRequest​.Medication​CodeId
 Lookup: CodeSetBundle N/A
# RXE - Pharmacy Encoded Order Segment The Pharmacy Encoded Order Segment (RXE) HL7 segment maps primarily to the Medication object in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for RXE map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below. Table 1. RXE - Salesforce | RXE | Salesforce Field | Type | Notes | | --- | --- | --- | --- | | RXE.2 - Give Code | Medication​.Medication​CodeId | Lookup: CodeSetBundle | N/A | | RXE.2 - Give Dosage Form | Medication​.Medication​FormId | Lookup: CodeSetBundle | N/A | # RXR - Pharmacy Route Segment The Pharmacy Route Segment (RXR) HL7 segment maps primarily to the PatientImmunization and PatientMedicationDosage objects in Salesforce. ## HL7 V2.3 - Clinical Data Model Mapping Here’s how the segments defined by HL7 V2.3 for RXR map to fields in Salesforce standard objects. ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Only the segments supported by Salesforce are mentioned below.
Table 1. RXR - Salesforce
RXR Salesforce Field Type Notes
RXR.1 - Route
  • ​​Patient​Immunization​.RouteId
  • Patient​​​Medication​Dosage​​.​RouteId
 Lookup: CodeSetBundle N/A
RXR.2 - Site
  • ​​Patient​Immunization​.SiteId
  • Patient​​​Medication​Dosage​​.​SiteId
 Lookup: CodeSetBundle N/A
RXR.4 - Administration Method Patient​​​Medication​Dosage​​.​MethodId Lookup: CodeSetBundle N/A
# Sample Limits Request Data Input Input representation for the sample limits data to validate. ## Properties
Name Type Description Required or Optional Available Version
action String The action to perform. Supported values are:
  • validate
 Required 65.0
data Object The records to validate. Required 65.0
# Sample Limits Validation (POST) Validate the samples requested during a visit against the sample limits for that account, product, and sample limit template. ## Resource /connect/life-sciences/commercial/sample-limits-validation ## Available Version 65.0 ## HTTP Methods POST ## JSON example { "sampleLimitsValidationRequest": { "data": { "providerVisitsData": { "providerVisitData": { "territory": "", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "productDisbursements": \[ { "productId": "2\_childProduct1", "productBatchItemId": "", "accountId": "001XXXXXXXXXXXXAAG", "quantity": 1 }, { "productBatchItemId": "", "productId": "2\_childProduct2", "quantity": 6, "accountId": "001XXXXXXXXXXXXAAG" } \], "providerVisitSampleLimitTransactions": { "001XXXXXXXXXXXXAAG": \[ { "providerVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_childProduct1", "productId": "2\_childProduct1", "providerSampleLimitTemplateName": "PerYearTemplate", "providerVisitRequestedSampleId": "callSample1", "ProviderSampleLimitId": "sampleLimit1", "quantity": "1", "account": "001XXXXXXXXXXXXAAG", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000" }, { "limitProductId": "2\_parentProduct1", "quantity": "6", "productId": "2\_childProduct2", "ProductDisbursementId": "callSample2", "ProviderVisitId": "a2TXXXXXXXXXXXXEAI", "providerSampleLimitTemplateName": "parent\_template1", "ProviderSampleLimitId": "defaultSampleLimit1", "account": "001XXXXXXXXXXXXAAG", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000" } \] } }, "childProviderVisitsData": { "productDisbursements": \[ { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct1", "productBatchItemId": "", "quantity": 1 }, { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct1", "productBatchItemId": "", "quantity": 1 }, { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct2", "productBatchItemId": "", "quantity": 1 } \], "providerVisitSampleLimitTransactions": { "0010p000013CLb1AAG": \[ { "providerVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_childProduct1", "productId": "2\_childProduct1", "ProductDisbursementId": "", "providerVisitRequestedSampleId": "callSample3", "providerSampleLimitTemplateName": "PerYearTemplate", "ProviderSampleLimitId": "sampleLimit1", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "account": "001XXXXXXXXXXXXAAG", "quantity": "1" }, { "ProviderVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_parentProduct1", "productId": "2\_childProduct2", "ProductDisbursementId": "callSample4", "providerVisitRequestedSampleId": "", "providerSampleLimitTemplateName": "parent\_template1", "ProviderSampleLimitId": "defaultSampleLimit1", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "account": "001XXXXXXXXXXXXAAG", "quantity": "6" } \] } } }, "pendingSyncData": { "providerVisitSampleLimitTransactions": { "001XXXXXXXXXXXXAAG": \[ { "providerVisitId": "lscpr1\_\_call\_\_c-639XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXAEB", "providerVisitRequestedSampleId": "lscpr1\_\_callsampleorder\_\_c-988XXXXX-XXXX-XXXX-XXXX-XXXXXXXXX1BF", "ProductDisbursementId": "", "limitProductId": "a5AXXXXXXXXXXXXEAU", "productId": "a5AXXXXXXXXXXXXEAU", "quantity": "1", "visitPlannedStartTime": "2024-12-11T18:28:31.404+0000", "ProviderSampleLimitId": "a5cXXXXXXXXXXXXAAE", "account": "001XXXXXXXXXXXXAAG", "providerSampleLimitTemplateName": "PerYearTemplate" } \] }, "productDisbursements": \[ {} \] } }, "action": "validate" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sampleLimitsValidationRequest | [SampleLimitsRequestDataInput](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_sample_limits_request_data_input.htm "Input representation for the sample limits data to validate.") | The payload that contains the sample limit validations to perform in JSON format. | Required | 65.0 | ## Response Body for POST [Sample Limits Validation Response Output](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_sample_limits_validation_response_output.htm "Output representation for a sample limits validation request.") # Sample Limits Validation Input Input representation for sample limits validation. ## JSON example { "sampleLimitsValidationRequest": { "data": { "providerVisitsData": { "providerVisitData": { "territory": "", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "productDisbursements": \[ { "productId": "2\_childProduct1", "productBatchItemId": "", "accountId": "001XXXXXXXXXXXXAAG", "quantity": 1 }, { "productBatchItemId": "", "productId": "2\_childProduct2", "quantity": 6, "accountId": "001XXXXXXXXXXXXAAG" } \], "providerVisitSampleLimitTransactions": { "001XXXXXXXXXXXXAAG": \[ { "providerVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_childProduct1", "productId": "2\_childProduct1", "providerSampleLimitTemplateName": "PerYearTemplate", "providerVisitRequestedSampleId": "callSample1", "ProviderSampleLimitId": "sampleLimit1", "quantity": "1", "account": "001XXXXXXXXXXXXAAG", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000" }, { "limitProductId": "2\_parentProduct1", "quantity": "6", "productId": "2\_childProduct2", "ProductDisbursementId": "callSample2", "ProviderVisitId": "a2TXXXXXXXXXXXXEAI", "providerSampleLimitTemplateName": "parent\_template1", "ProviderSampleLimitId": "defaultSampleLimit1", "account": "001XXXXXXXXXXXXAAG", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000" } \] } }, "childProviderVisitsData": { "productDisbursements": \[ { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct1", "productBatchItemId": "", "quantity": 1 }, { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct1", "productBatchItemId": "", "quantity": 1 }, { "accountId": "001XXXXXXXXXXXXAAG", "productId": "2\_childProduct2", "productBatchItemId": "", "quantity": 1 } \], "providerVisitSampleLimitTransactions": { "0010p000013CLb1AAG": \[ { "providerVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_childProduct1", "productId": "2\_childProduct1", "ProductDisbursementId": "", "providerVisitRequestedSampleId": "callSample3", "providerSampleLimitTemplateName": "PerYearTemplate", "ProviderSampleLimitId": "sampleLimit1", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "account": "001XXXXXXXXXXXXAAG", "quantity": "1" }, { "ProviderVisitId": "a2TXXXXXXXXXXXXEAI", "limitProductId": "2\_parentProduct1", "productId": "2\_childProduct2", "ProductDisbursementId": "callSample4", "providerVisitRequestedSampleId": "", "providerSampleLimitTemplateName": "parent\_template1", "ProviderSampleLimitId": "defaultSampleLimit1", "visitPlannedStartTime": "2025-01-01T15:45:00.000+0000", "account": "001XXXXXXXXXXXXAAG", "quantity": "6" } \] } } }, "pendingSyncData": { "providerVisitSampleLimitTransactions": { "001XXXXXXXXXXXXAAG": \[ { "providerVisitId": "lscpr1\_\_call\_\_c-639XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXAEB", "providerVisitRequestedSampleId": "lscpr1\_\_callsampleorder\_\_c-988XXXXX-XXXX-XXXX-XXXX-XXXXXXXXX1BF", "ProductDisbursementId": "", "limitProductId": "a5AXXXXXXXXXXXXEAU", "productId": "a5AXXXXXXXXXXXXEAU", "quantity": "1", "visitPlannedStartTime": "2024-12-11T18:28:31.404+0000", "ProviderSampleLimitId": "a5cXXXXXXXXXXXXAAE", "account": "001XXXXXXXXXXXXAAG", "providerSampleLimitTemplateName": "PerYearTemplate" } \] }, "productDisbursements": \[ {} \] } }, "action": "validate" } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | sampleLimitsValidationRequest | [SampleLimitsRequestDataInput](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_requests_sample_limits_request_data_input.htm "Input representation for the sample limits data to validate.") | The payload that contains the sample limit validations to perform in JSON format. | Required | 65.0 | # Sample Limits Validation Response Output Output representation for a sample limits validation request. ## JSON example { "code": null, "message": null, "response": { "result": "Error", "validationResults": \[ { "message": "Quantity exceeds sample limits", "errors": \[ { "type": "sampleLimit", "message": "Quantity exceeds sample limits", "lotAllocationWarningMessage": null, "filters": \[ { "value": "1KeXXXXXXXXXXXX0AM", "field": "sample" } \], "accountId": "001XXXXXXXXXXXXAAG" } \], "errorLevel": "validation", "errorBehaviour": "Error" } \], "errorBehaviour": "Error", "message": "Quantity exceeds sample limits", "errors": \[ { "type": "sampleLimit", "message": "Quantity exceeds sample limits", "lotAllocationWarningMessage": null, "filters": \[ { "value": "1KeXXXXXXXXXXXXz0AM", "field": "sample" } \], "accountId": "001XXXXXXXXXXXX1AAG" } \], "errorLevel": "validation" }, "success": true } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | The API error code, if available. | Small, 65.0 | 65.0 | | message | String | The error or success message, if available. | Small, 65.0 | 65.0 | | response | Map | Data related to the sample limits validation results. | Small, 65.0 | 65.0 | | success | Boolean | Indicates whether the request was successful (true) or not (false). | Small, 65.0 | 65.0 | # Samples Management Enable pharmaceutical companies to efficiently handle and distribute drug samples to healthcare providers. Enhance drug sales and keep healthcare providers informed about the safe and effective use of products, leading to quicker treatments. Track and manage sales representative inventories of samples, ensuring compliance with regulations, and maintaining accurate records of distribution. Effective sample management is crucial for supporting healthcare providers and low-income patients, and ensuring ethical practices and regulatory compliance. ## Sample Inventory Management Sample Inventory Management streamlines tracking and managing sample inventory to ensure compliance with regulations, accurate record keeping, and adherence to organizational policies. It supports inventory counting and enable sales representatives to maintain accurate and up-to-date records. ![Sample Inventory Management entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_life_sciences_samples_invt_mgmt.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/inventory-management.html "HTML (New Window)"). ## Sample Limits Support effective sample management by maintaining control over sample quantities and aligning distribution practices with organizational policies. Set boundaries on how pharmaceutical samples are distributed to ensure compliance with regulatory requirements and optimize resource allocation. By implementing predefined sample limits templates, organizations can enforce limits systematically and consistently across different account segments, streamline administrative tasks, ensure regulatory adherence, and prevent over-distribution. ## Product Territory Allocation Manage the allocation of drug samples to territories and validate against the remaining quantity or maximum disbursement limit to support organizational policies on sample distribution and disbursement. ![Product Territory Allocation entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_sample_limits_prod_terr_allocation_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/sample-limits-and-product-territory-allocation.html "HTML (New Window)"). ## Samples Management Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Address](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_address.htm) - [Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_contact_custom_fields.htm) - [Inventory Count Assessment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventorycountassessment.htm) - [Inventory Count Product Batch Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventorycntprodtbatchitem.htm) - [Inventory Operation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_inventoryoperation.htm) - [Life Science Marketable Product](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifescimarketableproduct.htm) - [Location](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_lsclocation.htm) - [Product Disbursement](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productdisbursement.htm) - [Product Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_productitem.htm) - [Product Item Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_productitemtransaction.htm) - [Product Request](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_productrequest_custom_fields.htm) - [Product Request Line Item](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_productrequestlineitem_fields.htm) - [Product Transfer](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_product_transfer_custom_fields.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Production Batch](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_productionbatch.htm) - [Provider Sample Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimit.htm) - [Provider Sample Limit Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimittemplate.htm) - [Provider Sample Limit Template Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersmpllmttmplassignment.htm) - [Provider Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisit.htm) - [Provider Visit Requested Sample](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providervisitrqstsample.htm) - [Provider Visit Sample Limit Discrepancy](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdvstsmpllmtdiscrepancy.htm) - [Provider Visit Sample Limit Transaction](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_prvdvstsmpllmttransaction.htm) - [Territory Product Quantity Allocation](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_territoryprodtqtyallocation.htm) - [Territory2](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_territory2.htm) - [Time Period](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_timeperiod.htm) - [User](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_user.htm) - [Visit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_visit.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Search Input Input representation for Search API ## Root XML tag ## JSON example { "searchTerm":"Joe Tester", "verificationContext":{ "processDefinition":{ "processDetail":{ "processDetailList":\[ { "verificationProcessFieldList":{ "verificationProcessFields":\[ { "dataSourceType" : "Salesforce", "developerName" : "SampleAccountName", "fieldName" : "Name", "fieldType" : "optionalVerifier", "label" : "Account Name" }, { "dataSourceType" : "Salesforce", "developerName" : "SampleAccountNumber", "fieldName" : "AccountNumber", "fieldType" : "optionalVerifier", "label" : "Account Number" }, { "dataSourceType" : "Salesforce", "developerName" : "SamplePhone", "fieldName" : "Phone", "fieldType" : "optionalVerifier", "label" : "Phone" }, { "dataSourceType" : "Salesforce", "developerName" : "SamplePostalCode", "fieldName" : "BillingPostalCode", "fieldType" : "optionalVerifier", "label" : "Billing Zip/Postal Code" }, { "dataSourceType" : "Salesforce", "developerName" : "SampleAccount", "fieldName" : "Name", "fieldType" : "resultField", "label" : "Account Name" }, { "dataSourceType" : "Salesforce", "developerName" : "AccountNumberSample", "fieldName" : "AccountNumber", "fieldType" : "resultField", "label" : "Account Number" }, { "dataSourceType" : "Salesforce", "developerName" : "SamplePhoneNumber", "fieldName" : "Phone", "fieldType" : "resultField", "label" : "Phone" } \] }, "searchType": "Text-Based", "searchSequenceNo": 1, "searchResultUniqueIdField": "Id", "searchObjectName": "Account", "optionalVerifierCount": 1, "dataSourceType": "Salesforce" } \] } } } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | searchTerm | String | The search term for the account to use when performing a search. | Required | 54.0 | | verificationContext | [Verification Context Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_verification_context_input.htm) | The structure that contains the setup data and context required to perform the search. | Required | 54.0 | # Search Results Output Output representation for provider search request. ## JSON example { "success": true, "message": "", "code": "200", "response": { "simpleSearchFieldSetMembers": { "HCO": {}, "HCP": {} }, "groupAddressMatches": \[\] } } ## Properties | Name | Type | Description | Filter Group and Version | Available version | | --- | --- | --- | --- | --- | | success | Boolean | Indicates whether the API request was successful (true) or not (false.. | Small, 65.0 | 65.0 | | message | String | Message returned in case of an API failure. | Small, 65.0 | 65.0 | | code | String | HTTP response code. | Small, 65.0 | 65.0 | | response | Map | Actual search data, which includes results for simpleSearch​FieldSet​Members and group​Address​Matches. | Small, 65.0 | 65.0 | # SearchableObjDataSyncInfo for Life Sciences Represents information about the data synchronization for a search object, such as frequency of synchronization, status, and the date and time of the last synchronization. See [SearchableObjDataSyncInfo](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/tooling_api_objects_searchableobjdatasyncinfo.htm) in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm). # SearchCriteriaConfiguration for Life Sciences Represents the configuration details of searchable field sets such as the group of fields used as the basis for search, aggregation, sort, and result display. See [SearchCriteriaConfiguration](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/tooling_api_objects_searchcriteriaconfiguration.htm) in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm). # SearchResultActionConfig for Life Sciences Represents a collection of fields to set up the actions that a user can perform on results returned by criteria-based search. See [SearchResultActionConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/meta_searchresultactionconfig.htm) in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm). # SearchResultActionConfig for Life Sciences Represents a collection of fields to set up the actions that a user can perform on results returned by criteria-based search. See [SearchResultActionConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/tooling_api_objects_searchresultactionconfig.htm) in the [Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/salesforce_industries_dev_guide.htm). # Segmentation Group accounts based on specific conditions. Segmentations are reusable across different areas (such as sample limits) to distribute or assign elements to segments of accounts with the same set of criteria. There are two types of segmentations: static and dynamic. Static segmentation maintains the assignment even after the initial assignment. Dynamic segmentation changes based on account status or logic changes. Use Segmentation to assign and restrict of various elements without the need for individual account management. ![Segmentation entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_segmentation_data_model.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/segmentation.html "HTML (New Window)"). ## Segmentation Objects in Life Sciences Customer Engagement - [Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/life_sciences_account_custom_fields.htm) - [Actionable List](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelist.htm) - [Actionable List Definition](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_meta_actionablelistdefinition.htm) - [Actionable List Filter Criteria](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_sforce_api_objects_actionablelistfiltercriteria.htm) - [Actionable List Member](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_objects_actionablelistmember.htm) - [Healthcare Provider](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_healthcareprovider.htm) - [Life Science Account Group Assignment](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_lifesciacctgrpassignment.htm) - [Product2](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_hc_product2.htm) - [Provider Sample Limit](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimit.htm) - [Provider Sample Limit Template](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_objects_providersamplelimittemplate.htm) To learn more about all objects used in Life Sciences, see [Life Sciences Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Serialize Hierarchical Context Data Serializes the hierarchical context data from the Apex embeddedai\_\_RecordApexRepresentation records that are passed as input to a prompt template that generates a summary of the data. This action is available in API version 62.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/serializeHierarchicalContextData Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: GET **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
recordApexRepresentation Apex type Required

A collection of Apex embeddedai__RecordApexRepresentation records that contain the details of the hierarchical data to serialize context data
## Outputs | Output | Type | Description | | --- | --- | --- | | serializedContextData | String | A JSON string of serialized hierarchical context data. | ## Example Sample Request { "inputs": \[ { "recordApexRepresentation": { "relatedRecordData": \[ { "relatedRecordData": \[ { "recordData": \[ { "value": "Percentage", "key": "UnitOfMeasureName" }, { "value": "Symptom Monitoring", "key": "IndicatorDefinitionName" } \], "objectType": "IndicatorAssignment" } \], "recordData": \[ { "value": "Reduced Symptoms", "key": "Name" } \], "objectType": "Outcome" } \], "recordData": \[ { "value": "Drug Use Satisfaction Improvement Program", "key": "Name" } \], "objectType": "CareProgram" } } \] } Sample Response { "serializedContextData": { "CareProgram": { "Name": "Drug Use Satisfaction Improvement Program", "Outcome": \[ { "Name": "Reduced Symptoms", "IndicatorAssignment": \[ { "IndicatorDefinitionName": "Symptom Monitoring", "UnitOfMeasureName": "Percentage" } \] } \] } } } # SerializedProduct Records serial numbers for each individual product in an inventory. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules To use this object, you need the Manage Industries Visit permission and the Industries Visit permission set license. This rule doesn’t apply to using serialized products in Field Service. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to an asset record. ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the product expires. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time this record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time this record was viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the serialized product record. This is auto-generated. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Reference to the owner of the record. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The product that is serialized. ### ProductItemId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the inventory, a product item record, this serialized product belongs to. ### SerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The serial number of the product. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the product. Possible values include: - Available - Consumed - Damaged - Lost - Sent - **Default value**: Available # ServiceAppointmentGroup Stores information about a group of related service appointments. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AppointmentGroupType - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the type of appointment group associated with the service appointment group. - **Possible values**: - Multi-Step - Recurring ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores information about the service appointment group. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the service appointment group. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the record associated with the service appointment group. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: Account, CareProgramEnrollee, Case, Opportunity ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the service appointment group. - **Default value**: None - **Possible values**: - Awaiting Approval - Canceled - None - Scheduled ### StatusCode - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the status code used for scheduling the service appointment group. - **Possible values**: - Canceled - Processed - Proposed ### WorkProcedureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the work procedure associated with the service appointment group. This field is a relationship field. - **Relationship Name**: WorkProcedure - **Relationship Type**: Lookup - **Refers To**: WorkProcedure ## 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. [ServiceAppointmentGroupChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [ServiceAppointmentGroupFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ServiceAppointmentGroupHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ServiceAppointmentGroupOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ServiceAppointmentGroupShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Service​Request The service​Request FH​IR resource maps to the Clinical​Service​Request and Clinical​Service​Request​Detail objects in Salesforce​. ## FH​IR V4​.0 - Clinical​ Data Model Mapping Here’s how the fields defined by FH​IR for [service​Request](https://www.hl7.org/fhir/servicerequest.html) map to the fields in Salesforce​.
Table 1. service​Request - Salesforce
Service ​Request Resource Salesforce Field Type Salesforce Cardinality Notes
identifier ​Identifier Object 0​.M The identifier information for a service request is represented as ​Identifier records that reference the Clinical​Service​Request record using their ​Identifier​.Parent​​Record​Id field​.
instantiates​Canonical​ N/A N/A N/A Not Supported
instantiates​Canonical​ N/A N/A N/A Not Supported
basedOn Clinical​Service​Request​Detail Object 0​.M

The information about the service request or medication request that a service request is based on is represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.

The Salesforce implementation of service​Request​.basedOn doesn’t support references to care plans​.
basedOn Clinical​Service​Request​Detail​.​Detail​Record​Id Polymorphic Lookup: Clinical​Service​Request, Medication​Request 0​.1 For service​Request​.basedOn information, Clinical​Service​Request​Detail​.​Detail​Record​Id must reference a Clinical​Service​Request or Medication​Request record​.
basedOn Clinical​Service​Request​Detail​.​Detail​Type

Picklist

Value: Based On

 0​.1 For service​Request​.basedOn information, Clinical​Service​Request​Detail​.​DetailType must use the value Based On​.
replaces Clinical​Service​Request​.Original​Request​Id Lookup: Clinical​Service​Request 0​.1 While FH​IR defines service​Request​.replaces as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
requisition Clinical​Service​Request​.Service​Request​Group​Identifier​Id Lookup: ​Identifier 0​.1 N/A
status Clinical​Service​Request​.Status Picklist 1​.1 While FH​IR defines service​Request​.status as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Status is picklist​.
intent Clinical​Service​Request​.Type Picklist 1​.1 While FH​IR defines service​Request​.intent as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Type is picklist​.
category Clinical​Service​Request​.Category​Id Lookup: CodeSet​Bundle 0​.1 N/A
priority Clinical​Service​Request​.Priority Picklist 0​.1 While FH​IR defines service​Request​.priority as a code set bundle, the Salesforce implementation of Clinical​Service​Request​.Priority is picklist​.
doNot​Perform Clinical​Service​Request​.​Is​Ignored Boolean 0​.1 N/A
code Clinical​Service​Request​.​Request​Code​Id Lookup: CodeSet​Bundle 0​.1 N/A
order​Detail N/A N/A N/A Not Supported
quantity​.quantity​Quantity Clinical​Service​Request​.Quantity​Numerator Double 0​.1 Because Salesforce doesn’t support a native quantity data type, the implementation of service​Request​.quantity​.quantity​Quantity is flattened into a set of quantity and unit fields​.
quantity​.quantity​Quantity Clinical​Service​Request​.Quantity​Numerator​Unit​Id Lookup: UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native quantity data type, the implementation of service​Request​.quantity​.quantity​Quantity is flattened into a set of quantity and unit fields​.
quantity​.quantity​Ratio Clinical​Service​Request​.Quantity​Numerator Double 0​.1 Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Ratio Clinical​Service​Request​.Quantity​Denominator Double 0​.1 Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Ratio Clinical​Service​Request​.Quantity​Numerator​Unit​Id Lookup: UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native ratio data type, the implementation of service​Request​.quantity​.quantity​Ratio is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Ratio Clinical​Service​Request​.Quantity​Type

Picklist

Value: Ratio

 0​.1 For service​Request​.quantity​.quantity​Ratio information, Clinical​Service​Request​.Quantity​Type must use the value Ratio​.
quantity​.quantity​Range Clinical​Service​Request​.Quantity​Numerator Double 0​.1 Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Range Clinical​Service​Request​.Quantity​Denominator Double 0​.1 Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Range Clinical​Service​Request​.Quantity​Numerator​Unit​Id Lookup: UnitOf​Measure 0​.1 Because Salesforce doesn’t support a native range data type, the implementation of service​Request​.quantity​.quantity​Range is flattened into a set of numerator, denominator and unit fields​.
quantity​.quantity​Range Clinical​Service​Request​.Quantity​Type

Picklist

Value: Range

 0​.1 For service​Request​.quantity​.quantity​Range information, Clinical​Service​Request​.Quantity​Type must use the value Range​.
subject Clinical​Service​Request​.Patient​Id Master-​Detail Reference: Account 1​.1 Only references to patients are supported​.
encounter Clinical​Service​Request​.Clinical​Encounter​Id Lookup: Clinical​Encounter 0​.1 N/A
occurrence​.occurrence​Date​Time Clinical​Service​Request​.Start​Date ​Date​Time 0​.1 Clinical​Service​Request​.StartDate is used for both service​Request​.occurrence​.occurrence​Date​Time and service​Request​.occurrence​.occurrence​Period​. For the latter, the field is used to represent the start date of the period​.
occurrence​.occurrence​Period Clinical​Service​Request​.Start​Date ​Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the service​Request​.occurrence​.occurrence​Period is flattened into a set of start date and end date fields​.
occurrence​.occurrence​Period Clinical​Service​Request​.End​Date ​Date​Time 0​.1 Because Salesforce doesn’t support a native period data type, the service​Request​.occurrence​.occurrence​Period is flattened into a set of start date and end date fields​.
occurrence​.occurrence​Timing N/A N/A N/A Not supported
asNeeded​.asNeeded​Boolean Clinical​Service​Request​.Has​Prerequisites Boolean 0​.1 N/A
asNeeded​.asNeeded​Codeable​Concept Clinical​Service​Request​.Prerequisite​Code​Id Lookup: CodeSet​Bundle 0​.1 0​.1
authored​On Clinical​Service​Request​.Date​Signed ​Date​Time 0​.1 N/A
requester Clinical​Service​Request​.​Requester​Id Polymorphic Lookup: Account, Asset, Care​Registered​Device, and Healthcare​Provider 0​.1 N/A
performer​Type Clinical​Service​Request​.Performer​Type​Id Lookup: CodeSet​Bundle 0​.1 N/A
performer Clinical​Service​Request​.Performer​Id Polymorphic Lookup: Account, Asset, Care​Registered​Device, and Healthcare​Provider 0​.1

References to care teams and healthcare services are not supported​.

While FH​IR defines service​Request​.performer as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
location​Code Clinical​Service​Request​.Facility​CodeId Lookup: CodeSet​Bundle 0​.1 While FH​IR defines service​Request​.location​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
location​Reference Clinical​Service​Request​.Facility​Id Lookup: Healthcare​Facility 0​.1 While FH​IR defines service​Request​.location​Reference as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​Code Clinical​Service​Request​.Reason​CodeId Lookup: CodeSet​Bundle 0​.1 While FH​IR defines service​Request​.reason​Code as a zero-to-many resource, the Salesforce implementation is zero-to-one​.
reason​Reference Clinical​Service​Request​.Diagnostic​ReportId Lookup: Diagnostic​Summary 0​.1 N/A
reason​Reference Clinical​Service​Request​.Condition​Id Lookup: Health​Condition 0​.1 To support zero-to-many values, use the child object instead.
reason​Reference Clinical​Service​Request​.Observation​Id Lookup: Care​Observation 0​.1 To support zero-to-many values, use the child object instead.
reason​Reference Clinical​Service​Request​Detail Object 0​.M

The records referencing the reasons for a service request are represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.

reason​Reference Clinical​Service​Request​Detail​.​Detail​Record​Id Polymorphic Lookup: Health​Condition, Care​Observation, Diagnostic​Summary 0​.1 For service​Request​.reason​Reference information, Clinical​Service​Request​Detail​.​Detail​Record​Id must reference a Health​Condition or Care​Observation record​.
reason​Reference Clinical​Service​Request​Detail​.​Detail​Type

Picklist

Value: Reason Reference

 0​.1 For service​Request​.reason​Reference information, Clinical​Service​Request​Detail​.​Detail​Type must use the value Reason Reference​.
insurance N/A N/A N/A Not supported
supporting​Info N/A N/A N/A Not supported
specimen N/A N/A N/A Not supported
body​Site Clinical​Service​Request​Detail Object 0​.M

The body site information of a service​Request is represented as Clinical​Service​Request​Detail records that reference the Clinical​Service​Request record using their Clinical​Service​Request​Detail​.Clinical​Service​Request​Id field​.

body​Site Clinical​Service​Request​Detail​.​Detail​CodeId Polymorphic Lookup: CodeSet, CodeSet​Bundle 0​.1 For service​Request​.bodySite information, Clinical​Service​Request​Detail​.​Detail​CodeId must reference a CodeSet or CodeSet​Bundle record​.
body​Site Clinical​Service​Request​Detail​.​Detail​Type

Picklist

Value: Body Site

 0​.1 For service​Request​.bodySite information, Clinical​Service​Request​Detail​.​Detail​Type must use the value Body Site​.
Note N/A N/A N/A Not supported
patient​Instruction Clinical​Service​Request​.Patient​Instruction Text 0​.1 N/A
relevant​History N/A N/A N/A Not supported
## Sample Record Diagram Here's a diagram that shows an example of how this resource is represented in Salesforce. ![A diagram that shows how a service request for an x-ray for Charles is represented in Salesforce.](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_servicerequest.png) #### See Also - [ClinicalServiceRequest](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalServicerequest.htm "Represents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’s healthcare. This object is available in API version 51.0 and later.") - [ClinicalServiceRequestDetail](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalServiceRequestDetail.htm "Associates records from different objects to a clinical service request record to add more information to it. This is a multi-object junction object. This object is available in API version 51.0 and later.") # ServiceTerritoryRelationship Represents the relationship between service territories based on work types performed. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the service territory relationship. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### RelatedServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related service territory that's associated with a work type. This field is a relationship field. - **Relationship Name**: RelatedServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The service territory that's associated with a work type. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The work type that's performed at a service territory. This field is a relationship field. - **Relationship Name**: WorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ## Usage Create a service territory relationship record to map affiliated sites where consecutive work types are performed. Select a service territory where a work type—such as apheresis—is held. In Related Service Territory, select the service territory where the next work type—such as manufacturing—is held. ## 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. [ServiceTerritoryRelationshipChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 60.0) Change events are available for the object. [ServiceTerritoryRelationshipFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ServiceTerritoryRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ServiceTerritoryRelationshipOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ServiceTerritoryRelationshipShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # Servicing Facility Facility where the service is being provided. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | servicingFacilityId | String | ID of the facility where the patient is receiving the service for this care request. | Big, 55.0 | 55.0 | | servicingFacilityNpi | String | Servicing Facility NPI number. | Big, 46.0 | 46.0 | # Servicing Facility Input Facility where the service is being provided. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | npi | String | Servicing facility’s NPI number. | Yes | 46.0 | | servicingFacilityId | String | ID of the facility where the patient is receiving the service for this care request. | Yes | 55.0 | # Servicing Practitioner Practitioner administering the service. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | healthCareProviderId | String | ID of the provider associated with providing the service for this care request. This field is a lookup to HealthcareProviderId. | Big, 55.0 | 55.0 | | servicingPractitionerNpi | String | Servicing Practitioner NPI number. | Big, 46.0 | 46.0 | # Servicing Practitioner Input Practitioner administering the service. ## Root XML tag ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | healthCareProviderId | String | The provider associated with providing the service for this care request. This field is a lookup to HealthcareProviderId. | Yes | 55.0 | | npi | String | Servicing practitioner’s NPI number. | Yes | 46.0 | # Set Life Sciences Quote Document Defaults Action Sets default attributes on document recipients for a specified quote document based on its attached Lightning flexipage layout. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/setLsQuoteDocumentDefaults Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
quoteDocumentId String Required

The ID of the Quote Document record for which to populate recipient default properties.
## Outputs | Output | Type | Description | | --- | --- | --- | | errorDescription | String | Message detailing generic action failures when processing the quote document defaults. | | inputErrorDescription | String | Error message displayed when a valid quote document ID parameter is missing from the request. | | templateNotFound | String | Error message returned when document template details aren't found for the specified quote document. | | flexiPageDetailsNotFound | String | Error message returned when flexipage layout details can't be retrieved for the quote document. | | signaturePlaceholderNotFound | String | Error message returned when a Life Sciences signature component placeholder isn't found in the document template layout. | | unableToUpdateDocumentRecipient | String | Error message displayed when updating the document recipient record with the default signature identifier fails. | ## Example Sample Request { "inputs": \[ { "quoteDocumentId": "0QDxx0000004CQmGAM" } \] } Sample Response \[ { "actionName": "setLsQuoteDocumentDefaults", "errors": null, "isSuccess": true, "outputValues": { "errorDescription": null, "inputErrorDescription": null, "templateNotFound": null, "flexiPageDetailsNotFound": null, "signaturePlaceholderNotFound": null, "unableToUpdateDocumentRecipient": null } } \] # Share Quote Based on Account Action Synchronizes Quote sharing with Account sharing by querying AccountShare records for the specified Quote account ID and upserting the corresponding QuoteShare records. This action is available in API version 68.0 and later. This action only modifies records where the RowCause is set to LSC4CEAutoShare. It is designed for use in record-triggered flows (after save) and scheduled batch jobs for bulk processing. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/shareQuoteBasedOnAccount Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
recordId String Required

ID of the Quote record to be shared.
accessLevel String Required

Level of access granted for the shared Quote. Valid values are Edit and Read.
## Outputs | Output | Type | Description | | --- | --- | --- | | shareRecordsCreated | Integer | Number of Quote share records created based on the account sharing information. | | shareRecordsUpdated | Integer | Number of Quote share records updated based on the account sharing information. | | shareRecordsDeleted | Integer | Number of Quote share records deleted based on the account sharing information. | | isSuccess | Boolean | Indicates whether the Quote sharing operation completed successfully (true) or not (false). | ## Example Sample Request { "inputs": \[ { "recordId": "0Q0xx0000004C92GAE", "accessLevel": "Read" } \] } Sample Response \[ { "actionName": "shareQuoteBasedOnAccount", "errors": null, "isSuccess": true, "outputValues": { "shareRecordsCreated": 2, "shareRecordsUpdated": 0, "shareRecordsDeleted": 0, "isSuccess": true } } \] # Site Management The Site Management data model helps life sciences organizations identify suitable sites for conducting research studies. Study managers can search for the sites and investigators using the Criteria-Based Search and Filter, and send them assessments. From the assessment responses, study managers can assign scores to the sites, investigators, and their responses. They can also tag the sites and investigators for future site selection efforts.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Life Sciences Cloud
The Site Management objects are available in API version 62.0 and later. ![Site Management object relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/life_sciences/images/lsc_site_management_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/site-management.html "HTML (New Window)"). To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Slot Input Input representation of an appointment slot. ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | additionalInformation | String | Additional information about the appointment slot to be booked. | Optional | 60.0 | | appointmentType | String | ID of the Service Appointment record’s appointment type. | Optional | 60.0 | | city | String | Name of the city in which the appointment slot must be booked. | Optional | 60.0 | | comments | String | Appointment slot comments. | Optional | 60.0 | | contactId | String | ID of the contact for whom the appointment slot must be booked. | Optional | 60.0 | | country | String | Name of the country in which the appointment slot must be booked. | Optional | 60.0 | | description | String | Description for the appointment slot. | Optional | 60.0 | | postalCode | String | Postal code of the city in which the appointment slot must be booked. | Optional | 60.0 | | schedEndTime | String | Appointment end time. | Required | 60.0 | | schedStartTime | String | Appointment start time. | Required | 60.0 | | serviceAppointmentId | String | ID of the Service Appointment record associated with the appointment slot. | Optional | 60.0 | | serviceResourceId | String | ID of the Service Resource record associated with the appointment slot. | Required | 60.0 | | serviceTerritoryId | String | ID of the service territory in which the appointment slot must be booked. | Required | 60.0 | | state | String | Name of the state in which the appointment slot must be booked. | Optional | 60.0 | | status | String | Status of the appointment slot. Possible values are the enum values configured for the status field of the Service Appointment object on the Salesforce Scheduler. | Required | 60.0 | | street | String | Name of the street in which the appointment slot must be booked. | Optional | 60.0 | | subject | String | Subject for the appointment slot. | Optional | 60.0 | | workTypeId | String | ID of the work type for which the appointment slot must be booked. | Required | 60.0 | # Social Determinants The social determinants data model represents the barriers, health determinants, and interventions for a patient or member. Available in API version 45.0 and later. The social determinants standard objects are visible to users with the Health Cloud Starter permission set. ![Social determinants entity-relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/dev_guides/healthcare_api/images/social_determinants_ERD.png) To learn more about the standard objects used in this data model, refer [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_list.htm). # Split Documents Split a document and attach one or more pages from the transformed document to Salesforce records. For example, suppose you receive a fax containing multiple patients' documents in a single scanned copy. As needed, separate the document pages and attach the split documents to the patient's record. ## Resource /connect/document-automation/contentDocuments/${contentDocumentId}/linkedObjects/${linkedObjectId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org, and replace {XX.X} with the API version. https://{yourInstance}.salesforce.com/services/data/v{XX.X}/connect​/document-automation/contentDocuments/0ioRM0000004CqTYAU/linkedObjects/0OxRM0000004CqTYAU ## Available Version 55.0 ## Requires Chatter No ## HTTP Methods POST ## Request Parameters for POST | Parameter Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contentDocumentID | String | The ID of the content document to be split. | Required | 55.0 | | linkedObjectID | String | The ID of the linked object with which the split document must be associated. This is the ID of the DocumentChecklistItem object for Salesforce. | Required | 55.0 | ## Request Body for POST ### JSON Example { "pageSpecificationList": { "pageSpecifications": \[ { "page":1, "rotation":0, "addToTargetFile":"true" }, { "page":2, "rotation":0, "addToTargetFile":"true" } \] }, "linkedObjectFieldsMap" : { "linkedObjectFields" : {"ReceivedDocumentId" : "0ioxx00000000ODAAY"} }, "isOcrRequested" : true } ### Properties
Name Type Description Required or Optional Available Version
isOcrRequested Boolean Indicates whether OCR is required to process the content document (true) or not (false).

By default, OCR is performed on the first five pages of the content document.

Note: Set this field value to true to perform OCR on all the pages of a content document that contains more than five pages.

 Optional 55.0
linkedObjectFieldsMap Map<String, String> Represents the map that contains the linked object fields. For example, the linked object is the Document Checklist Item for Salesforce. Optional 55.0
pageSpecificationList Page Specification List Input[] The page specifications list representation. Required 55.0
targetFileName String The name of the target file that is created from the split document. Optional 55.0
## Response Body for POST [Document Management Result](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/connect_responses_document_management_result.htm "Output representation of the document split request.") # Sprint Represents a specific timeframe within which account action plans are executed within key account management. This object is available in API version 65.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CompletedPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of sprint tasks that have been completed. ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The effective end date and time of the sprint. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The effective start date and time of the sprint. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp when the current user last viewed this record or list view. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the sprint record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this object. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The identifier of the record in the source system. ### SourceSystemName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the system from which data is loaded into this object. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the current state of the sprint. - **Possible values**: - Completed - In-Progress - New ## 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. [SprintChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [SprintFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [SprintHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [SprintShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object. # StandardObjectNameChangeEvent A _StandardObjectName_ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events. ## Supported Calls describeSObjects() ## Special Access Rules - Not all objects may be available in your org. Some objects require specific feature settings and permissions to be enabled. - For more special access rules, if any, see the documentation for the standard object. For example, for AccountChangeEvent, see the special access rules for Account. ## Change Event Name Change events are available for all custom objects and a subset of standard objects. The name of a change event is based on the name of the corresponding object for which it captures the changes. **Standard Object Change Event Name** ChangeEvent Example: AccountChangeEvent **Custom Object Change Event Name** \_\_ChangeEvent Example: MyCustomObject\_\_ChangeEvent ## Change Event Fields The fields that a change event can include correspond to the fields on the associated parent Salesforce object, with a few exceptions. For example, AccountChangeEvent fields correspond to the fields on Account. The fields that a change event doesn’t include are: - The IsDeleted system field. - The SystemModStamp system field. - Any field whose value isn’t on the record and is derived from another record or from a formula, except roll-up summary fields, which are included. Examples are formula fields. Examples of fields with derived values include LastActivityDate and PhotoUrl. Each change event also contains header fields. The header fields are included inside the ChangeEventHeader field. They contain information about the event, such as whether the change was an update or delete and the name of the object, like Account. In addition to the event payload, the event schema ID is included in the schema field. Also included is the event-specific field, replayId, which is used for retrieving past events. ## Event Message Example The following example is an event message in JSON format for a new account record creation. { "schema": "IeRuaY6cbI\_HsV8Rv1Mc5g", "payload": { "ChangeEventHeader": { "entityName": "Account", "recordIds": \[ "" \], "changeType": "CREATE", "changeOrigin": "com/salesforce/api/soap/51.0;client=SfdcInternalAPI/", "transactionKey": "0002343d-9d90-e395-ed20-cf416ba652ad", "sequenceNumber": 1, "commitTimestamp": 1612912679000, "commitNumber": 10716283339728, "commitUser": "" }, "Name": "Acme", "Description": "Everyone is talking about the cloud. But what does it mean?", "OwnerId": "", "CreatedDate": "2021-02-09T23:17:59Z", "CreatedById": "", "LastModifiedDate": "2021-02-09T23:17:59Z", "LastModifiedById": "" }, "event": { "replayId": 6 } } ## API Version and Schema When you subscribe to change events, the subscription uses the latest API version and the event messages received reflect the latest field definitions. For more information, see [API Version and Event Schema](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_message_structure.htm#cdc_event_schema.htm) in the Change Data Capture Developer Guide. ## Usage For more information about Change Data Capture, see [Change Data Capture Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.change_data_capture.meta/change_data_capture/cdc_intro.htm). ## Objects That Support Change Events The following objects have associated ChangeEvent objects. - AccountPlanParticipant - AccountPlanProduct - AccountPlanRelationship - AccountPlanRelaObjAnalysis - AccountPlanStakeholder - AccountPlanStkhldrAction - AccountPlanStkhldrProduct - AcctPlanPtcpStakeholder - ActionableList - ActionableListFilterCriteria - ActionPlanStatusPeriod - AppAlert - AppAlertTerritory - AppAlertUserResponse - BusinessLicenseProduct - CareProgram - CommSubConsentCmplSnpsht - CommSubscription - ContactPointAddress - ContactPointBestContactTime - ContactPointSocial - GoalDefinitionProduct - HealthcareProvider - Inquiry - InquiryQuestion - InquiryQuestionAnswer - LifeSciAcctGrpAssignment - LifeSciEmailTemplate - LifeSciEmailTmplFragment - LifeSciEmailTmplRelaFrgmt - LifeSciEmailTmplSnapshot - LifeSciMarketableProduct - LifeSciProductAcctRstrc - LifeScienceEmail - MergeRequest - PartyPublication - ProductGuidance - ProductTerritoryAvailability - ProviderAcctProductInfo - ProviderAcctTerritoryInfo - ProviderAffiliation - ProviderAffiliationProduct - PrvdEngmtComplianceCycle - PrvdAccountTerritorySummary - Sprint - TerritoryAccountScore - TerritoryAcctProdMsgScore - TerritoryAcctRcmdAction - TerritoryBusinessPlan - TerrGeoAssignmentRule - TerrProvAffilAssignRule - VideoCall - VideoCallParticipant - VideoCallPtcpRequest - VideoCallPtcpSession - VideoCallRecording # StandardObjectNameFeed _StandardObjectName_Feed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object. The object name is variable and uses _StandardObjectName_Feed syntax. For example, AccountFeed represents the posts and feed-tracked changes on an account record. We list the available associated feed objects at the end of this topic. For specific version information, see the documentation for the standard object. ## Supported Calls delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve() ## Special Access Rules In the internal org, users can delete all feed items they created. This rule varies in communities where threaded discussions and delete-blocking are enabled. Community members can delete all feed items they created, provided the feed items don’t have content nested under them—like a comment, answer, or reply. Where the feed item has nested content, only feed moderators and users with the 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 Records on the parent object, like Account for AccountFeed - Moderate Chatter ![Note](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note.png) #### Note Users with the Moderate Chatter permission can delete only the feed items and comments they can see. Only users with this permission can delete items in unlisted groups. For more special access rules, if any, see the documentation for the standard object. For example, for AccountFeed, see the special access rules for Account. ## Fields ### BestCommentId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The ID of the comment marked as best answer on a question post. ### Body - **Type**: textarea - **Properties**: Nillable, Sort - **Description**: The body of the post. Required when Type is TextPost. Optional when Type is ContentPost or LinkPost. ### CommentCount - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The number of comments associated with this feed item. ### ConnectionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: When a PartnerNetworkConnection modifies a record that is tracked, the CreatedBy field contains the ID of the system administrator. The ConnectionId contains the ID of the PartnerNetworkConnection. Available if Salesforce to Salesforce is enabled for your organization. ### InsertedById - **Type**: reference - **Properties**: Group, Nillable, Sort - **Description**: ID of the user who added this item to the feed. For example, if an application migrates posts and comments from another application into a feed, the InsertedBy value is set to the ID of the context user. ### isRichText - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the feed item Body contains rich text. If you post a rich text feed comment using 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](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_tip.png) #### Tip Though the
tag isn’t supported, you can use

 

to create lines. - - - - - - -