# legacydeveloper Health Cloud Object Reference - Full Documentation # Access to Provider Network Management The provider network management standard objects are available to users with the Health Cloud Platform and Provider Network Management permission set licenses and the Health Foundation permission set. The provider network management data model is available in API version 52.0 and later. You must have the Health Cloud Provider Network Management Add On license, which contains the Health Cloud Provider Network Management platform license and the Health Cloud Provider Network Management user permission set license. Some of the objects are available in your org even before enabling this org pref because they’re part of other data models in Health Cloud or other Salesforce products. These objects need the Health Cloud Provider Network Management Add On license to be enabled before you can use them: - Application Case - Individual Application - Insurance Policy - Person Employment - Provider Network Tier - Provider Network Contract - Care Fee Schedule Item - Fee Schedule Definition - Contract Payment Agreement - Standard Care Fee Agreement - Categorized Care Fee Agreement - Capitation Care Fee Agreement - Shared Saving Payment Agreement - Percentile Care Fee Agreement - Bundled Care Fee Agreement - Preventive Care Agreement And these fields are added to existing objects when you enable the Health Cloud Provider Network Management Add On license. Business License - IsPrimaryLicense - IssueDate - LicenseNumber Care Provider Adverse Action - ActionIssueDate - IncidentDate - IncidentReportedDate - InsurancePolicyNumber - InsuranceProviderName - PenaltyAmount - RegulatoryBody - RegulatoryBodyType Person Education - InstitutionAddress - ProgramName - CertificateIdentifier # Account Custom Fields Custom fields extend the standard Account object for use in Emergency Response Management. ## Fields ### ConditionStatus\_\_pc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents a person’s condition based on their most recent test or assessment. - **Possible values**: - Asymptomatic - Asymptomatic - Declined to Participate - Cured - Evaluated - No Risk - Symptomatic - Symptomatic - Declined to Participate ### Monitored\_at\_Home\_\_pc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Whether a person’s condition is being monitored at their home, rather than a clinical setting. - **Possible values**: - No - Yes ### StatusGroup\_\_pc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Categorizes a person’s stage within the testing and monitoring process. - **Possible values**: - Monitored - Positive - Ready for intake - Unknown - Unmonitored ### Testing\_Status\_\_pc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the result of a person’s most recent test. - **Possible values**: - Negative Test - Positive Test - Test Results Pending—Test Results Awaited - Test Scheduled - Testing Recommended - Unknown # AccountServicePreference Represents the preferences an account has for the services they receive. In Home Health, this object represents the preferences that a patient has for the health workers assigned to their visits. 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**: Lookup - **Properties**: Create, Filter, Group, Sort - **Description**: The patient whose preference is being recorded. - **Relationship Name**: Account - **Refers To**: 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 name of the record. ### PreferenceId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Preference that the patient has about their health worker. This preference may be a skill or trait, or a specific person that they want to avoid or be assigned to their visit. - **Relationship Name**: Preference - **Refers To**: - ServiceResource - Skill ### PreferenceOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The order of the preference selected by the patient. This field is available in API version 61.0 and later. ### PreferenceType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of preferences that’s recorded. - **Possible values**: - Skill ### ServiceContextId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the work type that this preference is valid for. For instance, a patient may have a certain preference that only applies to physiotherapy and another preference that only applies to wound management. - **Relationship Name**: ServiceContext - **Refers To**: WorkType ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the feature that the created record is applicable for. - **Possible values**: - HomeHealth—Home Health ## 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. [AccountServicePreferenceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AccountServicePreferenceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AccountServicePreferenceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # ActionPlanTemplate Represents the instance of an action plan template. This object is available in API version 44.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**: - Industries - Visit Execution. For Intelligent Sales, select only Visit Execution. ### 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 ### 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 ### 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**: - CareBarrier In API version 58.0 and later with Health Cloud. ### 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 In Health Cloud, 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 ### 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. - **Relationship Name**: ActionPlanTemplateVersion - **Relationship Type**: Master-Detail - **Refers To**: ActionPlanTemplateVersion ### AssociatedObjectId - **Type**: 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. - **Refers To**: CarePlanTemplate - **Relationship Type**: Lookup - **Refers To** - CarePlanTemplate - GoalDefinition - ProblemDefinition ### 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. # ActionPlanTemplateAssignment for Medication Management Represents the association of an action plan template with its related care plan template, goal, or problem definition. Multiple features use this object. See [ActionPlanTemplateAssignment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_actionplantemplateassignment.htm "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."). # ActionVisibility This object serves as a junction to connect Account or Contact to other objects so that information in those other object can be used to define visibility rules for actions in the Dynamic Actions for Unified Health Scoring component. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account record of the subject. - **Refers To**: Account ### ContactId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact record of the subject. - **Refers To**: Contact ### HealthScoreId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The subject’s score. - **Refers To**: HealthScore ### 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 name of the record. ### OwnerId - **Type**: Lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Refers To**: Group, User ## Usage Add custom fields on this object to support the time of visibility logic you have to implement for your actions. Then, use custom triggers and processes to automatically create and reference these records from the subject’s records, and populate the fields in this record with the information relevant to your implementation. ## 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. [ActionVisibilityFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ActionVisibilityHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ActionVisibilityShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. | # Address Input The detailed address information for a facility used as search criteria. ## JSON Example { "facilityAddress": { "addressText": "1000 Main Street, Suite 200, Springfield, IL 62704, USA", "streetLines": \[ "1000 Main Street", "Suite 200" \], "city": "Springfield", "district": "Sangamon County", "stateProvince": "IL", "postalCode": "62704", "country": "USA", "latitude": 39.7990, "longitude": -89.6586 } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | addressText | String | The complete address in a single text string. | Optional | | streetLines | Array of Strings | An array of strings representing the street address lines, including building number, street name, and apartment/suite/P.O. Box details. | Optional | | city | String | The name of the city, town, or locality. | Optional | | district | String | The district, county, or administrative area. | Optional | | stateProvince | String | The full name or standard abbreviation of the state, province, or region. | Optional | | postalCode | String | The postal code, ZIP code, or postcode relevant to the address. | Optional | | country | String | The country of the address, ideally a two-letter (ISO 3166-1 alpha-2) or three-letter (ISO 3166-1 alpha-3) country code. | Optional | | latitude | Number | The geographical latitude coordinate of the address. | Optional | | longitude | Number | The geographical longitude coordinate of the address. | Optional | # Address Output The detailed address information for a facility or resource in the response. ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | addressText | String | The complete address formatted as a single text string. | Optional | | streetLines | Array of Strings | An array of strings, where each string represents a line of the street address. | Optional | | city | String | The name of the city or town. | Optional | | district | String | The district, county, or administrative division. | Optional | | stateProvince | String | The name or standard abbreviation of the state, province, or region. | Optional | | postalCode | String | The postal code, ZIP code, or equivalent for the address. | Optional | | country | String | The country name or its ISO 3166-1 alpha-2/alpha-3 code. | Optional | | latitude | Number | The geographical latitude coordinate of the address. | Optional | | longitude | Number | The geographical longitude coordinate of the address. | Optional | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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). - **[AdvTherapyFieldOptOverride](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_advtherapyfieldoptoverride.htm)** Represents a list of fields with changed optionality, based on certain parameters. This object is available in API version 59.0 and later. - **[CarePgmEnrolleeWorkOrder](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carepgmenrolleeworkorder.htm)** 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. - **[CarePgmEnrolleeWkOrdStep](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carepgmenrolleewkordstep.htm)** 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. - **[CareProgramEnrollee for Advanced Therapy Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_atm_objects_careprogramenrollee.htm)** Represents a participant enrolled in a care program. - **[CustodyChainEntry](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_custodychainentry.htm)** Represents information about an entry or event in the chain of custody. This object is available in API version 59.0 and later. - **[CustodyItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_custodyitem.htm)** Represents information about an item in the custody chain. This object is available in API version 59.0 and later. - **[CustodyVerfcTypeOverride](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_custodyverfctypeoverride.htm)** Represents information about the verification of an entry in the chain of custody. This object is available in API version 59.0 and later. - **[ServiceAppointmentGroup](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceappointmentgroup.htm)** Stores information about a group of related service appointments. This object is available in API version 56.0 and later. - **[ServiceTerritoryRelationship](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceterritoryrelationship.htm)** Represents the relationship between service territories based on work types performed. This object is available in API version 56.0 and later. - **[Team](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_team.htm)** Represents the team of members associated with an organization. This object is available in API version 58.0 and later. - **[TeamMember](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_teammember.htm)** Represents the member associated with a team. This object is available in API version 58.0 and later. - **[WorkProcedure](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_workprocedure.htm)** Represents information about a procedure or process that's part of a program, such as a care program in Health Cloud or Life Sciences Cloud. - **[WorkProcedureStep](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_workprocedurestep.htm)** Represents information about the work type that's a part of a work procedure. - **[WorkTypeExtension](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypeextension.htm)** Represents additional information about a work type. - **[WorkTypeStep](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypestep.htm)** Represents each step within a work type. - **[WorkTypeStepLdTimeOvride](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypestepldtimeovride.htm)** Represents the lead time that's used to override the default lead time required for the work procedure, work type, or work type step that's performed at a service territory in a country. This object is available in API version 59.0 and later. - **[WorkTypeSvcTerrSchdPrio](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypesvcterrschdprio.htm)** Represents the priority of the combination of the service territory, work type, and work procedure while fetching appointment slots. This object is available in API version 59.0 and later. #### See Also - [_Salesforce Scheduler Developer Guide_: Salesforce Scheduler Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_scheduler_developer_guide.meta/salesforce_scheduler_developer_guide/salesforce_scheduler_objects_overview.htm) # Adverse Events Adverse Events data model helps you in managing and documenting any unfavorable or unintended signs, symptoms, or diseases that occur as a result of an intervention, such as medical care or research, that impacts a patient or group of patients or participants. These adverse events can include a wide range of physical or psychological effects that varies from mild discomfort to serious health complications. For more information, see [Adverse Events in Life Sciences Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_adverse_event.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 | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # AgeBandHlthRskAdjFctr Stores the risk adjustment factor for patients and members based on the age band that they’re a part of and the status of their benefits eligibility. 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 ### AgeBandEnd - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The upper limit of the age band. ### AgeBandStart - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The lower limit of the age band. ### CmnyFullBnftDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### CmnyPartialBenefitDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CmnyPartialBnftDualDsbl - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### Community - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home. ### CommunityFullBnftDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CommunityNonDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of their age. ### CommunityNonDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of a disability. ### EnrolleeType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies whether the patient is a new enrollee or a continued enrollee. - **Default value**: New - **Possible values**: - Continued - New ### Gender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the gender of the patient. ### Institutional - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment. factor for a patient who lives at a healthcare facility. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the risk adjustment factors specified in the record are active. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time that the record was referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The last date and time that the record was referenced. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PublishedYear - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The year when the risk adjustment factors in the record were published. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Health 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. - **[HealthCloudExt Namespace](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm)** The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. - **[id\_verification Namespace](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm)** The id\_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity. - **[embeddedai Namespace](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[BatchProcessor for Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_batch_processor_ref.htm)** Schedule Apex used to schedule the batch job for document processing. - **[DocumentAI Namespace](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm)** The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing. - **[hlthcrbilling Namespace](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_namespace_hlcrbilling)** The hlthcrbilling namespace provides classes used to capture billing information for products in Salesforce Health Cloud. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_embeddedai_ApexMap.htm#apex_embeddedai_ApexMap_properties)** - **[ApexMap Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ApplicationCase This junction object stores a relationship between Case and IndividualApplication. This object is available in API version 52.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApplicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual application associated with a case application. This is a relationship field. - **Relationship Name**: Application - **Relationship Type**: Lookup - **Refers To**: IndividualApplication ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The case associated with a case application. This is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Lookup - **Refers To**: Case ### 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 most recent date on which a user viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name associated with 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. [ApplicationCaseFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ApplicationCaseHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ApplicationCaseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Appointment Management Book, cancel or update an appointment for a patient. These APIs are a part of the Intelligent Appointment Management (IAM) and calls into the system, while the [Intelligent Appointment Management Operations API](http://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_operations.htm) calls out to an external system. - **[Book Appointment (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_appointment_management_book_appointment.htm)** Create or book a health appointment. - **[Cancel Appointment (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_appointment_management_cancel_appointment.htm)** Cancel a health appointment. - **[Update Appointment (PUT)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_appointment_management_update_appointment.htm)** Update an appointment. - **[Get Slots (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_appointment_management_get_slots.htm)** Get slots associated with the provider or asset. - **[Get Resources (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_get_resources.htm)** Search for healthcare care providers or assets using the backend search engine and data. # Appointment Management Output Output representation for appointment management. ## JSON example { "id": "08pxx0000004KhxxAE", "isSuccess": true, "status": "scheduled", "error": {} } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | Array | List of errors returned. This field is populated if isSuccess is false. | Small, 65.0 | 65.0 | | id | String | ID of the appointment. | Small, 65.0 | 65.0 | | isSuccess | Boolean | Indicates whether the appointment is created successfully (true) or not (false). | Small, 65.0 | 65.0 | | status | String | Status of the appointment such as scheduled, rejected. | Small, 65.0 | 65.0 | # AppointmentBase Class An abstract base class that represents the care provider or the practitioner information. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[AppointmentBase Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBase.htm#apex_healthcloudext_AppointmentBase_properties)** ## AppointmentBase Properties The following are properties for AppointmentBase. - **[careProviders](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBase.htm#apex_healthcloudext_AppointmentBase_careProviders)** Represents details about the care provider or the practitioner. ### careProviders Represents details about the care provider or the practitioner. #### Signature public List careProviders {get; set;} #### Property Value Type: List<[healthcloudext.AppointmentProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_class_healthcloudext_AppointmentProvider "Represents additional information about the care provider and an appointment.")\> # AppointmentBookingInterop Interface Contains default Apex implementation for healthcare appointment availability and booking. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") ## Usage Managing appointments from Health Cloud requires identifying the source system's time slot support; implementing the Health Cloud global AppointmentBookingInterop interface; transforming the input request to fit the source electronic health records (EHR) system; routing the request to the EHR system; and getting the appointment information back from an external appointment booking system. The external appointment management system is commonly part of a larger electronic health records (EHR) system. The integration between Health Cloud and the EHR can be direct or via integration middleware such as Mulesoft. The OrgPermissions.HealthCloud permission must be enabled in your Salesforce org to access the Health Cloud AppointmentBookingInterop interface and its methods. You can use the default implementation AppointmentBookingInteropFhirAdapter provided by Health Cloud to make a call out to an external scheduling system of truth for appointment availability and booking. All communications with the external system use the FHIR 4 standard. If implementing the default Health Cloud global interface isn’t right for your context, you can provide your own Apex class and integrate with your appointment management system in your own way. An ISV or a Salesforce partner with a Health Cloud license can distribute customized Apex code to your organization using packages. To include more data in the response or change the structure of the response, create a custom version of the findSlots method. Your custom method can prepare the data in the response or map data to the list of time slots expected. Your custom method must use the same signature as the original method. After you create your custom findSlots method, incorporate it into a custom implementation of the AppointmentBookingInterop interface. To have Intelligent Appointment Manager use your custom implementation of the AppointmentBookingInterop interface, update the active version of your Intelligent Appointment Management Configuration. From Setup, in the Intelligent Appointment Management Configuration, for Apex Class, enter your custom Apex class. If left blank, Intelligent Appointment Manager uses the default Apex class. Use Salesforce platform Named Credentials to configure the class name and authentication for Apex callouts. Then, map the Name Credential name in the AppointmentBookingConfig setup object. The Apex delegator class uses the setup object to invoke the corresponding implementation between the default implementation or your own provided Apex implementation. See Named Credentials as Callout Endpoints in the [Apex Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_callouts_named_credentials.htm). - **[AppointmentBookingInterop Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_healthcloudext_AppointmentBookingInterop_methods)** - **[AppointmentBookingInterop Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_interface_healthcloudext_AppointmentBookingInterop_Example)** This is an example implementation of the default class AppointmentBookingInteropFhirAdapter that implements the healthcloudext.AppointmentBookingInterop interface. ## AppointmentBookingInterop Methods The following are methods for AppointmentBookingInterop. - **[bookAppointment(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_healthcloudext_AppointmentBookingInterop_bookAppointment)** Creates the healthcare appointment in the external scheduling system. - **[cancelAppointment(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_healthcloudext_AppointmentBookingInterop_cancelAppointment)** Cancels the booking appointment in the external scheduling system. - **[findSlots(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_healthcloudext_AppointmentBookingInterop_findSlots)** Finds the available time slots for providers who match the patient’s needs. - **[getSlotStatus(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_healthcloudext_AppointmentBookingInterop_getSlotStatus)** Retrieves the status of the time period slot that’s assigned to the appointment. ### bookAppointment(var1) Creates the healthcare appointment in the external scheduling system. #### Signature public healthcloudext.BookAppointmentResponse bookAppointment(healthcloudext.BookAppointmentRequest var1) #### Parameters var1 Type: [healthcloudext.BookAppointmentRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_class_healthcloudext_BookAppointmentRequest "Contains set of options to book a healthcare appointment.") #### Return Value Type: [healthcloudext.BookAppointmentResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_class_healthcloudext_BookAppointmentResponse "Represents the appointment booking details from the external scheduling system.") ### cancelAppointment(var1) Cancels the booking appointment in the external scheduling system. #### Signature public healthcloudext.CancelAppointmentResponse cancelAppointment(healthcloudext.CancelAppointmentRequest var1) #### Parameters var1 Type: [healthcloudext.CancelAppointmentRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_class_healthcloudext_CancelAppointmentRequest "Contains set of options to cancel the booked appointment.") #### Return Value Type: [healthcloudext.CancelAppointmentResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_class_healthcloudext_CancelAppointmentResponse "Represents the appointment cancellation details from the external scheduling system.") ### findSlots(var1) Finds the available time slots for providers who match the patient’s needs. The findSlots method accepts FindSlotsRequest as a parameter. The FindSlotsRequest class extends the AppointmentBase class and inherits its properties, including details about the care provider such as code sets, identifiers, and the source system used for scheduling. #### Signature public Map> findSlots(healthcloudext.FindSlotsRequest var1) #### Parameters var1 Type: [healthcloudext.FindSlotsRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_class_healthcloudext_FindSlotsRequest "Contains set of options to find available time slots for providers who match the patient’s needs. This class extends the AppointmentBase class and inherits its properties.") #### Return Value Type: Map> ### getSlotStatus(var1) Retrieves the status of the time period slot that’s assigned to the appointment. #### Signature public healthcloudext.Slot getSlotStatus(healthcloudext.GetSlotStatusRequest var1) #### Parameters var1 Type: [healthcloudext.GetSlotStatusRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_class_healthcloudext_GetSlotStatusRequest "Contains set of options to retrieve the slot status.") #### Return Value Type: [healthcloudext.Slot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_class_healthcloudext_Slot "Represents the time period slot details for the appointment.") ## AppointmentBookingInterop Example Implementation This is an example implementation of the default class AppointmentBookingInteropFhirAdapter that implements the healthcloudext.AppointmentBookingInterop interface. global class AppointmentBookingInteropFhirAdapter implement healthcloudext.AppointmentBookingInterop{ static final String DEFAULT\_ERROR\_MESSAGE = 'Error during callout to the external system'; static final String DEFAULT\_ERROR\_CODE = '500'; /\* @Method Name: findSlots @Param: request Type: healthcloudext.FindSlotsRequest @Desc: FindSlot implementation \*/ global Map> findSlots(FindSlotsRequest request) /\* @Method Name: bookAppointment @Param: request Type: healthcloudext.BookAppointmentRequest @Desc: Book Appointment implementation \*/ global BookAppointmentResponse bookAppointment(BookAppointmentRequest request) /\* @Method Name: getSlotStatus @Param: request Type: healthcloudext.GetSlotStatusRequest @Desc: getSlotStatus implementation \*/ global Slot getSlotStatus(GetSlotStatusRequest request) /\* @Method Name: cancelAppointment @Param: request Type: healthcloudext.CancelAppointmentRequest @Desc: Cancel Appointment implementation \*/ global CancelAppointmentResponse cancelAppointment(CancelAppointmentRequest request) } # AppointmentBookingInteropFhirAdapter Class Represents the global class that implements the AppointmentBookingInterop interface. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[AppointmentBookingInteropFhirAdapter Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_healthcloudext_AppointmentBookingInteropFhirAdapter_methods)** ## AppointmentBookingInteropFhirAdapter Methods The following are methods for AppointmentBookingInteropFhirAdapter. - **[bookAppointment(request)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_healthcloudext_AppointmentBookingInteropFhirAdapter_bookAppointment)** Contains set of options to book a healthcare appointment with the external scheduling system. - **[cancelAppointment(request)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_healthcloudext_AppointmentBookingInteropFhirAdapter_cancelAppointment)** Contains set of options to cancel the booked appointment from the external scheduling system. - **[findSlots(request)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_healthcloudext_AppointmentBookingInteropFhirAdapter_findSlots)** Contains set of options to find available time slots for healthcare providers who match the patient’s needs. - **[getSlotStatus(request)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_healthcloudext_AppointmentBookingInteropFhirAdapter_getSlotStatus)** Contains set of options to retrieve the slot status. ### bookAppointment(request) Contains set of options to book a healthcare appointment with the external scheduling system. #### Signature public healthcloudext.BookAppointmentResponse bookAppointment(healthcloudext.BookAppointmentRequest request) #### Parameters request Type: [healthcloudext.BookAppointmentRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_class_healthcloudext_BookAppointmentRequest "Contains set of options to book a healthcare appointment.") #### Return Value Type: [healthcloudext.BookAppointmentResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_class_healthcloudext_BookAppointmentResponse "Represents the appointment booking details from the external scheduling system.") ### cancelAppointment(request) Contains set of options to cancel the booked appointment from the external scheduling system. #### Signature public healthcloudext.CancelAppointmentResponse cancelAppointment(healthcloudext.CancelAppointmentRequest request) #### Parameters request Type: [healthcloudext.CancelAppointmentRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_class_healthcloudext_CancelAppointmentRequest "Contains set of options to cancel the booked appointment.") #### Return Value Type: [healthcloudext.CancelAppointmentResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_class_healthcloudext_CancelAppointmentResponse "Represents the appointment cancellation details from the external scheduling system.") ### findSlots(request) Contains set of options to find available time slots for healthcare providers who match the patient’s needs. #### Signature public Map> findSlots(healthcloudext.FindSlotsRequest request) #### Parameters request Type: [healthcloudext.FindSlotsRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_class_healthcloudext_FindSlotsRequest "Contains set of options to find available time slots for providers who match the patient’s needs. This class extends the AppointmentBase class and inherits its properties.") #### Return Value Type: Map> ### getSlotStatus(request) Contains set of options to retrieve the slot status. #### Signature public healthcloudext.Slot getSlotStatus(healthcloudext.GetSlotStatusRequest request) #### Parameters request Type: [healthcloudext.GetSlotStatusRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_class_healthcloudext_GetSlotStatusRequest "Contains set of options to retrieve the slot status.") #### Return Value Type: [healthcloudext.Slot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_class_healthcloudext_Slot "Represents the time period slot details for the appointment.") # AppointmentProvider Class Represents additional information about the care provider and an appointment. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[AppointmentProvider Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_properties)** ## AppointmentProvider Properties The following are properties for AppointmentProvider. - **[appointmentTypeCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_appointmentTypeCode)** Represents the code for the appointment type. - **[careProviderId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_careProviderId)** Represents the ID of the care provider. - **[npi](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_npi)** Represents the unique National Provider Identifier that is assigned to each facility and licensed practitioner. - **[practitionerFacilityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_practitionerFacilityId)** Represents the facility ID of the practitioner. - **[serviceTypeCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_serviceTypeCode)** Represents the code of the service type to be performed at the appointment. - **[sourceFacilityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_sourceFacilityId)** Represents the ID in the source system of the facility where the encounter will occur. - **[sourcePractitionerId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_sourcePractitionerId)** Represents the ID in the source system of the practitioner with whom the encounter will occur. - **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_healthcloudext_AppointmentProvider_sourceSystem)** Represents the name of the source system the provider record came from. ### appointmentTypeCode Represents the code for the appointment type. #### Signature public String appointmentTypeCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### careProviderId Represents the ID of the care provider. #### Signature public String careProviderId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### npi Represents the unique National Provider Identifier that is assigned to each facility and licensed practitioner. #### Signature public String npi {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### practitionerFacilityId Represents the facility ID of the practitioner. #### Signature public String practitionerFacilityId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceTypeCode Represents the code of the service type to be performed at the appointment. #### Signature public String serviceTypeCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceFacilityId Represents the ID in the source system of the facility where the encounter will occur. #### Signature public String sourceFacilityId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePractitionerId Represents the ID in the source system of the practitioner with whom the encounter will occur. #### Signature public String sourcePractitionerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceSystem Represents the name of the source system the provider record came from. #### Signature public String sourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # AppointmentReason Represents a patient’s reason for making an appointment. Used for self-scheduling in Intelligent Appointment Management. 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 ### AppointmentReason - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The patient's reason for making the appointment. Not the same as visit type. ### AppointmentReasonImageId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Image related to the visit reason, such as a stethoscope or a splint. This field is a relationship field. - **Relationship Name**: AppointmentReasonImage - **Relationship Type**: Lookup - **Refers To**: ContentDocument ### DefaultImage - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Generic image for all visit reasons. A custom image overrides the default image if present. ### DefaultWorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the default appointment parameters for a new patient. This field is a relationship field. - **Relationship Name**: DefaultWorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Detailed information about the patient's reason for making the appointment. ### EstablishedWorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies appointment parameters for an established patient (has been seen within the last three years) if different from the default work type. This field is a relationship field. - **Relationship Name**: EstablishedWorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the appointment reason is active. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when this record was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the Appointment Reason 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 ### ResourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of resource associated with the appointment reason. - **Possible values**: - Asset - Provider ### Visibility - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates if this Appointment Reason is available for patients to self-schedule. - **Possible values**: - PATIENT\_SELF\_SCHEDULING ## 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. [AppointmentReasonFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AppointmentReasonHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AppointmentReasonOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AppointmentReasonShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ApptBookingConfig Represents a collection of fields to set up appointment scheduling. This object is available in API version 52.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### ApexClassId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Apex class that's used when scheduling an appointment using an external scheduling system. If not specified, the default Health Cloud-supplied Apex class is used. - **Relationship Name**: ApexClass - **Relationship Type**: Lookup - **Refers To**: ApexClass ### AssignedProviderRole - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Role used in an Account Contact Relation record to associate a patient (Person Account) with their assigned provider (Contact). ### AttendanceThresholdPct - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Percentage of attended appointments above which a time slot is highlighted in the scheduling console. ### BestTimeSlotsDefinition - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the attendance prediction taken from Einstein Discovery. ### CanCreateDuplicateRecord - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If true, Health Cloud creates a new record when two or more existing records contain duplicate data. If false, Health Cloud stops processing and creates a case you can review to reconcile the duplicates. ### 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. ### GetSlotStatusTimeout - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of milliseconds before a request to retrieve time slot statuses from a scheduling system times out. Valid values are from 0 through 60000. This field is available in API version 62.0 and later. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a configuration is active. - **Default value**: false ### IsSingleSourceSystem - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the configuration is associated with a single source system. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the appointment booking 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**: Create, Filter, Group, Sort, Update - **Description**: The UI label of Appointment Booking Configuration ### NamedCredentialId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fully-qualified named credential used by the Apex class to connect to an external scheduling system. This field is a relationship field. - **Relationship Name**: NamedCredential - **Relationship Type**: Lookup - **Refers To**: NamedCredential ### ServiceApptRecordTypeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The record type of the service appointment used for appointment scheduling. # ApptBookingUrlConfig Represents a collection of fields used to set up the URL paths for appointment scheduling endpoints. This object is available in API version 52.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### AdditionalHeaders - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Specify headers added to the HTTP request. The format is: key:value;key:value;key:value; ### ApptBookingConfigId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The appointment scheduling config associated with the record. This field is a relationship field. - **Relationship Name**: ApptBookingConfig - **Relationship Type**: Lookup - **Refers To**: ApptBookingConfig ### 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. ### EndpointName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the name of the endpoint to be called. - **Possible values**: - CANCEL\_APPOINTMENT—Cancel Appointment - CREATE\_APPOINTMENT—Create Appointment - CREATE\_PATIENT—Create Patient - FIND\_SLOTS—Find Slots - GET\_APPOINTMENT—Get Appointment - GET\_SLOT\_STATUS—Get Slot Status ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the Appointment Booking URL 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**: Create, Filter, Group, Sort, Update - **Description**: The UI label of Appointment Booking URL Configuration. ### UrlPath - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL path for the endpoint. # ApptReasonEngmtChannelType Represents an available engagement channel for a given AppointmentReason. Possible engagement channels could be video, phone, or in person. Possible appointment reasons could be annual physical, fever, or physical therapy. This object is available in API version 56.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AppointmentReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient's reason for making this appointment. This field is a relationship field. - **Relationship Name**: AppointmentReason - **Relationship Type**: Lookup - **Refers To**: AppointmentReason ### DefaultWorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The work type that defines the default parameters that apply to a new patient. This field is a relationship field. - **Relationship Name**: DefaultWorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### EngagementChannelTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The channel that the patient can access related to the appointment reason. This field is a relationship field. - **Relationship Name**: EngagementChannelType - **Relationship Type**: Lookup - **Refers To**: EngagementChannelType ### EstablishedWorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type that defines the parameters that apply to an established patient, if different from the default work type. This field is a relationship field. - **Relationship Name**: EstablishedWorkType - **Relationship Type**: Lookup - **Refers To**: WorkType ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when this record was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the ApptReasonEngmtChannelType 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. [ApptReasonEngmtChannelTypeFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ApptReasonEngmtChannelTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # AsmtQstnRespRecommendation Maps an assessment question’s response to the recommendation it has to provide for a care plan. Recommendations can be problems, goals, interventions, or other assessments. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentQuestionVersionId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment question whose response is mapped to a recommendation. The combination of values selected in the AssessmentQuestionVersionId and OmniProcessId fields must have a matching combination in at least one OmniProcessAsmtQuestionVer record. - **Relationship Name**: AssessmentQuestionVersion - **Refers To**: AssessmentQuestionVersion ### 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 name of the record ### OmniProcessId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assessment that this question-response-recommendation mapping is valid for. If a response to a question is mapped to the same recommendation, regardless of what assessment it’s a part of, then leave this field blank. This field is a relationship field. - **Relationship Name**: OmniProcess - **Refers To**: OmniProcess ### RecommendationReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The problem, goal, interventions, or assessment that a response to a question is mapped to. - **Relationship Name**: RecommendationReference - **Relationship Type**: Lookup - **Refers To**: - ActionPlanTemplateVersion - GoalDefinition - OmniProcess - ProblemDefinition ### TextResponse - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The response to a question that a recommendation is mapped to. This value must be under 255 characters. ## 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. [AsmtQstnRespRecommendationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AsmtQstnRespRecommendationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Assessment Details Output Contains metadata for the assessment record associated with a question response. ## Properties | Property Name | Type | Description | | --- | --- | --- | | asmtQstn​RespCreated​Date | Datetime | The date and time when the retrieved assessment question response was created. | | id | String | The unique ID of the assessment that contains the question. | | last​Modified​Date | Datetime | The date and time when the assessment record was last modified. | | name | String | The name of the assessment that contains the question. | # Assessment Generation Assessment Generation leverages Einstein generative AI capabilities to create assessment questions by efficiently extracting question details from complex source documents. This innovation, combined with the power of Discovery Framework, helps you to build comprehensive healthcare questionnaires that meet your business needs. Assessment Generation uses objects from the Discovery Framework data model. To learn more about the Discovery Framework objects, see [Discovery Framework Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/discovery_framework_standard_objects.htm). Make sure you have the Generative AI Assessment Questions user license to access the Assessment Generation related objects. - **[AssessmentQuestionSourceDoc](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_assessmentquestionsourcedoc.htm)** Represents assessment questions and their source document. This object is available in API version 61.0 and later. #### See Also - [_Salesforce Help_: Discovery Framework Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/discovery_framework_standard_objects.htm) # Assessment Previous Responses Retrieves historical assessment response data for healthcare applications, supporting both internal Discovery Framework and external Milliman Care Guidelines (MCG) assessments. ## Resource /connect/assessment/previousResponses ## Available Version 66.0 ## HTTP Methods POST ## Request Body for POST [Previous Assessment Responses Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_previous_assessment_responses_input.htm "The request representation to fetch past assessment responses for both Discovery Framework and MCG assessments.") ## Response Body for POST [Previous Assessment Responses Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_previous_assessment_responses_output.htm "The list of historical question responses retrieved for the specified assessment.") # Assessment Question Responses Document The response representation containing the ID of the generated ContentDocument. ## JSON example { "contentDocumentId": "069XX0000000001AAA" } ## Properties | Property Name | Type | Description | | --- | --- | --- | | contentDocumentId | String | The ID of the generated ContentDocument containing the assessment responses PDF. | # Assessment Question Responses Document (POST) Creates a PDF document containing assessment question responses and stores it as a ContentDocument. ## Resource /connect/health/assessments/assessment-question-responses-document ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "assessmentIds": \["0Ad9E000000abc1AAA", "0Ad9E000000abc2AAA"\], "includePreviousResponses": true } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | assessmentIds | String\[\] | The list of Assessment record IDs to include in the document. Supports internal Discovery Framework assessments and external assessments. | Required | | includePreviousResponses | Boolean | When true, includes previous assessment responses for the same assessment definition in the generated document. Defaults to false. | Optional | ## Response Body for POST [Assessment Question Responses Document](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_assessment_question_responses_document_output.htm "The response representation containing the ID of the generated ContentDocument.") # Assessment Question Responses Document Input The request payload containing assessment IDs and an optional flag to include previous responses. ## JSON example { "assessmentIds": \["0Ad9E000000abc1AAA", "0Ad9E000000abc2AAA"\], "includePreviousResponses": true } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | assessmentIds | String\[\] | The list of Assessment record IDs to include in the document. Supports internal Discovery Framework assessments and external assessments. | Required | | includePreviousResponses | Boolean | When true, includes previous assessment responses for the same assessment definition in the generated document. Defaults to false. | Optional | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # AssessmentQuestionSourceDoc Represents assessment questions and their source document. 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 ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The content document that's the source of the assessment questions. This field is a relationship field. - **Relationship Name**: ContentDocument - **Relationship Type**: Lookup - **Refers To**: ContentDocument ### ContentVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The content version associated with the content document that's the source of the assessment questions. This field is a relationship field. - **Relationship Name**: ContentVersion - **Relationship Type**: Lookup - **Refers To**: ContentVersion ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### QuestionCreationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies how the assessment questions are created from the source document. - **Possible values**: - GenAI ### QuestionReviewStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the review status of the assessment questions created from the source document. - **Possible values**: - Completed - InProgress - NotStarted # AssessmentTask Perform activities such as patient registration or order authorization to capture information. ## Special Access Rules In Health Cloud, this object is available in API version 46.0 and later. ## 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. In Health Cloud, this field is available in API version 58.0 and later. - **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. In Health Cloud, this field is available in API version 48.0 and later. - **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. In Health Cloud, this field is available in API version 48.0 and later. - **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. In Health Cloud, this field is available in API version 58.0 and later. - **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. In Health Cloud, this field is available in API version 48.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. In Health Cloud, this field is available in API version 48.0 and later. - **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. - **Possible values**: - ConductInStoreSurveys - InventoryCheck - Other - PlaceOrder - PlanogramCheck - PromotionCheck ## 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)") # Asset Search Criteria Input Criteria used to search for assets. ## JSON Example { "assetSearchCriteria": { "assetName": "MRI Scanner", "assetTypeIds": \[ "DI-001", "IM-005" \], "assetCategories": \[ "Diagnostic Imaging", "Large Equipment" \], "status": "Available", "productCode": "SIEMENS-MAGNETOM-S" } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | assetName | String | The name of the asset. | Optional | | assetTypeIds | Array of Strings | A list of IDs corresponding to the asset's types. | Optional | | assetCategories | Array of Strings | A list of the names of the asset's categories. | Optional | | status | String | The current status of the asset. | Optional | | productCode | String | The product code associated with the asset. | Optional | # Asset Search Result Detailed information about a single asset or resource matching the search criteria. ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | assetId | String | A unique identifier assigned to this specific asset or resource. | Optional | | assetName | String | The common name or description of the asset (e.g., "MRI Scanner", "Consultation Room A"). | Optional | | facilityId | String | A unique identifier for the facility where this asset is located. | Optional | | facilityName | String | The name of the facility or clinic where this asset can be found. | Optional | | facilityAddress | [Address Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_address_output_representation.htm "The detailed address information for a facility or resource in the response.") | The physical address of the facility where the asset is located. | Optional | | facilityPhone | String | The main contact phone number for the facility where the asset is located. | Optional | | assetTypeIds | Array of Strings | A list of unique identifiers for the categories or types this asset belongs to. | Optional | | assetCategories | Array of Strings | A list of broader classifications or groups this asset falls under (e.g., "Diagnostic Imaging", "Surgical Equipment"). | Optional | | status | String | The current operational status of the asset (e.g., "Available", "In Use", "Maintenance"). | Optional | | statusReason | String | A brief explanation or reason for the asset's current status. | Optional | | productCode | String | The manufacturer's product code or model identifier for the asset. | Optional | | additionalDetails | Object | A flexible object containing any extra key-value pair details about the asset. | Optional | # AssetType Represents a type of asset, such as a type of item, physical space, or service offering. 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 To access this object, you must have the Health Cloud Appointment Management permission set. ## Fields ### Category - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category of the asset type. - **Default value**: Device - **Possible values**: - Device - HealthcareServiceHealthcare Service - Location ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the asset type. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Required. Indicates whether the asset type is active (true) or not (false). - **Default value**: false ### IsAvailableToSchedule - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the use of assets associated with the asset type can be scheduled (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**: Required. The name of the asset type 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 ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent asset type associated with the record. Use a parent record to define a relationship between an asset type and an asset subtype. This field is a relationship field. - **Relationship Name**: Parent - **Refers To**: AssetType ## 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. [AssetTypeHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AssetTypeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [AssetTypeShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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 | # Attribute Represents an extracted field-level attribute within a Document AI node, including its value, metadata, confidence score, and potential matching information. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[Attribute Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_properties.htm)** The following are properties for attribute. # Attribute Properties The following are properties for attribute. - **[attributeName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_attributeName.htm)** The standardized or canonical name used to identify this attribute within the extraction context. - **[confidenceScore](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_confidenceScore.htm)** The confidence score assigned by the extraction model for this field value. - **[fieldApiName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_fieldApiName.htm)** The API name of the field to which the extracted value corresponds. - **[fieldType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_fieldType.htm)** The data type of the field (for example, String, Date, Number). - **[isExistingParentReferenced](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_isExistingParentReferenced.htm)** Indicates whether the attribute refers to an already existing parent record in the system. - **[matchingRecords](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_matchingRecords.htm)** The list of potential matching records for this identified attribute during duplicate detection or matching. - **[parentReferenceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_parentReferenceId.htm)** The reference identifier of the parent node associated with this attribute. - **[value](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute_value.htm)** The extracted value for the field. # attributeName The standardized or canonical name used to identify this attribute within the extraction context. ## Signature public String attributeName {get; set;} ## Property Value Type: String # attributes The list of extracted field attributes associated with this node. ## Signature public List attributes {get; set;} ## Property Value Type: List # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # BatchProcessor This is schedule apex used to schedule the batch job for batch document ai. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") # BatchProcessor for Apex Reference Schedule Apex used to schedule the batch job for document processing. This class is documented in the DocumentAI namespace. See [BatchProcessor](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_batch_processor.htm "This is schedule apex used to schedule the batch job for batch document ai."). # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_benefits_verification_response.htm)** This is the content of the response from a Verify Benefits API call. # Benefits Verification The benefits verification data model supports providers, payers, and life sciences organizations in determining benefits coverage for services and products provided.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud
The benefits verification objects are available to users with the Health Cloud and the Health Cloud Platform permission set licenses and the Health Foundation permission set. Available in API version 53.0 and later. ![Benefit verification entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/benefit_verification_erd.png) - **[CareBenefitVerifyRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carebenefitverifyrequest.htm)** Request for verification of benefits. This object is available in API version 53.0 and later. - **[CoverageBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefit.htm)** Represents the benefits provided to a covered member by a purchaser’s plan. - **[CoverageBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititem.htm)** Specific service covered by the insurance plan. This object is available in API version 53.0 and later. - **[CoverageBenefitItemLimit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititemlimit.htm)** 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. - **[MemberPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_memberplan_bv.htm)** Represents details about the insurance coverage for a member or subscriber. - **[PurchaserPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplan_bv.htm)** Represents the payer plan that a purchaser makes available to its members and members’ dependents. #### See Also - [Health Cloud Administration Guide: Connect to a Benefit Verification Service](https://help.salesforce.com/articleView?id=ind.admin_benefit_verification_setup.htm&type=5&language=en_US) - [HealthCloudExt Namespace for Benefit Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext_benefit_verification.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_benefits_verification_output.htm "This is the content of the output from running the Verify Benefits API call.") # BenefitsItem Class Specific service covered by the insurance plan. ## Namespace [HealthCloudExt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[BenefitsItem Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_properties)** ## BenefitsItem Properties The following are properties for BenefitsItem. - **[benefitsCategory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_benefitsCategory)** Name of the category this benefit is in. - **[benefitsItemLimit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_benefitsItemLimit)** - **[inPlanNetworkIndicator](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_inPlanNetworkIndicator)** Indicates whether the benefit is available only in-network (true) or both in-network and out-of-network (false). The default value is 'false'. - **[notes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_notes)** Description of the coverage for non-preferred providers. - **[serviceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_serviceType)** The type of service this plan benefit item provides. - **[serviceTypeCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_healthcloudext_BenefitsItem_serviceTypeCode)** The code for the type of service this plan benefit item provides. ### benefitsCategory Name of the category this benefit is in. #### Signature public String benefitsCategory {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### benefitsItemLimit #### Signature public List benefitsItemLimit {get; set;} #### Property Value Type: List ### inPlanNetworkIndicator Indicates whether the benefit is available only in-network (true) or both in-network and out-of-network (false). The default value is 'false'. #### Signature public Boolean inPlanNetworkIndicator {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### notes Description of the coverage for non-preferred providers. #### Signature public String notes {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceType The type of service this plan benefit item provides. #### Signature public String serviceType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceTypeCode The code for the type of service this plan benefit item provides. #### Signature public String serviceTypeCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # BenefitsItemLimit Class Services not covered, or expenditures required for coverage. ## Namespace [HealthCloudExt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[BenefitsItemLimit Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_properties)** ## BenefitsItemLimit Properties The following are properties for BenefitsItemLimit. - **[benefitCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_benefitCode)** - **[benefitMetricType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_benefitMetricType)** - **[benefitValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_benefitValue)** - **[coverageLevel](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_coverageLevel)** Defines the persons eligible for the benefit item. Possible values are EmployeeSpouse, Family, Individual. - **[limitNotes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_limitNotes)** General information about the limit. - **[networkType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_networkType)** Specifies whether the benefit refers to in-network providers or out-of-network providers. - **[termType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_healthcloudext_BenefitsItemLimit_termType)** Specifies the type of time period during which the benefit item is available. Possible values are Calendar Year, Day, Month, Year to Date. To save the benefitValue in the AllowedLimitfield, set the termType to a value other than Remaining. ### benefitCode #### Signature public String benefitCode {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### benefitMetricType #### Signature public String benefitMetricType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### benefitValue #### Signature public String benefitValue {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### coverageLevel Defines the persons eligible for the benefit item. Possible values are EmployeeSpouse, Family, Individual. #### Signature public String coverageLevel {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### limitNotes General information about the limit. #### Signature public String limitNotes {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### networkType Specifies whether the benefit refers to in-network providers or out-of-network providers. Possible values are: - In—In-network providers - NA—Not applicable - Out—Out-of-network providers #### Signature public String networkType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### termType Specifies the type of time period during which the benefit item is available. Possible values are Calendar Year, Day, Month, Year to Date. To save the benefitValue in the AllowedLimitfield, set the termType to a value other than Remaining. #### Signature public String termType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # BenefitsVerificationRequest Class Request for verification of benefits. ## Namespace [HealthCloudExt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[BenefitsVerificationRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_properties)** ## BenefitsVerificationRequest Properties The following are properties for BenefitsVerificationRequest. - **[benefitsRequestId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_benefitsRequestId)** Identifies the associated case. - **[encounterDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_encounterDate)** - **[groupNumber](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_groupNumber)** - **[memberAccountId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_memberAccountId)** - **[memberNumber](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_memberNumber)** - **[payerId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_payerId)** - **[providerNpi](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_providerNpi)** Default National Provider Identifier to be used in the benefits verification request. - **[providerOrganizationName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_providerOrganizationName)** Specifies the organization name to use for the benefits verification request service. - **[providerType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_providerType)** - **[serviceTypeCodes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_healthcloudext_BenefitsVerificationRequest_serviceTypeCodes)** Represents the code of the service type to be performed. ### benefitsRequestId Identifies the associated case. #### Signature public String benefitsRequestId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### encounterDate #### Signature public String encounterDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### groupNumber #### Signature public String groupNumber {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### memberAccountId #### Signature public String memberAccountId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### memberNumber #### Signature public String memberNumber {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### payerId #### Signature public String payerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### providerNpi Default National Provider Identifier to be used in the benefits verification request. #### Signature public String providerNpi {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### providerOrganizationName Specifies the organization name to use for the benefits verification request service. #### Signature public String providerOrganizationName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### providerType #### Signature public String providerType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceTypeCodes Represents the code of the service type to be performed. #### Signature public List serviceTypeCodes {get; set;} #### Property Value Type: List # BenefitsVerificationResponse Class Response for verification of benefits. ## Namespace [HealthCloudExt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[BenefitsVerificationResponse Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_properties)** ## BenefitsVerificationResponse Properties The following are properties for BenefitsVerificationResponse. - **[benefitPeriodEndDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_benefitPeriodEndDate)** Last day of the coverage benefit period. - **[benefitPeriodStartDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_benefitPeriodStartDate)** First day of the coverage benefit period. - **[benefitsItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_benefitsItem)** Specific service covered by the insurance plan. - **[benefitsRequestId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_benefitsRequestId)** Identifies the benefit verification request that this message responds to. - **[errorResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_errorResponse)** Use to respond with an error indication following errors such as request-forbidden responses, custom validation errors, or expired API tokens. - **[groupNumber](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_groupNumber)** - **[isCoverageActive](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_isCoverageActive)** Indicates whether the coverage benefit is currently in force. - **[jsonResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_jsonResponse)** Full JSON response from external system. - **[memberNumber](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_healthcloudext_BenefitsVerificationResponse_memberNumber)** ### benefitPeriodEndDate Last day of the coverage benefit period. #### Signature public String benefitPeriodEndDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### benefitPeriodStartDate First day of the coverage benefit period. #### Signature public String benefitPeriodStartDate {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### benefitsItem Specific service covered by the insurance plan. #### Signature public List benefitsItem {get; set;} #### Property Value Type: List ### benefitsRequestId Identifies the benefit verification request that this message responds to. #### Signature public String benefitsRequestId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### errorResponse Use to respond with an error indication following errors such as request-forbidden responses, custom validation errors, or expired API tokens. #### Signature public String errorResponse {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### groupNumber #### Signature public String groupNumber {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### isCoverageActive Indicates whether the coverage benefit is currently in force. #### Signature public Boolean isCoverageActive {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### jsonResponse Full JSON response from external system. #### Signature public String jsonResponse {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### memberNumber #### Signature public String memberNumber {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Appointment (POST) Create or book a health appointment. ## Resource /connect/health/appointment-management/appointment ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/appointment ## HTTP Methods POST ## Request Body for POST LS { "startDate": "2013-12-10T09:00:00Z", "endDate": "2013-12-10T11:00:00Z", "workTypeId": "", "channelId": "", "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.", "participants": \[ { "reference": "Patient/" }, { "reference": "Facility/" }, { "reference": "Practitioner/", "isReferenceRequired": true } \] } ## Request Body for POST (EHR - External System, Like Cerner, Epic and Others) { "startDate": "2013-12-10T09:00:00Z", "endDate": "2013-12-10T11:00:00Z", "workTypeId": "", "channelId": "", "sourceSystem": "cerner", "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.", "appointmentTypes": \[ "FOLLOWUP" \], "serviceCategories": \[ "serviceCategoryCode1", "serviceCategoryCode2" \], "serviceTypes": \[ "serviceTypeCode1", "serviceTypeCode2" \], "specialties": \[ "specialityCode" \], "slots": \[ { "id": "24477854-21304876-62852027-2", "reference": "" - matches with the reference of practitioner within participants } \], "participants": \[ { "reference": "Patient/" }, { "reference": "Facility/" }, { "reference": "Practitioner/", "isReferenceRequired": true } \] } ## Request Parameters for POST
Parameter Name Type Description Required or Optional Available Version
appointment​Types Array Type of the appointment. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • serviceCategories
 65.0
channel​Id String Engagement channel associated with the work type. Required 65.0
comment​ String Additional text to aid in facilitating the appointment. Optional 65.0
endDate String End date and time for the slots range. Required 65.0
participants Array List of participants involved in the appointment. Patient and Facility are required. For single resource appointment, include either a Device (asset) or Provider or both for multi-resource appointment. Required 65.0
service​Categories Array List of broad categorizations of the service. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • appointmentType
 65.0
service​Types Array List of specific services to be performed. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • appointmentType
  • serviceCategories
 65.0
slots Array List of references to the slots the appointment is filling. Required, if the appointment is for an external resource. 65.0
source​System String Source system associated with the appointment type, service type or service category. Required, if workTypeId is not provided but either appointmentType, serviceTypes, or serviceCategories is. 65.0
specialties Array List of the specialties of a practitioner required for the service. Optional 65.0
start​Date String Start date and time for the slots range. Required 65.0
timeZone String Timezone in which the appointment is updated. Optional 65.0
workType​Id String Work type associated with the resource. Required 65.0
## Response Body for POST [Book Appointment Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_appointment_management.htm "Output representation for appointment management.") # Book Appointment Action Create or book a new appointment. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/connect/health/appointment-management/appointment Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: POST **Authentication**: Authorization: OAuth2 Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
appointmentTypes Array Required, if none of workTypeId, serviceTypes, or serviceCategories is provided.

Type of appointment, for example, Follow-up.
channelId String Required, if an engagement channel is configured for a visit type.

The engagement channel associated with the appointment.
comment String Optional

The notes associated with the appointment. Maximum length is 256 characters.
description String Optional

The description of the appointment.
endDate String Optional

The end time of the appointment.
participants Array Required. Patient and Facility (Location) are mandatory. Additionally, either a Device (asset) or a Provider is required for a single resource appointment, and both are required for a multi-resource appointment.

List of participants involved in the appointment.
serviceCategories Array Required, if none of workTypeId, serviceTypes, or appointmentTypes is provided.

List of broad categorizations of the service to be performed during this appointment.
serviceTypes Array Required, if none of workTypeId, appointmentTypes, or serviceCategories is provided.

List of specific services that are to be performed during this appointment.
slots Array Required, if the appointment is being booked for an external resource.

List of references to the slots that this appointment is filling.
sourceSystem String Required, if workTypeId is not provided but one of appointmentTypes, serviceTypes, or serviceCategories is provided.

Describes the external system defined in Salesforce, such as "cerner".
specialties Array Optional

List of the specialty of a practitioner that would be required to perform the service requested in this appointment.
startDate String Required

The start time of the appointment.
timeZone String Optional

Creates the appointment in the specified time zone.
workTypeId String Required, if none of appointmentTypes, serviceTypes, or serviceCategories is provided.

The visit type associated with the appointment.
## Outputs | Output | Type | Description | | --- | --- | --- | | id | String | The ID of the Appointment. | | isSuccess | Boolean | Indicates whether the appointment was created successfully. | | status | String | The status of the Appointment, such as Scheduled or Rejected. | | errorMessages | Array | A list of errors that occurred, if any. | ## Example Sample Request { "workTypeId": "08qxxG000000Axq6xxC", "channelId": "0eFxx000000NNOVxx0", "description": "Discussion", "startDate": "2025-07-21T18:00:00.000Z", "endDate": "2025-07-21T18:30:00.000Z", "comment": "Payload for the testing", "participants": \[ { "reference": "Patient/001xx000012udqQxxQ" }, { "reference": "Practitioner/0bSxx0000005JoaxxE", "isReferenceRequired": true }, { "reference": "Facility/001xx000012udqhxxA" } \] } Sample Response \[ { "id": "08pxx000000Axq6xxC", "isSuccess": true, "status": "scheduled", "error": \[\] } \] # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # BookAppointmentRequest Class Contains set of options to book a healthcare appointment. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") ## Usage To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system. Practitioner and Facility IDs: - The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination. - The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the same source system as the Healthcare Practitioner Facility record. - The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same source system as the Healthcare Practitioner Facility record. The source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selected by the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to Code Set Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with. - **[BookAppointmentRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_properties)** ## BookAppointmentRequest Properties The following are properties for BookAppointmentRequest. - **[appointmentType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_appointmentType)** Represents the type of appointment, such as annual physical or intake examination. - **[note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_note)** Represents optional extra information about the appointment. - **[serviceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_serviceType)** Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery. - **[slot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_slot)** Represents the time period slot that’s assigned to the appointment. - **[sourceFacilityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_sourceFacilityId)** Represents the ID in the source system of the facility where the encounter will occur. - **[sourcePatientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_sourcePatientId)** Represents the ID in the source system of the patient. - **[sourcePractitionerId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_sourcePractitionerId)** Represents the ID in the source system of the practitioner with whom the encounter will occur. - **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_healthcloudext_BookAppointmentRequest_sourceSystem)** Represents the name of the source system the patient record came from. ### appointmentType Represents the type of appointment, such as annual physical or intake examination. #### Signature public String appointmentType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### note Represents optional extra information about the appointment. #### Signature public String note {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceType Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery. #### Signature public String serviceType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slot Represents the time period slot that’s assigned to the appointment. #### Signature public String slot {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceFacilityId Represents the ID in the source system of the facility where the encounter will occur. #### Signature public String sourceFacilityId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePatientId Represents the ID in the source system of the patient. #### Signature public String sourcePatientId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePractitionerId Represents the ID in the source system of the practitioner with whom the encounter will occur. #### Signature public String sourcePractitionerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceSystem Represents the name of the source system the patient record came from. #### Signature public String sourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # BookAppointmentResponse Class Represents the appointment booking details from the external scheduling system. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[BookAppointmentResponse Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_properties)** ## BookAppointmentResponse Properties The following are properties for BookAppointmentResponse. - **[appointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_appointmentId)** Represents the unique identifier of the appointment in Health Cloud. - **[jsonResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_jsonResponse)** Represents the response from the external scheduling system encoded as JSON. - **[note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_note)** Represents optional extra information added to the appointment. - **[patientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_patientId)** Represents the unique identifier of the patient in Health Cloud. - **[slotEnd](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_slotEnd)** Represents the date and time that the available time slot ends. - **[slotStart](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_slotStart)** Represents the date and time that the available time slot starts. - **[sourceAppointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourceAppointmentId)** Represents the unique identifier of the appointment in the source system. - **[sourcePatientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourcePatientId)** Represents the ID of the patient in the source system. - **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_sourceSystem)** Represents the name of the external scheduling system from which the record was sourced. - **[status](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_healthcloudext_BookAppointmentResponse_status)** Represents the status of the appointment. ### appointmentId Represents the unique identifier of the appointment in Health Cloud. #### Signature public String appointmentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### jsonResponse Represents the response from the external scheduling system encoded as JSON. #### Signature public String jsonResponse {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### note Represents optional extra information added to the appointment. #### Signature public String note {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### patientId Represents the unique identifier of the patient in Health Cloud. #### Signature public String patientId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotEnd Represents the date and time that the available time slot ends. #### Signature public String slotEnd {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotStart Represents the date and time that the available time slot starts. #### Signature public String slotStart {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceAppointmentId Represents the unique identifier of the appointment in the source system. #### Signature public String sourceAppointmentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePatientId Represents the ID of the patient in the source system. #### Signature public String sourcePatientId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceSystem Represents the name of the external scheduling system from which the record was sourced. #### Signature public String sourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### status Represents the status of the appointment. #### Signature public healthcloudext.BookingStatus status {get; set;} #### Property Value Type: [healthcloudext.BookingStatus](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_enum_healthcloudext_BookingStatus.htm "Represents a possible status of a healthcare appointment.") # BookingStatus Enum Represents a possible status of a healthcare appointment. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") ## Enum Values The following are the values of the healthcloudext.BookingStatus enum. | Value | Description | | --- | --- | | Canceled | Indicates that a scheduled appointment has been canceled. | | NoShow | Indicates that a patient didn’t show up for a scheduled appointment. | | Proposed | Indicates that a new date and time has been proposed for a scheduled appointment. | | Rejected | Indicates that a scheduled appointment has been rejected. | | Scheduled | Indicates that an appointment has been scheduled. | # Build Eligibility and Benefit Verification (EBV) Request Action Builds the request payload to initiate the eligibility and benefits verification process. This action is categorized under Health Cloud and is used to construct the FHIR-compliant request payload required to verify patient eligibility and insurance benefits. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/buildEvbRequest 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
callbackExtensionUrl String The FHIR extension type URL. Defaults to https://infinitus.ai/fhir/callback-url if null or empty.
callbackUrl String The callback URL value to use for asynchronous responses. The extension is omitted if this value is null or empty.
csrId ID Required

The clinical service request record ID for this eligibility and benefits verification run.
memberPlanId ID Required

The member plan ID for the eligibility request.
requestType String Indicates which payload to build.
## Outputs | Output | Type | Description | | --- | --- | --- | | apiPath | String | The API path to use with the Invoke Generic FHIR Client. | | requestPayload | String | The FHIR Coverage Eligibility Request payload to send to the Invoke Generic FHIR Client. | # Build Identity Verification Context Build the context required to perform identity verification. ## Resource /connect/identity-verification/build-context/${processDefinitionName} ## Example URI Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org, and replace {vXX.X} with the API version, including the leading v. https://{yourInstance.salesforce.com}/services/data/{vXX.X} /connect/identity-verification/build-context/SampleVerificationFlow ## Available Version 54.0 ## Requires Chatter No ## HTTP Methods POST ## 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 | ## Response Body for POST [Verification Context Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_verification_context_output.htm "Represents the Verification Context resource output.") ## JSON Example { "isSuccess" : true, "message" : "Build Context for Identity Verification API called successfully for Process Definition: SampleVerificationFlow", "processDefinition" : { "layoutType" : "Tab", "processDetail" : \[ { "dataSourceType" : "Salesforce", "optionalVerifierCount" : 1, "searchObjectName" : "Account", "searchResultUniqueIdField" : "Id", "searchSequenceNo" : 1, "searchType" : "Text-Based", "verificationProcessFieldList" : { "verificationProcessFields" : \[ { "dataSourceType" : "Salesforce", "dataType" : "Name", "developerName" : "SampleAccountName", "fieldName" : "Name", "fieldType" : "optionalVerifier", "label" : "Account Name" }, { "dataSourceType" : "Salesforce", "dataType" : "Text", "developerName" : "SampleAccountNumber", "fieldName" : "AccountNumber", "fieldType" : "optionalVerifier", "label" : "Account Number" }, { "dataSourceType" : "Salesforce", "dataType" : "Phone", "developerName" : "SamplePhone", "fieldName" : "Phone", "fieldType" : "optionalVerifier", "label" : "Phone" }, { "dataSourceType" : "Salesforce", "dataType" : "Text", "developerName" : "SamplePostalCode", "fieldName" : "BillingPostalCode", "fieldType" : "optionalVerifier", "label" : "Billing Zip/Postal Code" }, { "dataSourceType" : "Salesforce", "dataType" : "Name", "developerName" : "SampleAccount", "fieldName" : "Name", "fieldType" : "resultField", "label" : "Account Name" }, { "dataSourceType" : "Salesforce", "dataType" : "Text", "developerName" : "AccountNumberSample", "fieldName" : "AccountNumber", "fieldType" : "resultField", "label" : "Account Number" }, { "dataSourceType" : "Salesforce", "dataType" : "Phone", "developerName" : "SamplePhoneNumber", "fieldName" : "Phone", "fieldType" : "resultField", "label" : "Phone" } \] } } \] }, "selectedSearchResult" : { "selectedRecordObject" : \[ \] }, "verifiedResult" : { "optionalVerifiers" : \[ \], "requiredVerifiers" : \[ \] } } # 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 | # BundledCareFeeAgreement Specifies the payment terms for contracts of Bundled Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BasicTierPrice - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The basic tier price for the procedure bundle. ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this bundled care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### 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. ### MidTierPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The mid tier price for the procedure bundle. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the bundled care fee agreement. ### PremiumTierPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The premium tier price for the procedure bundle. ### ProcedureBundleCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code of the bundle including a set of procedures. This is a relationship field. - **Relationship Name**: ProcedureBundleCode - **Relationship Type**: Lookup - **Refers To**: CodeSetBundle ### ProcedureBundleDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the procedure bundle. ### ProcedureBundleItemList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The list of procedures covered in the 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. [BundledCareFeeAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [BundledCareFeeAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [BundledCareFeeAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # BusinessLicense Represents the licenses of a party role like healthcare provider or producer. ## Special Access Rules In Health Cloud, this object is available in API version 46.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 ### 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 ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the license. ### 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 ### 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 ### LicenseClass - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The class that the distributor’s license belongs to. In Health Cloud, this field is available from API version 48.0 and later. - **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. ### 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. ### SourceSystemUpdateDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the date when the record was last updated in the source system. ### 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. # Cancel Appointment - **Type**: Controller - **Verb**: POST - **Default URL Path** for Single-Source System: /Appointment/{sourceAppointmentId} - **Default URL Path** for Multi-Source System:\* /Appointment/{sourceSystem}/{sourceAppointmentId} Where: - sourceSystem identifies the source system. - sourceAppointmentId is the ID of an appointment in the source system. Your Base URL is configured in Setup > Appointment Scheduling. All communications with the external system use the FHIR R4 standard. ## Request Body { "resourceType": "Appointment", "id": "1839594", "status": "cancelled", "cancelationReason" : { "coding" : \[ { "system" : "http://terminology.hl7.org/CodeSystem/appointment-cancellation-reason", "code" : "pat-mv" } \] } } ## Response Codes - 200: Success - 401: Unauthorized - 404: Appointment not found - 5xx: Server error To map slots, resourceType, id, identifier, serviceType, appointmentType, slot, participant, actor, and status are required in the FHIR response. { "resourceType" : "Appointment", "id" : "" "identifier" : \[{ Identifier }\], //Source system identifier mandatory in the response if there are multiple source systems "cancelationReason" : { CodeableConcept }, "serviceCategory" : \[{ CodeableConcept }\], "serviceType" : \[{ CodeableConcept }\], "specialty" : \[{ CodeableConcept }\], "appointmentType" : { CodeableConcept }, "reasonCode" : \[{ CodeableConcept }\], "reasonReference" : \[{ Reference(Condition|Procedure|Observation|ImmunizationRecommendation) }\], "priority" : "", "description" : "", "supportingInformation" : \[{ Reference(Any) }\], "start" : "",// start of the appointment - ISO 8601 format "end" : "",// end of the appointment - ISO 8601 format "minutesDuration" : "", "slot" : \[{ Reference(Slot) }\], "created" : "", "comment" : "", "patientInstruction" : "", "basedOn" : \[{ Reference(ServiceRequest) }\], "participant" : \[{"type" : \[{ CodeableConcept }\],//Patient EHR id "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson | Device|HealthcareService|Location) }, //Practitioner EHR id "required" : "", "status" : "", // Mandatory in the response "period" : { Period }}\], "requestedPeriod" : \[{ Period } \] } ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note "Cancelation" is spelled with one L, per the FHIR R4 specification. The valid values for status are: - proposed - pending - booked - arrived - fulfilled - cancelled - noshow - entered-in-error - checked-in - waitlist If the request cannot be processed for any reason (e.g. it’s unsupported, there’s a timeout, etc.) status is returned as proposed. #### See Also - [FHIR Resource: Appointment](https://www.hl7.org/fhir/Appointment.html) # Cancel Appointment (PATCH) Cancel a health appointment. ## Resource /connect/health/appointment-management/​appointment/​{appointmentId} ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/​appointment/​08pxx0000004KxxAAE ## HTTP Methods PATCH ## Request Body for PATCH { "id": "08pxx0000004KhxxAE", "status": "canceled" } ## Request Parameters for PATCH | Parameter Name | Type | Description | Required or Optional | Available version | | --- | --- | --- | --- | --- | | id | String | ID of the appointment to cancel. | Required | 65.0 | | status | String | Status to set the appointment to, ​as configured in Salesforce appointment statuses. | Required | 65.0 | ## Response Body for PATCH [Cancel Appointment Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_appointment_management.htm "Output representation for appointment management.") # Cancel Appointment Action Cancel an existing appointment. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/connect/health/appointment-management/appointment/{id} Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: PATCH **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
cancellationReason String Reason for the cancellation.
comment String Additional notes or comments for the cancellation.
id String Required

Unique identifier of the appointment to update. This is part of the request URL.
status String Required

New status for the appointment. Must be a valid cancellation status such as Cancelled.

## Outputs | Output | Type | Description | | --- | --- | --- | | errorMessages | Array | A list of errors, if any occurred. | | id | String | The id of the Appointment. | | isSuccess | Boolean | Indicates whether the appointment was cancelled successfully or not. | | status | String | The status of the Appointment, like Scheduled, Rejected. | ## Usage **PATCH** This sample request is for the Cancel Appointment action. { "id": "08xxG000000Axx6YAC", "status": "Cancelled", "cancellationReason": "Patient requested cancellation.", "comment": "Patient will call back to reschedule." } This sample response is for the Cancel Appointment action. { "id": "08pxx000000Axx6YAC", "isSuccess": true, "status": "Cancelled", "errorMessages": \[\] } # CancelAppointmentRequest Class Contains set of options to cancel the booked appointment. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[CancelAppointmentRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_properties)** ## CancelAppointmentRequest Properties The following are properties for CancelAppointmentRequest. - **[appointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_appointmentId)** Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object. - **[appointmentType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_appointmentType)** Represents the type of appointment, such as annual physical or intake examination. - **[cancelationReason](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_cancelationReason)** Represents the reason for canceling the appointment. - **[serviceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_serviceType)** Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery. - **[slot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_slot)** Represents the time period slot that’s assigned to the appointment. - **[sourceFacilityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourceFacilityId)** Represents the healthcare facility where the encounter will occur in the external scheduling system. - **[sourcePatientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourcePatientId)** Represents the ID of the patient in the external scheduling system. - **[sourcePractitionerId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourcePractitionerId)** ID of the practitioner who is performing care in the encounter. - **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_healthcloudext_CancelAppointmentRequest_sourceSystem)** Name of the external scheduling system from which the record was sourced. ### appointmentId Unique ID of the appointment in Health Cloud. The appointment ID comes from the ServiceAppointment object. #### Signature public String appointmentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### appointmentType Represents the type of appointment, such as annual physical or intake examination. #### Signature public String appointmentType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### cancelationReason Represents the reason for canceling the appointment. #### Signature public String cancelationReason {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceType Specifies the type of service to be performed at the appointment, such as dental cleaning or surgery. #### Signature public String serviceType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slot Represents the time period slot that’s assigned to the appointment. #### Signature public String slot {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceFacilityId Represents the healthcare facility where the encounter will occur in the external scheduling system. #### Signature public String sourceFacilityId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePatientId Represents the ID of the patient in the external scheduling system. #### Signature public String sourcePatientId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourcePractitionerId ID of the practitioner who is performing care in the encounter. #### Signature public String sourcePractitionerId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceSystem Name of the external scheduling system from which the record was sourced. #### Signature public String sourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # CancelAppointmentResponse Class Represents the appointment cancellation details from the external scheduling system. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[CancelAppointmentResponse Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_healthcloudext_CancelAppointmentResponse_properties)** ## CancelAppointmentResponse Properties The following are properties for CancelAppointmentResponse. - **[externalAppointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_healthcloudext_CancelAppointmentResponse_externalAppointmentId)** Represents the appointment identifier from the external scheduling system. - **[jsonResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_healthcloudext_CancelAppointmentResponse_jsonResponse)** Represents the response from the external scheduling system encoded as JSON. - **[serviceAppointmentId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_healthcloudext_CancelAppointmentResponse_serviceAppointmentId)** Represents the ID of the service appointment that you want to update. - **[status](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_healthcloudext_CancelAppointmentResponse_status)** Represents the status of the healthcare appointment. ### externalAppointmentId Represents the appointment identifier from the external scheduling system. #### Signature public String externalAppointmentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### jsonResponse Represents the response from the external scheduling system encoded as JSON. #### Signature public String jsonResponse {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceAppointmentId Represents the ID of the service appointment that you want to update. #### Signature public String serviceAppointmentId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### status Represents the status of the healthcare appointment. #### Signature public healthcloudext.BookingStatus status {get; set;} #### Property Value Type: [healthcloudext.BookingStatus](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_enum_healthcloudext_BookingStatus.htm "Represents a possible status of a healthcare appointment.") # CapitationCareFeeAgreement Specifies the payment terms for contracts of Capitation Care Fee Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this capitation care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### 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. ### MemberAgeRangeLowerLimit - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The lower age limit of the enrolled member for the capitation care fee agreement. ### MemberAgeRangeUpperLimit - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The upper age limit of the enrolled member for the capitation care fee agreement. ### MonthlyBalanceFee - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The balance fee for each member after the monthly withheld fee. This is a calculated field. ### MonthlyFee - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The fee agreed upon by the provider and payer for each member per month. ### MonthlyWithheldPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the monthly fee that's withheld by the payer and shared later with the provider based on the performance. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the capitation care fee agreement. ## 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. [CapitationCareFeeAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CapitationCareFeeAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CapitationCareFeeAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Captcha Token Input Input representation of a Google captcha verification token. ## Properties
Name Type Description Required or Optional Available Version
siteKeyDeveloperName String Registered Salesforce key pair name. Required 60.0
token String Captcha token to verify. Required 60.0
type String Captcha token type. Possible values are:
  • HCaptcha
  • ReCaptcha
 Required 60.0
# 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_enroll-pantients.htm)** Enroll multiple patients into a care program. #### See Also - [Care Program Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.") - [Enrollments](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_enroll-pantients.htm "Enroll multiple patients into a care program.") - [CareSystemFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caresystemfieldmapping.htm "Represents a mapping from source system fields to Salesforce target entities and attributes.") - [_Salesforce Help_: Map External Program Fields to Health Cloud](https://help.salesforce.com/articleView?id=admin_config_care_system_field_mappings&language=en_US "Salesforce Help: Map External Program Fields to Health Cloud - HTML (New Window)") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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). - **[CarePgmProvHealthcareProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carepgmprovhealthcareprovider.htm)** 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. - **[CareProgram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogram.htm)** 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. - **[CareProgramCampaign](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramcampaign.htm)** 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. - **[CareProgramEligibilityRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogrameligibilityrule.htm)** 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. - **[CareProgramEnrollee](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrollee.htm)** Represents a participant enrolled in a care program. - **[CareProgramEnrolleeProduct](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrolleeproduct.htm)** Represents the affiliation between a care program enrollee and a care program product, a care program provider, or both. - **[CareProgramEnrollmentCard](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrollmentcard.htm)** Represents a care program membership card that includes a membership number or enrollment code. - **[CareProgramGoal](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramgoal.htm)** Represents a business or clinical goal related to a care program. - **[CareProgramProduct](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramproduct.htm)** Represents the affiliation between a care program and a care program product, care program provider, or both. - **[CareProgramProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramprovider.htm)** Represents a business account that is the service provider for a care program product. - **[CareProgramTeamMember](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramteammember.htm)** Represents a person who delivers services under a program, such as a program manager or care coordinator. - **[CareRegisteredDevice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careregistereddevice.htm)** 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. - **[CareSystemFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caresystemfieldmapping.htm)** Represents a mapping from source system fields to Salesforce target entities and attributes. - **[EnrollmentEligibilityCriteria](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_enrollmenteligibilitycriteria.htm)** Represents criteria that define patient enrollment eligibility for one or more care programs. #### See Also - [Care Program Enrollments (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_careprogram_enrollment_intro.htm "Use this API to enroll multiple patients in a care program.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 # Care Requests Update List Input A list of care authorization requests to update. ## Root XML tag ## 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", "requestType": "Order", "priority": "Stat", "reasonCode": "0hsRM00000003ytYAA", "servicingFacility": { "npi": "742963", "servicingFacilityId": "0klRM0000004CBnYAM" }, "servicingProvider": { "npi": "11111", "healthCareProviderId": "0cmRM0000000tldYAA" }, "clinicalServiceRequestId": "0jyRM0000004CAGYA2" } \], "careDiagnoses": \[ { "name": "CD Connect 1.0", "presentOnAdmission": "Yes", "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" } } \], "patient": { "memberId": "001RM000005XHdbYAG", "lastName": "Green", "firstName": "Charles", "birthDate": "2001-10-26T21:32:52" } } \] } ## Properties | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | careRequestsList | [Care Authorization Request Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # Care Services Review and Response These RESTful APIs support data elements required for ANSI X12 278 format Health Care Services Review and Response. Also referred to as ANSI 278 Authorization APIs, they enable payer organizations to electronically receive prior authorization requests and referral requests from providers. Other users of these APIs can be healthcare providers, payers, plan sponsors, or other entities involved in health care services review, such as clearinghouses.
User Permissions Needed
To access care services APIs Health Cloud Utilization Management Permission Set
These APIs facilitate communication between two parties for the following cases: - Appeals - Drug Requests - Admissions - Healthcare Service Requests - Referrals - Complaints - Grievances [Care Services Review Requests (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_care_services_review.htm#connect_resources_create_update_care_services_review "Update care services review requests or update existing requests.") Depending on the type of care service review request (drug request, prior authorization, and so on), and the content of the request body, this API creates one or more records for Case, CareRequest, CareRequestExtension, CareRequestDrug, CareRequestItem, or CareRequestDiagnosis.. The following diagram shows what happens when you make a POST request to this API, to create a care services review request. ![Diagram explaining what happens when a care services review request is triggered.](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_care_services_diagram.png) [Care Services Review Requests (GET)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_care_services_review.htm#connect_resources_get_care_services "Get details of existing care services review requests.") You can get Care Services Review Response for one or more care service review requests, by either using their Salesforce IDs or external source system IDs. Use section query parameter to have granular filters. Some examples of valid values in section are, Subscriber, Patient, CareDiagnoses, CareRequestItems, CareRequestDrugs, TransportLocations, CareRequest, or CareRequestCase. - **[Care Services Review Resources](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_care_services_review.htm#hc_resource_care_services_review)** Use these resources to create or update care services review requests, or get information about the status of existing requests. #### See Also - [_Salesforce Help_: Handle Care Requests with Utilization Management](https://help.salesforce.com/articleView?id=utilization_management.htm&language=en_US "Salesforce Help: Handle Care Requests with Utilization Management - HTML (New Window)") - [_Salesforce Help_: What is a Care Request?](https://help.salesforce.com/articleView?id=care_request.htm&language=en_US "Salesforce Help: What is a Care Request? - HTML (New Window)") - [_Salsforce Help_: How Are Care Requests Reviewed?](https://help.salesforce.com/articleView?id=utilization_management_types.htm&language=en_US "Salsforce Help: How Are Care Requests Reviewed? - HTML (New Window)") - [ANSI X12 278 - Request for Review and Response Examples](http://www.x12.org/examples/005010X217/ "ANSI X12 278 - Request for Review and Response Examples - HTML (New Window)") - [_Salesforce Help_: Enable Person Accounts](https://help.salesforce.com/articleView?id=account_person_enable.htm&language=en_US "Salesforce Help: Enable Person Accounts - HTML (New Window)") # Care Services Review Resources Use these resources to create or update care services review requests, or get information about the status of existing requests. Available resources: | Resource | Description | | --- | --- | | [/services/data/vXX.X/connect/health/care-services](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_care_services_review.htm#connect_resources_create_care_services_review) | Create care services review requests. | | [/services/data/vXX.X/connect/health/care-services](#connect_resources_create_update_care_services_review "Update care services review requests or update existing requests.") | Update existing care services review requests. | | [/services/data/vXX.X/connect/health/care-services/{ids}](#connect_resources_get_care_services "Get details of existing care services review requests.") | Get details of existing care services review requests. Replace {ids} with a semicolon-separated list of IDs. | ## Care Services Review Requests (GET) Get details of existing care services review requests. ### Resource /services/data/vXX.X/connect/health/care-services/{ids} Replace {ids} with a semicolon-separated list of IDs. The items in this list can be Salesforce ID, or a SourceSystemIdentifier. Use idName query parameter to specify the type of {ids} provided in the URI. URI Example to retrieve care requests using Salesforce IDs: /connect/health/care-services/0Uk7859783498540;0Uk6712899900;0Um4367564378788?idName=Id§ionNames=Subscriber;CareRequest ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_important.png) #### Important Ensure that semicolon character is not a part of any id, if using SourceSystemIdentifier to retrieve care requests. ### Available version 46.0 ### Authentication Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. For more information, see [Connect to Connect REST API Using OAuth](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/quickstart_connecting.htm "HTML (New Window)"). ### HTTP methods GET ### Query parameters
Parameter Name Type Description Required Available Version
idName String Indicates the type of identifiers used in the path parameter ids. The valid values are:
  • id: Salesforce object ID.
  • SourceSystemIdentifier: ID of the external system.
Yes 46.0
sectionNames String Semicolon separated list of section names for which data is requested. For example, Subscriber, Patient, CareDiagnoses, CareRequestItems, CareRequestDrugs, TransportLocations, CareRequest, or CareRequestCase. No 46.0
### Response body for GET [Care Authorization Request Get Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_care_authorization_request_get_result.htm "The response body for the Care Services Review GET request.") ## Care Services Review Requests (POST) Create care services review requests or update existing requests. - You must have Person Accounts enabled to use these APIs. - After enabling person accounts, enable name suffixes. 1. Navigate to **Setup** | **Customize** | **User Interface**. 2. In **Name Settings**, select **Enable Name Suffixes for Person Names** and save. - You can create or update up to 25 care services requests. ### Resource /services/data/vXX.X/connect/health/care-services ### Available version 46.0 ### Authentication Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. ### HTTP methods POST ### Request body for POST **Properties** | Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | careRequestsList | [Care Authorization Request Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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:** ### Response body for POST [Care Authorization Request Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_care_authorization_request_result.htm "Response to create or update care services review request.") ## Care Services Review Requests (PATCH) Update care services review requests or update existing requests. - You must have Person Accounts enabled to use these APIs. - After enabling person accounts, enable name suffixes. 1. Navigate to **Setup** | **Customize** | **User Interface**. 2. In **Name Settings**, select **Enable Name Suffixes for Person Names** and save. - For PATCH, if the request body contains IDs for CareRequestitem, CareRequestDrug, or CareDiagnosis, then the corresponding records are updated, else the new child records are created. ### Resource /services/data/vXX.X/connect/health/care-services ### Available version 46.0 ### Authentication Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. ### HTTP methods PATCH ### Request body for PATCH [Care Requests Update List Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_care_request_list_update_input.htm) ### Response body for PATCH [Care Authorization Request Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_care_authorization_request_result.htm "Response to create or update care services review request.") #### See Also - [_Salesforce Help_: Enable Person Accounts](https://help.salesforce.com/articleView?id=account_person_enable.htm&language=en_US "Salesforce Help: Enable Person Accounts - HTML (New Window)") - [Connect to Connect REST API Using OAuth](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/quickstart_connecting.htm) # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareBenefitVerifyRequest for Pharmacy Benefits Verification Request for verification of benefits. Multiple features use this object. See [CareBenefitVerifyRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carebenefitverifyrequest.htm "Request for verification of benefits. This object is available in API version 53.0 and later."). # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 #### See Also - [_Second-Generation Managed Packaging Developer Guide_: Components Available in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm "Second-Generation Managed Packaging Developer Guide: Components Available in Managed Packages - HTML (New Window)") ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareDiagnosis Represents the details of a diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Case related to the care request. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Care request for the diagnosis. This is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Lookup - **Refers To**: CareRequest ### CodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code description. ### CodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code type for the diagnosis. - **Possible values**: - ICD-10-CM ### CodeTypeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the diagnosis. ### DiagnosisCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code. DiagnosisCodeId will be deprecated in a future release, so use DiagnosisCodeSetId instead. This is a relationship field. - **Relationship Name**: DiagnosisCode - **Relationship Type**: Lookup - **Refers To**: HealthCareDiagnosis ### DiagnosisCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code set. This is a polymorphic relationship field. - **Relationship Name**: DiagnosisCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### DischargeCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Discharge diagnosis code. ### DischargeCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the discharge diagnosis code. ### DischargeCodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code type for the discharge diagnosis. - **Possible values**: - ICD-10-CM ### DischargeCodeTypeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the discharge diagnosis. ### DischargeDiagnosisCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Diagnosis code at discharge. This is a relationship field. - **Relationship Name**: DischargeDiagnosisCode - **Relationship Type**: Lookup - **Refers To**: HealthCareDiagnosis ### DischargeDiagnosisEffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective date for the discharge diagnosis. ### DischargeDiagnosisEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for the discharge diagnosis. ### DischrgeDiagnosisCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set associated with the discharge diagnosis. This field is a polymorphic relationship field. - **Relationship Name**: DischrgeDiagnosisCodeSet - **Refers To**: CodeSet, CodeSetBundle ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective date for the diagnosis. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for the diagnosis. ### HealthConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition that's associated with the member. This field is a relationship field. - **Relationship Name**: HealthCondition - **Relationship Type**: Lookup - **Refers To**: HealthCondition This field is available in API version 57.0 and later. ### IsDischargeDiagnosisPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this is the primary discharge diagnosis. - **Default value**: false ### IsModifiedDiagnosisPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this modified diagnosis is the primary diagnosis. - **Default value**: false ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this diagnosis is the primary diagnosis. - **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. ### ModifiedCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified diagnosis code. ### ModifiedCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified diagnosis code description. ### ModifiedCodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code type for the modified diagnosis. - **Possible values**: - ICD-10-CM ### ModifiedCodeTypeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the modified diagnosis. ### ModifiedDiagnosisCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the modified diagnosis. ModifiedDiagnosisCodeId will be deprecated in a future release, so use ModifiedDiagnosisCodeSetId instead. This is a relationship field. - **Relationship Name**: ModifiedDiagnosisCode - **Relationship Type**: Lookup - **Refers To**: HealthCareDiagnosis ### ModifiedDiagnosisCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified diagnosis code set associated with the diagnosis. This is a polymorphic relationship field. - **Relationship Name**: ModifiedDiagnosisCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### ModifiedEffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified effective date for the diagnosis. ### ModifiedEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified termination date for the diagnosis. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the diagnosis code. ### PresentOnAdmission - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies if the health condition was present at the time of member admission. This field is available in API version 57.0 and later. - **Possible values**: - No - Undetermined - Yes ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type assigned to this object. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which this request was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the system from which the request was sourced. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the most recent update from the source 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. [CareDiagnosisChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 59.0) Change events are available for the object. [CareDiagnosisFeed](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. [CareDiagnosisHistory](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. # CareEpisode Records details of the interaction between a patient and a healthcare provider for the period during which the patient receives healthcare services from the provide. This object is based on the [EpisodeOfCare](https://www.hl7.org/fhir/episodeofcare.html#EpisodeOfCare) FHIR resource. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareCoordinatorId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care coordinator who orchestrates care for the patient during the episode of care. - **Relationship Name**: CareCoordinator - **Refers To**: - HealthcarePractitionerFacility - HealthcareProvider ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the episode of care ends. ### 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 name of the record. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### PatientId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The patient that’s part of the episode of care. - **Relationship Name**: Patient - **Refers To**: Account ### ResponsibleOrganizationId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The organization that’s responsible for managing the patient’s care during the episode of care. This field is a polymorphic relationship field. - **Relationship Name**: ResponsibleOrganization - **Refers To**: - Account - 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. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the episode of care started. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the eipsode of care. - **Possible values**: - Active - Cancelled - Entered-in-Error - Finished - On Hold - Planned - Wait List ### Type - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: The type od te episode of care. - **Possible values**: - cacp - Community-Based Aged Care - da - Drug and Alcohol Rehabilitation - diab - Post-Coordinated Diabetes Program - hacc - Home and Community Care - pac - Post-Acute Care ## 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. [CareEpisodeFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareEpisodeHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareEpisodeOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareEpisodeShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareEpisodeDetail Represents additional information associated with a CareEpisode record. This information may be the referral requests that an episode of care started from or the diagnoses that the episode of care is meant to address. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareEpisodeId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care episode that the detail is associated to. This field is a relationship field. - **Relationship Name**: CareEpisode - **Refers To**: CareEpisode ### DetailRecordId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The detail record that associates additional information to the parent care episode. - **Relationship Name**: DetailRecord - **Refers To**: - ClinicalServiceRequest (For referral requests) - HealthCondition (For diagnoses) ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of detail represented in the record. - **Possible values**: - diagnosis—Diagnosis - referralRequest—Referral Request ### 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 name of the record. ### OwnerId - **Type**: Polymophic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The name of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### Rank - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: When the detail type is a diagnosis, specifies the rank of the recorded diagnosis in the set of diagnoses that’s part of the episode of care. ### RoleCodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: When the detail type is a diagnosis, specifies the role of the recorded diagnoses in the episode of care. This value is a system-defined code. This field is a polymorphic relationship field. - **Relationship Name**: RoleCode - **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. [CareEpisodeDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareEpisodeDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareEpisodeDetailShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareFacilityBed Represents information related to different bed types at a facility with associated care programs and products. 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 ### AvailableBedCapacity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the available bed capacity of an associated service at a facility. ### BedTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the type of bed associated with a facility. This field is a relationship field. - **Relationship Name**: BedTypeCode - **Relationship Type**: Lookup - **Refers To**: CodeSetBundle ### HealthcareFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the associated Healthcare Facility. This field is a relationship field. - **Relationship Name**: HealthcareFacility - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility ### 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 care facility bed. ### 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 reference record of the object that is associated with a bed in a facility. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: CareProgram, CareProgramProduct, Product ### TotalBedCapacity - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Represents the total bed capacity of an associated service at a facility. ## 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. [CareFacilityBedChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFacilityBedFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFacilityBedHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFacilityBedOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFacilityBedShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareFeeScheduleItem Stores procedure level fees for a fee schedule definition. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CareFeeScheduleItemKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key assigned to the Care Fee Schedule Item record. ### FacilityPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The fees when the procedure is performed in a facility location such as a hospital or Ambulatory Surgical Center (ASC). ### FeeScheduleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Fee Schedule Definition associated with the Care Fee Schedule Item. This is a relationship field. - **Relationship Name**: FeeScheduleDefinition - **Relationship Type**: Master-Detail - **Refers To**: FeeScheduleDefinition ### 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 Care Fee Schedule Item. ### NonFacilityPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The fees when the procedure is performed in a non-facility location such as the physician's office. ### ProcedureCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the procedure code. ### ProcedureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The industry standard code for the procedure such as CPT or HCPCS. This is a relationship field. - **Relationship Name**: ProcedureCode - **Relationship Type**: Lookup - **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. [CareFeeScheduleItemFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFeeScheduleItemHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareFeeScheduleItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareGap Represents gaps in patient care through a specified period. 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, Sort - **Description**: The account associated with the care gap. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### CareBarrierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care barrier associated with the care gap. This field is a relationship field. - **Relationship Name**: CareBarrier - **Relationship Type**: Lookup - **Refers To**: CareBarrier ### ClinicalMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical measure asscoiated with the care gap. This field is a relationship field. - **Relationship Name**: ClinicalMeasure - **Relationship Type**: Lookup - **Refers To**: ClinicalMeasure ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the care gap. ### HealthConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition associated with the care gap. This field is a relationship field. - **Relationship Name**: HealthCondition - **Relationship Type**: Lookup - **Refers To**: HealthCondition ### LastEvaluatedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care gap was last evaluated. ### 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. ### MeasureEvaluationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the measure evaluation. - **Possible values**: - EvaluationComplete—Evaluation Complete - EvaluationError—Evaluation Error - EvaluationInProgress—Evaluation In Progress - ManuallyClosed—Manually Closed - ManuallyExcluded—Manually Excluded - ManuallyOpened—Manually Opened ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the care gap. ### 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 ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The problem definiton associated with the care gap. This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Lookup - **Refers To**: ProblemDefinition ### RecordOriginType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: Specifies the method used for retrieving or creating the care gap record. - **Possible values**: - Calculated - Imported - ManuallyCreated—Manually Created ### ReportingPeriodEndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The end date of the care gap reporting period. ### ReportingPeriodStartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The start date of the care gap reporting period. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of external source system from which the record was imported. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: ### Status - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the status of the care gap. - **Possible values**: - Closed - Excluded - Open ### StatusReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for force closing the care gap. ### TargetResolutionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The target resolution date of a care gap for a patient. ## 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. [CareGapFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareGapHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareGapOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareGapShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareGapCriteriaResult Represents the result of an evaluated clinical measure criteria. 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 ### CareGapId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated care gap that is being evaluated. This field is a relationship field. - **Relationship Name**: CareGap - **Relationship Type**: Lookup - **Refers To**: CareGap ### ClinicalMeasureCriteriaId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated measure criteria that the care gap is evaluated against. This field is a relationship field. - **Relationship Name**: ClinicalMeasureCriteria - **Relationship Type**: Lookup - **Refers To**: ClinicalMeasureCriteria ### EvaluatedCriteriaResult - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The result of the evaluated criteria. ### 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 care gap criteria result. ## 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. [CareGapCriteriaResultHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 #### See Also - [_Second-Generation Managed Packaging Developer Guide_: Components Available in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm "Second-Generation Managed Packaging Developer Guide: Components Available in Managed Packages - HTML (New Window)") ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareMetricTarget Represents the expected care metrics at an org level and patient level. 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 ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The CodeSet ID related to the care metric target. ### DetailRatioDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lower value of the care metric target detail ratio. ### DetailRatioNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The higher value of the care metric target detail ratio. ### DetailRatioUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measurement for the care metric target detail ratio. This field is a relationship field. - **Relationship Name**: DetailRatioUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### DetailString - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A sequence of Unicode characters. ### DueDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time it takes to reach the care metric target. ### DueDurationUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measurement for the time it takes to reach the care metric target. This field is a relationship field. - **Relationship Name**: DueDurationUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the care metric target value ceases to take effect. ### GoalAssignmentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated goal assignment record. This field is a relationship field. - **Relationship Name**: GoalAssignment - **Relationship Type**: Lookup - **Refers To**: GoalAssignment ### IsOutcomePositive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the expected boolean value. - **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. ### LowerLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The lower limit for the care metric target range. Used when Type is set to RANGE. ### MeasureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the related measure code. This field is a polymorphic relationship field. - **Relationship Name**: MeasureCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this care metric target. ### NumericValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numeric value of the care metric target (6 decimal places). Used when Type is set to MIN, MAX, or EXACT. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account ID of the patient for whom the care metric target is applicable. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The date when the care metric target value takes effect. ### TargetedOutcome - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies if the targeted outcome value is false (negative outcome is desired) or true (positive outcome is desired). - **Possible values**: - Negative - Positive ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The care metric value type. - **Possible values**: - BOOLEAN - EXACT - MAX - MIN - RANGE ### UnitOfMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the unit of measure for the care metric target. ### UpperLimit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The upper limit for the care metric target range. Used when Type is set to RANGE. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareMetricTargetChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareMetricTargetFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareMetricTargetHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareMetricTargetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareMetricTargetShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareObservation Represents the observed values for care metrics originating from external systems that contain biometric data. 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 CareObservation in Other Objects In addition to creating a record using these fields, you can add more details to your CareObservation record by creating records in certain other objects, and referencing your CareObservation record as the parent record. Here’s the list of objects you can associate to CareObservation in this way, the type of information they add, and the field they use to reference CareObservation. | Object | Type of Information | Reference Field | | --- | --- | --- | | CareObservationComponent | Associates information about the observation’s child components. | CareObservationId | | CareObservationDetail | Associates detailed findings or contextual information for the observation. | CareObservationId | - **[CareObservationComponent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_CareObservationComponent.htm)** Represents information about a component of a care observation. This object is available in API version 51.0 and later. - **[CareObservationDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careobservationdetail.htm)** Represents the details of a care observation. It provides detailed findings or contextual information for a patient's health assessment, such as a particular lab result or a clinician's specific insight. The detailed observations enable providers to capture comprehensive and precise health data. This object is available in API version 68.0 and later. ## Fields ### AdditionalCode1Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the observation. This field is meant to be used if the CodeId field isn’t sufficient. - **Referenced Objects**: - CodeSet ### AdditionalCode2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the observation. This field is meant to be used if the CodeId and AdditionalCode1Id fields aren’t sufficient. - **Referenced Objects**: - CodeSet ### BasedOnId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication request or service request that the observation is based on. - **Referenced Objects**: - MedicationRequest - ClinicalServiceRequest ### BaselineUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the baseline values of this observation. - **Referenced Objects**: - UnitOfMeasure ### BaselineValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The baseline value of an observation represented as a string. ### BodySiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the site of the observation on the patient’s body. - **Referenced Objects**: - CodeSetBundle ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the patient's care observation. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of the observation. - **Possible values**: - Activity - Exam - Imaging - Procedure - Social-History - Survey - Therapy - Vital-Signs ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents the specific observation type. - **Referenced Objects**: - CodeSet ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### DataAbsentReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the reason why the data for the observed value is absent. Available in API version 68.0 and later. - **Referenced Objects**: - CodeSetBundle ### DerivationSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the document or observation from which the value of the observation is derived. If the observation value is derived from a document, reference the diagnostic summary record that represents the document. If the observation value is derived from another observation, reference the CareObservation record representing that observation. This is a polymorphic relationship field. - **Relationship Name**: DerivationSource - **Relationship Type**: Lookup - **Referenced Objects**: CareObservation, DiagnosticSummary ### DeviceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the device generating the observed value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### EffectiveDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation was recorded or the start date and time of the observation’s clinically relevant period. ### EncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter related to the observation. - **Referenced Objects**: - ClinicalEncounter ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the observation’s clinically relevant period. ### ExpectedValueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The CodeSet ID related to the care metric target. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### HasMetExpectedValue - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the observed value aligns with the expected value or range. ### IdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the observation. - **Referenced Objects**: - Identifier ### IsMonitoredRemotely - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the observed value is obtained via remote monitoring. This record can only be used in processing and charting if this field is set to True. - **Default value**: false ### IsObserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the boolean value for the observation. The value is true if something is observed, and false if it’s not. This field is a duplicate field introduced in API version 51.0 that stores the same information as IsOutcomePositive. Use only one of these two fields for this type of information. - **Default value**: false ### IsOutcomePositive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the boolean value for the observation. The value is true if something is observed, and false if it’s not. The IsObserved field is a duplicate of this field that stores the same information. Use only one of these two fields for this type of information. - **Default value**: false ### IssuedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time the current version of the observation record is issued. ### 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. ### LowerBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the lower limit of the baseline value range for the observation. ### MethodId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the method of the observation. - **Referenced Objects**: - CodeSetBundle ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this care observation. ### NumericValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numeric value of the care observation (6 decimal places). ### ObservationEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation ended. ### ObservationStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation started. ### ObservationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the observation - **Possible values**: - Amended - Final - Preliminary - Registered ### ObservedSubjectId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account ID of the subject being observed. For example, the ID of the patient being observed. - **Referenced Objects**: - Account ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### ObservedValueCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the observed value. - **Referenced Objects**: - CodeSetBundle ### ObservedValueDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator of the observed value. ### ObservedValueNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator of the observed value. ### ObservedValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observed value in text form. ### ObservedValueType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of observed values recorded in ObservedValueNumerator and ObservedValueDenominator. - **Possible values**: - Quantity - Range - Ratio ### ObservedValueUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the observed value. This is a duplicate field introduced in API version 51.0 that stores the same information as UnitOfMeasureId. Use only one of these fields to store this information. - **Referenced Objects**: - UnitOfMeasure ### ObserverId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who made the observation. - **Referenced Objects**: - Account - HealthcareProvider ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. Available in API version 56.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartOfId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication statement, procedure, or immunization that this observation is a part of. - **Referenced Objects**: - MedicationStatement - PatientImmunization - PatientMedicalProcedure ### ProcessingResult - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The processing result of this observation record. Applicable only if IsMonitoredRemotely is set to True - **Possible values**: - DATA\_TYPE\_MISMATCH—Invalid record. Provide a numeric value that matches the data type in the Expected Value field. - DOES\_NOT\_MEET\_TARGET—Record processed. Expected value updated. Observation Numeric Value or Outcome Positive does not meet Care Metric Target conditions. - MEETS\_TARGET—Record processed. Expected value updated. Observation Numeric Value or Outcome Positive meets Care Metric Target conditions. - MISSING\_UNIT—Invalid record. Provide a valid unit of measure for the code. - NO\_EXPECTED\_VALUE\_IN\_DATE—Record processed. There is no Expected Value with Care Metric Target StartDate and EndDate that meets Observation Effective Date Time - NO\_VALUE\_WITH\_UNIT—Record processed. There is no Expected Value with matching Observation Unit of Measure - NULL\_PATIENT\_DEVICE—Invalid record. Add information about the patient or the device. - PATIENT\_NOT\_FOUND—Invalid record. Patient not found in the 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 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 for the observed value. The ObservedValueUnitId field is a duplicate of this field that stores the same information. Use only one of these fields to store this information. - **Referenced Objects**: - UnitOfMeasure ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### UpperBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the upper limit of the baseline value range for the observation. ### ValueDenominatorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the denominator of the observed value. Available in API version 68.0 and later. - **Referenced Objects**: - UnitOfMeasure ### ValueInterpretation - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the interpretation of values observed. - **Possible values**: - High - Low - Normal ### ValueTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time of day (hh:mm:ss) that’s recorded as the observed value. Available in API version 68.0 and later. # CareObservation Represents the observed values for care metrics originating from external systems that contain biometric data. 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 CareObservation in Other Objects In addition to creating a record using these fields, you can add more details to your CareObservation record by creating records in certain other objects, and referencing your CareObservation record as the parent record. Here’s the list of objects you can associate to CareObservation in this way, the type of information they add, and the field they use to reference CareObservation. | Object | Type of Information | Reference Field | | --- | --- | --- | | CareObservationComponent | Associates information about the observation’s child components. | CareObservationId | | CareObservationDetail | Associates detailed findings or contextual information for the observation. | CareObservationId | ## Fields ### AdditionalCode1Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the observation. This field is meant to be used if the CodeId field isn’t sufficient. - **Referenced Objects**: - CodeSet ### AdditionalCode2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the observation. This field is meant to be used if the CodeId and AdditionalCode1Id fields aren’t sufficient. - **Referenced Objects**: - CodeSet ### BasedOnId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication request or service request that the observation is based on. - **Referenced Objects**: - MedicationRequest - ClinicalServiceRequest ### BaselineUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the baseline values of this observation. - **Referenced Objects**: - UnitOfMeasure ### BaselineValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The baseline value of an observation represented as a string. ### BodySiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the site of the observation on the patient’s body. - **Referenced Objects**: - CodeSetBundle ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the patient's care observation. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the category of the observation. - **Possible values**: - Activity - Exam - Imaging - Procedure - Social-History - Survey - Therapy - Vital-Signs ### CodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-defined code that represents the specific observation type. - **Referenced Objects**: - CodeSet ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### DataAbsentReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the reason why the data for the observed value is absent. Available in API version 68.0 and later. - **Referenced Objects**: - CodeSetBundle ### DerivationSourceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the document or observation from which the value of the observation is derived. If the observation value is derived from a document, reference the diagnostic summary record that represents the document. If the observation value is derived from another observation, reference the CareObservation record representing that observation. This is a polymorphic relationship field. - **Relationship Name**: DerivationSource - **Relationship Type**: Lookup - **Referenced Objects**: CareObservation, DiagnosticSummary ### DeviceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the device generating the observed value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### EffectiveDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation was recorded or the start date and time of the observation’s clinically relevant period. ### EncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter related to the observation. - **Referenced Objects**: - ClinicalEncounter ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the observation’s clinically relevant period. ### ExpectedValueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The CodeSet ID related to the care metric target. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### HasMetExpectedValue - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the observed value aligns with the expected value or range. ### IdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier for the observation. - **Referenced Objects**: - Identifier ### IsMonitoredRemotely - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the observed value is obtained via remote monitoring. This record can only be used in processing and charting if this field is set to True. - **Default value**: false ### IsObserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the boolean value for the observation. The value is true if something is observed, and false if it’s not. This field is a duplicate field introduced in API version 51.0 that stores the same information as IsOutcomePositive. Use only one of these two fields for this type of information. - **Default value**: false ### IsOutcomePositive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the boolean value for the observation. The value is true if something is observed, and false if it’s not. The IsObserved field is a duplicate of this field that stores the same information. Use only one of these two fields for this type of information. - **Default value**: false ### IssuedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time the current version of the observation record is issued. ### 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. ### LowerBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the lower limit of the baseline value range for the observation. ### MethodId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the method of the observation. - **Referenced Objects**: - CodeSetBundle ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of this care observation. ### NumericValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numeric value of the care observation (6 decimal places). ### ObservationEndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation ended. ### ObservationStartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the observation started. ### ObservationStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the status of the observation - **Possible values**: - Amended - Final - Preliminary - Registered ### ObservedSubjectId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The account ID of the subject being observed. For example, the ID of the patient being observed. - **Referenced Objects**: - Account ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### ObservedValueCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the observed value. - **Referenced Objects**: - CodeSetBundle ### ObservedValueDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator of the observed value. ### ObservedValueNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator of the observed value. ### ObservedValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The observed value in text form. ### ObservedValueType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of observed values recorded in ObservedValueNumerator and ObservedValueDenominator. - **Possible values**: - Quantity - Range - Ratio ### ObservedValueUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the observed value. This is a duplicate field introduced in API version 51.0 that stores the same information as UnitOfMeasureId. Use only one of these fields to store this information. - **Referenced Objects**: - UnitOfMeasure ### ObserverId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person who made the observation. - **Referenced Objects**: - Account - HealthcareProvider ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. Available in API version 56.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartOfId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication statement, procedure, or immunization that this observation is a part of. - **Referenced Objects**: - MedicationStatement - PatientImmunization - PatientMedicalProcedure ### ProcessingResult - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The processing result of this observation record. Applicable only if IsMonitoredRemotely is set to True - **Possible values**: - DATA\_TYPE\_MISMATCH—Invalid record. Provide a numeric value that matches the data type in the Expected Value field. - DOES\_NOT\_MEET\_TARGET—Record processed. Expected value updated. Observation Numeric Value or Outcome Positive does not meet Care Metric Target conditions. - MEETS\_TARGET—Record processed. Expected value updated. Observation Numeric Value or Outcome Positive meets Care Metric Target conditions. - MISSING\_UNIT—Invalid record. Provide a valid unit of measure for the code. - NO\_EXPECTED\_VALUE\_IN\_DATE—Record processed. There is no Expected Value with Care Metric Target StartDate and EndDate that meets Observation Effective Date Time - NO\_VALUE\_WITH\_UNIT—Record processed. There is no Expected Value with matching Observation Unit of Measure - NULL\_PATIENT\_DEVICE—Invalid record. Add information about the patient or the device. - PATIENT\_NOT\_FOUND—Invalid record. Patient not found in the 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 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 for the observed value. The ObservedValueUnitId field is a duplicate of this field that stores the same information. Use only one of these fields to store this information. - **Referenced Objects**: - UnitOfMeasure ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs. ### UpperBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the upper limit of the baseline value range for the observation. ### ValueDenominatorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the denominator of the observed value. Available in API version 68.0 and later. - **Referenced Objects**: - UnitOfMeasure ### ValueInterpretation - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the interpretation of values observed. - **Possible values**: - High - Low - Normal ### ValueTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time of day (hh:mm:ss) that’s recorded as the observed value. Available in API version 68.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. [CareObservationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareObservationComponent Represents information about a component of a care observation. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BaselineUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The baseline value’s unit. - **Referenced Objects**: - UnitOfMeasure ### BaselineValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The baseline value of an observation represented as a string. ### CareObservationId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent care observation that this component belongs to. - **Referenced Objects**: - CareObservation ### ComponentTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The system-generated code that represents the component type. - **Referenced Objects**: - CodeSetBundle - **Example**: The LOINC code for niacin in blood. ### DataAbsentReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the reason why the data for the observed value is absent. Available in API version 68.0 and later. - **Referenced Objects**: - CodeSetBundle ### IsObserved - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates a positive observation. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### 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. ### LowerBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the lower limit of the baseline value range for the observation. ### MissingDataReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why observation data is missing or incomplete. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the CareObservationComponent record. ### NumericValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value of the observation in numeric form. ### ObservationEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the end of the period related to observation component value. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### ObservationStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the start of the period related to observation component value. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### ObservedValueCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-generated code that represents the observed value. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId - **Referenced Objects**: - CodeSetBundle ### ObservedValueDenominator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The denominator of the numerical type value observed. Use to record quantity, range, and ratio type values. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### ObservedValueNumerator - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The numerator of the numerical type value observed. Use to record quantity, range, and ratio type values. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### ObservedValueText - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The text form of the value observed in the component. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId ### ObservedValueUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the unit of the observed value. This field is used for quantity, range, and ratio type of observed values. A record can only have a value for one of these fields or field combinations: - IsObserved - ObservationStartDateTime and ObservationEndDateTime - ObservedValueCodeId - ObservedValueText - ObservedValueNumerator, ObservedValueDenominator, and ObservedValueUnitId - **Referenced Objects**: - UnitOfMeasure ### UpperBaselineValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the upper limit of the baseline value range for the observation. ### ValueDenominatorUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the denominator of the observed value. Available in API version 68.0 and later. - **Referenced Objects**: - UnitOfMeasure ### ValueInterpretation - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the interpretation of values observed. - **Possible values**: - High - Low - Normal ### ValueTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time of day (hh:mm:ss) that’s recorded as the observed value. Available in API version 68.0 and later. ### ValueType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of observed value recorded in ObservedValueNumerator and ObservedValueDenominator. - **Possible values**: - Quantity - Range - Ratio ## Usage This object is used to record the different components of an observation, such as different tests that are part of a clinical observation. Component records are connected to the parent observation records using the CareObservationId field. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareObservationComponentFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationComponentHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationComponentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareObservationDetail Represents the details of a care observation. It provides detailed findings or contextual information for a patient's health assessment, such as a particular lab result or a clinician's specific insight. The detailed observations enable providers to capture comprehensive and precise health data. 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 ### CareObservationId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care observation that this detail belongs to. - **Referenced Objects**: - CareObservation ### DetailRecordId - **Type**: Polymorphic reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record that adds detailed findings or contextual information to the care observation. Select the record based on the specified detail type. - **Referenced Objects**: - CareObservation - CarePlan - ClinicalServiceRequest - CodeSetBundle - MedicationRequest - MedicationStatement ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of relationship between the care observation record and the detail record. - **Possible values**: - BasedOn—Based On - PartOf—Part Of - Interpretation - HasMember—Has Member - DataAbsentReason—Data Absent Reason ### 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 observation detail. ## Usage CareObservationDetail records add additional information to CareObservation records. The type of information is specified using the DetailType field, and the related record is selected using the DetailRecordId field. Connect the detail to its parent observation with the CareObservationId field. This information can be of the following types, referencing the following types of records: - Based On: Care plans, clinical service requests, or medication requests - Data Absent Reason: Code set bundles - Has Member: Care observations - Interpretation: Code set bundles - Part Of: Care observations or medication statements One CareObservationDetail record can specify only one type and piece of information. If multiple detail types or detail instances are required for the parent care observation, create multiple CareObservationDetail 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. [CareObservationDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareObservationDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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​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. | # CarePlan Stores information about a care plan associated with a medication therapy review. Care plans are used to assign tasks to patients as part of medication therapy reviews. 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 ### CarePlanTemplateId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care plan template associated with the care plan. This field is a relationship field. - **Relationship Name**: CarePlanTemplate - **Relationship Type**: Lookup - **Refers To**: CarePlanTemplate ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The case associated with the care plan. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Master-Detail - **Refers To**: Case ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A description of the care plan. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date until when the care plan is effective. ### 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. ### MedicationTherapyReviewId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication therapy review that's associated with this care plan. This field is a relationship field. - **Relationship Name**: MedicationTherapyReview - **Relationship Type**: Lookup - **Refers To**: MedicationTherapyReview ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The unique name of the care plan. ### ParticipantId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the care plan. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Relationship Type**: Lookup - **Refers To**: Account, Contact ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the care plan is effective. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the care plan. - **Possible values**: - Active - Cancelled - Completed - Draft - Proposed ### TaskJobStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The job status of tasks associated with the care plan. This field is currently not used. - **Possible values**: - Completed - Failed - InProgress - Submitted ### TaskJobStatusMessage - **Type**: textarea - **Properties**: Nillable - **Description**: The job status message of tasks associated with the care plan. This field is currently not used. ## 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. [CarePlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlan Represents a care plan that is created to help improve a patient or member’s health. This object is based on the [CarePlan](https://www.hl7.org/fhir/careplan.html#CarePlan) FHIR resource. 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 ### AuthorId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The author of the care plan. - **Relationship Name**: Author - **Relationship Type**: Lookup - **Refers To**: - Account - CareRegisteredDevice - HealthcarePractitionerFacility - HealthcareProvider ### AuthorizationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of authorization provided for the care plan. - **Possible values**: - Option - Order - Plan - Proposal ### CarePlanTemplateId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care plan template from which the care plan was instantiated. - **Relationship Name**: CarePlanTemplate - **Refers To**: CarePlanTemplate ### CaseId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The parent case record that the care plan is associated to. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ClinicalEncounterId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The encounter during which the care plan was created. - **Relationship Name**: ClinicalEncounter - **Refers To**: ClinicalEncounter ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the care plan. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care plan ends. ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the record. ### ParticipantId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The patient or member that the care plan is created for. This field is a polymorphic relationship field. - **Relationship Name**: Participant - **Relationship Type**: Lookup - **Refers To**: Account, Contact ### RecordedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care plan was first recorded. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care plan begins. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the care plan. - **Possible values**: - Active - Cancelled - Completed - Draft - Proposed ### TaskJobStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The job status of tasks associated with the care plan. This field is currently not used. - **Possible values**: - Completed - Failed - InProgress—In Progress - Submitted ### TaskJobStatusMessage - **Type**: textarea - **Properties**: Nillable - **Description**: The job status message of tasks associated with the care plan. This field is currently not used. ## 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. [CarePlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanActivity Represents a planned action that’s part of a care plan. For example, knowledge campaigns, physiotherapy appointments, medication regimens, etc. This object is a child object of CarePlan. 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 ### ActivityCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents an activity. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_tip.png) #### Tip You can either specify your care plan activity using a generic code with the ActivityCodeId field, or you use the ReferenceRecordId field to reference a record in your system that represents the specific instance of the activity. This field is a polymorphic relationship field. - **Relationship Name**: ActivityCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### ActivityTimingId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The schedule prescribed for the activity. You can use use an ActivityTiming record to specifiy how long and how often the activy has to be repeated. This field is a relationship field. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record. - **Relationship Name**: ActivityTiming - **Relationship Type**: Lookup - **Refers To**: ActivityTiming ### ActivityType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the activity. - **Possible values**: - Appointment - Communication Request - Device Request - Medication Request - Medication Statement - Nutrition Order - Service Request - Task - Vision Prescription ### AdministeredProductCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the product that’s administered as part of the activity. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You can’t use both the AdministeredProductCodeId and AdministeredProductId fields together in the same record. This field is a polymorphic relationship field. - **Relationship Name**: AdministeredProductCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### AdministeredProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the product in that’s administered as part of the activity. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You can’t use both the AdministeredProductCodeId and AdministeredProductId fields together in the same record. This field is a relationship field. - **Relationship Name**: AdministeredProduct - **Relationship Type**: Lookup - **Refers To**: Medication ### CarePlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care plan that the activity is a part of. This field is a relationship field. - **Relationship Name**: CarePlan - **Relationship Type**: Master-Detail - **Refers To**: CarePlan ### DailyDoseQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of product that’s administered or consumed each day as part of the activity. ### DailyDoseUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the values specified in DailyDoseQuantity. This field is a relationship field. - **Relationship Name**: DailyDoseUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the activity. ### 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. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The place where the activity is intended to happen. This could be provider facility, the patient’s home, etc. This field is a polymorphic relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated name of the record. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. Available in API version 57.0. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### ProhibitedActivity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the activity described in the record is prescribed as something that the patient should avoid doing. Use the Default value if you’d rather not specify this as true or false. - **Possible values**: - Default - False - True ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The activity that’s prescribed as part of the care plan. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_tip.png) #### Tip You can either specify your care plan activity using a generic code with the ActivityCodeId field, or you use the ReferenceRecordId field to reference a record in your system that represents the specific instance of the activity. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: ClinicalServiceRequest, MedicationRequest, MedicationStatement ### ScheduleDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The schedule for when the activty is intended to be performed. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record. ### ScheduledPeriodEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the activity’s prescribed time period ends. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record. ### ScheduledPeriodStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the activity’s prescribed time period starts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note You use the ActivityTimingId field if you want to represent the activity’s schedule as a timing value, the ScheduleDescription field if you want to use a text value, and the ScheduledPeriodStartDateTime and ScheduledPeriodEndDateTime fields if you want to use a period value. You can pick any one of these data types, but you can’t use more than one in the same record. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the status of the activity. - **Possible values**: - Cancelled - Completed - Entered-In-Error - In Progress - Not Started - On Hold - Scheduled - Stopped - Unknown ### StatusReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the reason for why the value specified in Status is valid. This field is a polymorphic relationship field. - **Relationship Name**: StatusReasonCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### SuppliedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total quantity of product that’s supplied, administered, or consumed as part of the activity during the course of the care plan. ### SuppliedQuantityUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of the value specified in SuppliedQuantity. This field is a relationship field. - **Relationship Name**: SuppliedQuantityUnit - **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. [CarePlanActivityFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanActivity Represents an activity that’s part of a care plan. This object is a child of CarePlan. 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 ### ActivityCodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents an standardized activity in a care plan. - **Relationship Name**: ActivityCode - **Relationship Type**: Lookup - **Refers To**: - CodeSet - CodeSetBundle ### ActivityTimingId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represent schedule following which the activity is meant to be performed. This information includes period during which the activity recurs and the frequency with which it recurs during that period. - **Relationship Name**: ActivityTiming - **Refers To**: ActivityTiming ### ActivityType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the activity. - **Possible values**: - Appointment - Communication Request - Device Request - Medication Request - Medication Statement - Nutrition Order - Service Request - Task - Vision Prescription ### AdministeredProductCodeId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the product administered as part of the activity. This field is a polymorphic relationship field. - **Relationship Name**: AdministeredProductCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### AdministeredProductId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication that’s administered as part of the activity. - **Relationship Name**: AdministeredProduct - **Refers To**: Medication ### CarePlanId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care plan that the activity is a part of. This field is a relationship field. - **Relationship Name**: CarePlan - **Relationship Type**: Lookup - **Refers To**: CarePlan ### DailyDoseQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount of medication administered daily as part of the activity. ### DailyDoseUnitId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit for DailyDoseQuantity - **Relationship Name**: DailyDoseUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description for the activity. ### 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. ### LocationId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the activity was performed. This could be a healthcare facility, or even the patient or member’s home. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: - HealthcareFacility - Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OwnerId - **Type**: Lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProhibitedActivity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the recorded activity is a prohibited activity. For instance, creating a CarePlanActivity record for Smoking and setting the ProhibitedActivity field to true to indicate that smoking is prohibited in the care plan. - **Possible values**: - Default - False - True ### ReferenceRecordId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a clinical record that represents the activity. For instance, a medication statement to represent an activity that administers medication as part of the care plan. - **Relationship Name**: LookupRecord - **Refers To**: - ClinicalServiceRequest - MedicationRequest - MedicationStatement ### ReferenceTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a task record that represents the activity. - **Relationship Name**: ReferenceTask - **Relationship Type**: Lookup - **Refers To**: Task ### ScheduleDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The schedule for the activity represent as plain text. ### ScheduledPeriodEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The scheduled date and time when the activity ends. ### ScheduledPeriodStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The scheduled date and time when the activity begins. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the activity. - **Possible values**: - Cancelled - Completed - Entered-In-Error - In Progress - Not Started - On Hold - Scheduled - Stopped - Unknown ### StatusReasonCodeId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the reason for the activity’s status. This field is a polymorphic relationship field. - **Relationship Name**: StatusReasonCode - **Relationship Type**: Lookup - **Refers To**: - CodeSet - CodeSetBundle ### SuppliedQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total quantity of medication that is meant to be administered as part of the activity during the course of its full period. ### SuppliedQuantityUnitId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit for SuppliedQuantityUnitId. This field is a relationship field. - **Relationship Name**: SuppliedQuantityUnit - **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. [CarePlanActivityFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanActivityDetail Represents additional information associated with a CarePlanActivity record. This information may be outcomes of the activity, the performers who contributed to it, or the reasons why the activity was necessary.. This object is a child of CarePlanActivity. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CarePlanActivityId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care plan activity record that the additional information is associated to. - **Relationship Name**: CarePlanActivity - **Relationship Type**: Lookup - **Refers To**: CarePlanActivity ### DetailCodeId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the system-defined code that represents the additional information associated to the care plan activity record. This information can be an outcome of the activity or one of the reasons the activity was required. Use this field with the Outcome Code and Reason Code detail types. - **Relationship Name**: DetailCode - **Refers To**: - CodeSet - CodeSetBundle ### DetailRecordId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical record that represents the additional information associated to the parent care plan activity record. This information can an outcome of the activity, a performer involved in the activity, or the reason why the activity was necessary. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: - Account (Performer) - CareObservation (Reason Reference) - CareRegisteredDevice (Performer) - ClinicalEncounter (Outcome Reference) - DiagnosticSummary (Reason Reference) - HealthCondition (Reason Reference) - HealthcarePractitionerFacility (Performer) - HealthcareProvider (Performer) - PatientMedicalProcedure (Outcome Reference) ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of additional information associated with the parent care plan activity. - **Possible values**: - OutcomeCodeableConcept—Outcome Code - OutcomeReference—Outcome Reference - Performer - ReasonCode—Reason Code - ReasonReference—Reason Reference ### 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 name of the record. ### OwnerId - **Type**: Polymorphic Lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **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. [CarePlanActivityDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanActivityDetailShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanDetail Represents additional information associated with a care plan record. These details may be things addressed by the care plan, contributors in the care plan, supporting information, and so on. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CarePlanId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent care plan record. - **Relationship Name**: CarePlan - **Refers To**: CarePlan ### DetailCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents additional information associated to a care plan. Detail code is used to support the Category detail type. 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 record that represents additional information associated to the parent care plan. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Relationship Type**: Lookup - **Refers To**: - Account (For the Contributor and Supporting Information detail types) - CarePlan (For the Based On, Part Of, and Replaced Care Plan detail types) - CareRegisteredDevice (For the Contributor detail type) - HealthCondition (For the Addressed Item detail type) - HealthcarePractitionerFacility (For the Contributor detail type) - HealthcareProvider (For the Contributor detail type) ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of additional information associated to the parent record. For instance, the care plan that the parent care plan is based on, part of, or replaces, and so on. - **Possible values**: - Addressed Item - Based On - Category - Contributor - Part of - Replaced Care Plan - Supporting Information ### 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 name of the 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 ### ProblemPriority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: For the Addressed Item detail type, indicates the priority of the addressed problem. - **Possible values**: - High - Low - Normal ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: For the Addressed Item detail type, indicates position of the addressed problem in the list of all addressed problem. ### TaskJobStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted Picklist, Sort - **Possible values**: - Completed - Failed - InProgress - In Progress - Submitted ### TaskJobStatusMessage - **Type**: textarea - **Properties**: Nillable - **Description**: Status message for the task 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. [CarePlanDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanDetailOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanDetailShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanTemplate Stores information about care plan template that’s used to define to-do lists for patients during medication therapy reviews. 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 ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A description of the care plan template. ### 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 the record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the care plan template. ### 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 ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the care plan template. - **Default value**: Draft - **Possible values**: - Draft - Inactive - Published ## 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. [CarePlanTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanTemplate Represents a template use to instantiate a care plan. 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 ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description for the care plan template. ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the care plan template. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: - Group - User ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the care plan template. - **Default value**: Draft - **Possible values**: - Draft - Inactive - Published ## 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. [CarePlanTemplateFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanTemplateGoal Represents goals in Care Plan Templates that don’t have problems as their parents. These goals are added directly under the care plan in the template . This object determines the position of goals in the hierarchy of care plan templates. The specific details of goals are referenced from GoalDefinitions records in the PGI library. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CarePlanTemplateId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent care plan template that the goal is a part of. - **Relationship Name**: CarePlanTemplate - **Refers To**: CarePlanTemplate ### GoalDefinitionId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References a goal definition in the PGI library that specifies the details of the templatized goal. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Refers To**: GoalDefinition ### 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 name of the templatized care plan goal. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The priority of the templatized goal. - **Possible values**: - High - Low - Medium ## 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. [CarePlanTemplateGoalHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePlanTemplateProblem Represents problems in Care Plan Templates. These problems may or may not have goals as their direct children. This object determines the position of problems in the hierarchy of care plan templates. The specific details of problems are referenced from ProblemDefinition records in the PGI library. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CarePlanTemplateId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The parent care plan template record. - **Relationship Name**: CarePlanTemplate - **Refers To**: CarePlanTemplate ### 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 name of the 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 ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the priority of the templatized problem. - **Possible values**: - High - Low - Medium ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the problem definition in the PGI library that contains the clinical information related to the templatized problem. If the templatized problem has a goal as its direct child, then reference a ProblemGoalDefinition record instead. This field is a polymorphic relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Lookup - **Refers To**: - ProblemDefinition - ProblemGoalDefinition ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the spot of the templatized problem in the list of all templatized problems in the care plan template. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from which the care plan template problem was brought into Salesforce. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the care plan template problem in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the care plan template problem was last modified in its source 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. [CarePlanTemplateProblemFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateProblemHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateProblemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CarePlanTemplateProblemShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CarePractnFacilityAppt Represents a junction object between a HealthcarePractitionerFacility (practitioner at a facility) and a ServiceAppointment (appointment). This object is available in API version 52.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### HealthcarePractitionerFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Required. The healthcare practitioner facility scheduled for this appointment. This field is a relationship field. - **Relationship Name**: HealthcarePractitionerFacility - **Relationship Type**: Master-Detail - **Refers To**: HealthcarePractitionerFacility ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider is required at the appointment (true) or not (false). This field is available in API version 62.0 or later. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when this record was last modified. Its label in the user interface is Last Modified Date. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when this record was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. The provider associated with the service appointment. ### ServiceAppointmentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. The appointment associated with this record. This field is a relationship field. - **Relationship Name**: ServiceAppointment - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareProcessingError Stores information on processing errors sent from payer to provider on a member’s authorization request. 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 ### ActionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code that's associated with the resolution of the error that occurred when processing an authorization request. This field is a polymorphic relationship field. - **Relationship Name**: ActionCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### Description - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The description of the error. ### ErrorCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code that's associated with the error that occurred when processing an authorization request. This field is a polymorphic relationship field. - **Relationship Name**: ErrorCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### LastModifiedById - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The ID of the user who last updated the record. ### LastModifiedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user updated the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care processing error. ### 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 ### ReferenceObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The object that's associated with the error. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceObject - **Relationship Type**: Lookup - **Refers To**: CareDiagnosis, CareRequest, CareRequestDrug, CareRequestItem ## Usage When payer receives an authorization request from the provider, they review and validate the request details. If an error occurs during the request processing, payer must create appropriate care processing error records with reference to the care request record. This error information is sent to the provider as part of the request response. Alternatively, payers can also automate the record creation by configuring a flow that’s triggered whenever an authorization request is received in the payer system. The flow validates the care request record, identifies any error, and creates appropriate care processing error records to be sent to the 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. [CareProcessingErrorChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 63.0) Change events are available for the object. [CareProcessingErrorFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareProcessingErrorHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareProcessingErrorShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 for Patient Program Outcome Management 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. Multiple features use this object. See [CareProgram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogram.htm "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."). # CareProgram for Pharmacy Benefits Verification 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. Multiple features use this object. See [CareProgram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogram.htm "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."). # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareProgramEnrollee for Advanced Therapy Management Represents a participant enrolled in a care program. Multiple features use this object. See [CareProgramEnrollee](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrollee.htm "Represents a participant enrolled in a care program."). # CareProgramEnrollee for Patient Program Outcome Management Represents a participant enrolled in a care program. Multiple features use this object. See [CareProgramEnrollee](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrollee.htm "Represents a participant enrolled in a care program."). # CareProgramEnrollee for Pharmacy Benefits Verification Represents a participant enrolled in a care program. Multiple features use this object. See [CareProgramEnrollee](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramenrollee.htm "Represents a participant enrolled in a care program."). # CareProgramEnrolleeProduct Represents the affiliation between a care program enrollee and a care program product, a care program provider, or both. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 for Pharmacy Benefits Verification Represents the affiliation between a care program and a care program product, care program provider, or both. Multiple features use this object. See [CareProgramProduct](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramproduct.htm "Represents the affiliation between a care program and a care program product, care program provider, or both."). # CareProgramProvider Represents a business account that is the service provider for a care program product. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 #### See Also - [_Object Reference for the Salesforce Platform_: AccountContactRelation](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_accountcontactrelation.htm "Object Reference for the Salesforce Platform: AccountContactRelation - HTML (New Window)") ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # 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 | ## Fields ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care program enrollee to whom this device is registered. ### DeviceId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asset ID for the device. - **Referenced Objects**: Asset ### DeviceTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the type of the device. Examples: Cystoscope, oxygen tent - **Referenced Objects**: CodeSet ### 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 this device registration record. ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account ID of the patient to whom this device is registered. - **Referenced Objects**: Account ### RegistrationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when this device was registered. ### SafetyInformation - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health and safety information about with the device. ### 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. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates whether the device registration is active. - **Possible values**: - Active - Inactive ### SupportContactDetail - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contact details of the person or organization that provides support for the device. ### UniqueDeviceId1 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions. ### UniqueDeviceId1Issuer - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The organization that issued the UDI1 for the device. ### UniqueDeviceId2 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions. ### UniqueDeviceId2Issuer - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The organization that issued the UDI2 for the device. ### UniqueDeviceId3 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique device identifier (UDI) assigned to device label or package. It identifies the labeler and the specific version or model of a device. A device may have multiple UDIs since it could have been sold in multiple jurisdictions. ### UniqueDeviceId3Issuer - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The organization that issued the UDI3 for the device. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [CareRegisteredDeviceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRegisteredDeviceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRegisteredDeviceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareRequest Represents the general details of a care-related request including member information, admission date, decision reason, and so on. A single request can contain multiple diagnoses, services, or drugs. Care requests include preauthorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AcknowledgementLetterSentDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when an acknowledgment letter was sent to the requester. ### ActualAdmissionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Actual admission date for the patient. ### ActualDischargeDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Actual discharge date for the patient. ### AdmissionNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes related to the admission. ### AdmissionSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Where the patient was admitted from, for example, a clinic or an emergency room. ### AdmissionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of admission, for example, emergency or elective. ### AorReceivedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the Appointment of Representative (AOR) form was received. ### AorRequestedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the AOR form was requested. ### AppealRequestReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of reason associated with the appeal request. - **Possible values**: - Service Request Rejected - Service Claim Unpaid - Rejected - Service Not Required - Rejected - No Coverage Benefit - Notification Delayed - Specialist Referral Rejected ### AppointedRepresentativeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the appointed representative for the member. This is a relationship field. - **Relationship Name**: AppointedRepresentative - **Relationship Type**: Lookup - **Refers To**: Account ### AppointedRepVerbalContactDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time of verbal contact with the member's appointed representative. ### AppointedRepWrittenContactDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time correspondence was sent to the member's appointed representative. ### ApprovedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Approved number of days for the admission. ### ApprovedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Approved level of care for the patient, for example, Hospital-Observaton or SNF-Rehabilitation. ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Case related to the care request. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note A case record can only be related to a single care request record. Therefore, ensure that the Case record you specify in this field isn’t already associated with another care request. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### ClaimNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Claim number for the medical service or medication, if one exists. ### ClinicalCaseType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Clinical case type for the patient, for example, High Risk Fall or Adult Diabetes. ### CriteriaMet - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether criteria for care was met. ### CumulativeLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Total number of days for the admission. ### CurrentLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Level of care that the patient is receiving. ### DecisionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date by which the decision must be made for the request. ### DecisionDaysRemaining - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Number of days remaining for a decision or resolution. ### DecisionLetter - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The text of the determination letter sent to the member and provider. ### DecisionNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes related to the decision. ### DecisionReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for the decision. ### DecisionReasonDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Text describing the reason for the decision. ### DeniedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of days denied for the admission. ### DeniedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Level of care denied for the patient. ### DispositionNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes related to the disposition of the request. ### DueDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the request is due for completion. ### EffectiveFrom - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date for an effective-date range. ### EffectiveTo - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date for an effective-date range. ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Expiration date for the request. ### ExtensionRequestReceivedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time an extension was requested. ### ExternalComplaintIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Complaint ID number. ### FacilityRecordNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medical record number used to identify a patient. ### FacilityRoomBedType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of facility bed for the patient. ### FacilityRoomNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility room number for the patient. ### FinalLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Final level of care the patient. ### FirstReviewerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the person who reviewed the request. This is a relationship field. - **Relationship Name**: FirstReviewer - **Relationship Type**: Lookup - **Refers To**: User ### FirstReviewerNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes from the first reviewer related to the case. ### GeneralPractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Member's primary or general care practitioner. This is a relationship field. - **Relationship Name**: GeneralPractitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### GeneralPractitionerVerbalNotifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the primary care practitioner was verbally notified of the decision ### GeneralPractitionerWrittenNotifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the primary care practitioner was notified of the decision by written correspondence. ### GrievanceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of grievance. ### InfoReceivedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when additional information was received from the provider or member. ### InfoRequestedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when additional information was requested from the provider or member. ### InitialDenialNotificationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of initial denial notification. ### InitialDenialNotificationTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the initial care request was denied. ### IsExtendedRequest - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a request was extended. ### IsReadmission - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the care request is for a readmission. - **Default value**: false ### IsServiceOrMedicationReceived - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the member has already received the medial service or medication. ### 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. ### MedicalDirectorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the medical director who reviewed the request. This is a relationship field. - **Relationship Name**: MedicalDirector - **Relationship Type**: Lookup - **Refers To**: User ### MedicalDirectorNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes from the medical director related to the request. ### MemberCondition - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Free-form description of the member's condition. ### MemberContactDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the member was contacted. ### MemberDateOfBirth - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of birth of the member. ### MemberFirstName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First name of the member. ### MemberGender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Gender of the member. ### MemberGroupNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Insurance group number for the member. ### MemberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Insurance identifier for the member. This is a relationship field. - **Relationship Name**: Member - **Relationship Type**: Lookup - **Refers To**: Account ### MemberIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Insurance identification number for the member. ### MemberLastName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Last name of the member. ### MemberPrimaryPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary insurance plan of a member associated with the care request when the member is insured under multiple plans. This is a relationship field. - **Relationship Name**: MemberPrimaryPlan - **Relationship Type**: Lookup - **Refers To**: MemberPlan ### MemberPrognosis - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicator of the provider's prognosis for the member. ### MemberSecondaryPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The secondary insurance plan of a member associated with the care request when the member is insured under multiple plans. This is a relationship field. - **Relationship Name**: MemberSecondaryPlan - **Relationship Type**: Lookup - **Refers To**: MemberPlan ### MemberStatus - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The member's status at admission, date of outpatient service, or start of care. ### MemberVerbalNotificationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the member was verbally notified of the decision. ### MemberWrittenNotificationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the member was notified of the decision by written correspondence. ### ModificationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the case was modified. ### ModifiedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified number of days for the admission. ### ModifiedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified level of care for the patient. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the care request. ### NextReviewDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the next review is scheduled for completion. ### OriginalDenialMedicalDirectorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the medical director who denied the original request. This is a relationship field. - **Relationship Name**: OriginalDenialMedicalDirector - **Relationship Type**: Lookup - **Refers To**: User ### ParProvider - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicator of whether this provider has entered into an agreement with the insurance carrier. ### PlaceOfService - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Place of service for the member's care such as an inpatient hospital or an ambulatory surgery center. ### PractitionerContactDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the provider was contacted. ### QuantityType - **Type**: picklist - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Quantity type for the request such as days, units, or visits. ### ReceivedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the request was received. ### ReconsiderationDenialNotificationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the reconsidered care request was denied. ### ReconsiderationDenialNotificationTime - **Type**: time - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the reconsidered care request was denied. ### ReferenceCareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reference care request case number associated with the care request. This is a relationship field. - **Relationship Name**: ReferenceCareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### ReferenceCaseNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference authorization number for an appeal, complaint, or grievance. ### ReopenedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the request was reopened. ### ReopenReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason the request was reopened. The possible values are: - Administrative Error - Original Decision Overturned ### ReopenReasonDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of why the request was reopened. ### RequestedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the request was originally requested. ### RequestedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Requested number of days for the admission. ### RequestedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Requested level of care for the patient. ### RequesterType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the role of the individual initiating the request. ### RequestingPractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ordering or referring practitioner for the request. This is a relationship field. - **Relationship Name**: RequestingPractitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### RequestingPractitionerLicense - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: License type of the practitioner. ### RequestingPractitionerSpecialty - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specialty of the practitioner, for example, Family Practice or General Surgery. ### RequestingPractitionerVerbalNotifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the practitioner was verbally notified of the decision. ### RequestingPractitionerWrittenNotifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the practitioner was notified of the decision by written correspondence. ### ResolutionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the complaint, appeal, or grievance was resolved. ### ResolutionLetterSentDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when a resolution letter was sent to the requester. ### ResolutionNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Resolution notes for the request. ### ReviewDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date the review was completed. ### RootCauseNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Field for notes related to the root cause for the request. ### ScheduledAdmissionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Anticipated admission date for the patient. ### ScheduledDischargeDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Scheduled discharge date for the patient. ### ServiceDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date when patient received the service. ### ServicingFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Facility where the service is being provided. This is a relationship field. - **Relationship Name**: ServicingFacility - **Relationship Type**: Lookup - **Refers To**: Account ### ServicingPractitionerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Practitioner administering the service. This is a relationship field. - **Relationship Name**: ServicingPractitioner - **Relationship Type**: Lookup - **Refers To**: Contact ### ServicingPractitionerLicense - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: License type of the practitioner. ### ServicingPractitionerSpecialty - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specialty of the practitioner. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which this request was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the system from which the request was sourced. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the most recent update from the source 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. [CareRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 59.0) Change events are available for the object. [CareRequestFeed](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. [CareRequestHistory](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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 #### See Also - [_Second-Generation Managed Packaging Developer Guide_: Components Available in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm "Second-Generation Managed Packaging Developer Guide: Components Available in Managed Packages - HTML (New Window)") ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareRequestDrug Represents the details of a requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApprovedUnits - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Approved quantity of the drug. ### AssertionIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the coverage assertion. ### AuthApprovalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier assigned to the drug on approval of the authorization request. This field is available in API version 57.0 and later. ### AuthorizationRefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the authorization request associated with the requested drug. This field is available in API version 57.0 and later. ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Case related to the care request. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Care request for the care request drug. This is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Lookup - **Refers To**: CareRequest ### ClinicalDetermination - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical determination of the drug request. - **Possible values**: - Approved - Denied - Partially Approved - Stopped - Reduced - Suspended - Medical Director Review Pending ### ClinicalDeterminationNote - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The notes related to the clinical determination. ### ClinicalDeterminationReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the clinical determination. This is a relationship field. - **Relationship Name**: ClinicalDeterminationReason - **Relationship Type**: Lookup - **Refers To**: CodeSet ### Code - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the drug. ### CodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID code type for the drug. - **Possible values**: - NDC - RxNorm ### DaysSupply - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of days to supply the drug. ### DecisionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the decision was made for this drug request. ### DeniedUnits - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Denied quantity of the drug. ### DispenserAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: Pharmacy address. ### DispenserFaxNumber - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Pharmacy fax number. ### DispenserIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID for the pharmacy. ### DispenserName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID for the pharmacy. ### DispenserPhoneNumber - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Pharmacy phone number. ### DispenserTaxIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Pharmacy tax identification number. ### DispenserVerbalNotificationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the pharmacy or pharmacy benefit manager was contacted verbally. ### DispenserWrittenNotificationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when the pharmacy or pharmacy benefit manager was notified in writing or electronically. ### DispensingPharmacyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The pharmacy that dispenses the drug. This is a polymorphic relationship field. - **Relationship Name**: DispensingPharmacy - **Relationship Type**: Lookup - **Refers To**: Account, HealthcareProvider ### Dose - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Dose of the drug. ### DrugAdministrationSetting - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The setting where the drug is administered to the patient. This field is available in API version 57.0 and later. - **Possible values**: - Community - Discharge - Inpatient - Outpatient ### DrugCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set that defines the requested drug. This field is a polymorphic relationship field. - **Relationship Name**: DrugCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle This field is available in API version 58.0 and later. ### Frequency - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Frequency of the drug. ### 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. ### MedicationCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the care request drug. This is a relationship field. - **Relationship Name**: MedicationCode - **Relationship Type**: Lookup - **Refers To**: Medication ### MedicationRefObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication request or statement associated with the requested drug. This field is a polymorphic relationship field. - **Relationship Name**: MedicationRefObject - **Relationship Type**: Lookup - **Refers To**: MedicationRequest, MedicationStatement This field is available in API version 57.0 and later. ### ModifiedCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the modified drug. ### ModifiedCodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID code type for the modified drug. - **Possible values**: - NDC - RxNorm ### ModifiedDaysSupply - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of days of supply for the modified drug. ### ModifiedDose - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Dose of the modified drug. ### ModifiedFrequency - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Frequency of the modified drug. ### ModifiedName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the modified drug. ### ModifiedSig - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Directions for use of the modified drug. ### ModifiedStrength - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Strength of the modified drug. ### ModifiedTherapyDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Duration of therapy for the modified drug. ### ModifiedUnits - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modified quantity of the drug. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the drug. ### PrescriptionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date for the prescription. ### PrescriptionFillDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of fills for the prescription. ### PrescriptionFills - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of fills for the prescription. ### PrescriptionNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Drug prescription number. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the authorization for the requested drug. This field is available in API version 57.0 and later. - **Possible values**: - Routine - Stat - Urgent ### RequestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of drug request. This field is available in API version 57.0 and later. - **Possible values**: - Filler Order - Instance Order - Option - Order - Original Order - Plan - Proposal - Reflex Order ### RequiredResponseCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of responses required for the requested drug. ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response was sent for the drug request. ### ServiceCategory - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. ### ServiceCategoryCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Alphanumeric code that uniquely identifies a service type. ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service information response associated with the drug request. This field is a relationship field. - **Relationship Name**: ServiceInformationResponse - **Refers To**: ServiceInformationResponse ### ServicingFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility where a patient receives service of the requested drug. This field is a polymorphic relationship field. - **Relationship Name**: ServicingFacility - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, HealthcarePractitionerFacility This field is available in API version 57.0 and later. ### ServicingProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider who provides the service of the requested drug. This field is a relationship field. - **Relationship Name**: ServicingProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider This field is available in API version 57.0 and later. ### Sig - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Directions for use of the drug. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which this request was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the system from which the request was sourced. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the most recent update from the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authorization status of the requested drug. This field is available in API version 57.0 and later. - **Possible values**: - Active - Cancelled - Completed - Draft - Entered-in-Error - On-Hold - Stopped - Unknown ### StatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the action taken by the reviewer for the requested drug. This field is a relationship field. - **Relationship Name**: StatusCode - **Refers To**: CodeSetBundle ### StatusReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The reason for assigning the authorization status to the requested drug. This field is available in API version 57.0 and later. - **Possible values**: - Insufficient Information - Medically Not Required - Other ### Strength - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Strength of the drug. ### SubmittedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the drug request was submitted. ### TherapyDuration - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Duration of therapy for the drug. ### TransactionNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transaction number assigned to the drug request. ### Units - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Quantity of the drug. ## 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. [CareRequestDrugChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 59.0) Change events are available for the object. [CareRequestDrugFeed](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. [CareRequestDrugHistory](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. # CareRequestExchangeInfo Represents information about a care request exchange. 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 ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The care request that the exchange details are captured for. This field is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Master-detail - **Refers To**: CareRequest (the master object) ### ExchangeMode - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the mode of exchange. For example, X12 is the standard mode of exchange between an intermediary and a payer. - **Possible values**: - direct—Direct - ihe—IHE - other—Other - restful—RESTful - x12—X12 ### ExchangeTargetType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the target of the care request exchange. - **Possible values**: - Intermediary - Payer - Provider ### ExchangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of care request exchange. - **Possible values**: - cancel—Cancel - initial—Initial - initialDocToPayer—Initial Doc To Payer - query—Query - subsequent—Subsequent - update—Update ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### RequestDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the request was sent or received. ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response to the request was sent or received. ### ResponseStatusCode - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status code of the response. ## 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. [CareRequestExchangeInfoChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRequestExchangeInfoFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRequestExchangeInfoHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareRequestExtension Represents extra details for a care request such as the subscriber details for the member's health plan, home healthcare status, and ambulance transportation details. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AmbulanceTransportReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for ambulance transport. ### AmbulanceTransportType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of ambulance transport. ### AppealEffectuationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: 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. ### AuthorizationRefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the authorization request. This field is available in API version 57.0 and later. ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Case related to the care request extension. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Care request related to the care request extension. This is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Lookup - **Refers To**: CareRequest ### CaseSubStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The substatus of a case related to a care request. This field is available in API version 56.0 and later. - **Possible values**: - Approved - Auto Approved - Denied - More Information Requested - More Information Required - New Request - Partially Approved - Peer to Peer Review Scheduled - Pending Review - Schedule Peer to Peer Review ### ClientSourceSysIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An identifier of the client's source system that sent the care request. ### CoveragePlanTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of plan the member is covered by. This field is a relationship field. - **Relationship Name**: CoveragePlanType - **Refers To**: CodeSetBundle ### DocumentAttachmentStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of a clinical document upload. This field is available in API version 55.0 and later. - **Possible values**: - Complete - Incomplete ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider associated with the care request against whom the Grievance is filed This is a relationship field. - **Relationship Name**: HealthcareProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### HomeHealthCertificationEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Certification end date for home healthcare. ### HomeHealthCertificationStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Certification start date for home healthcare. ### HomeHealthStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date that home health services are scheduled or anticipated to start. ### IndependentReviewDetermination - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The determination made by the independent review. - **Possible values**: - Other - Overturned - Upheld ### IndependentReviewDeterminationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the determination was made by the independent review. ### IndependentReviewSubmissionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the review request was submitted for independent review. ### IsIndependentReviewRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an independent review is required - **Default value**: false ### IsMedicareCoverage - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the member has Medicare coverage. ### 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 request extension. ### NursingHomeResidentialStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Nursing home-resident status at the time of service. ### PriorDischargeStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the previous discharge status of the member. - **Possible values**: - Discharged to court/law enforcement. - Discharged to home with home health. - Discharged to home/self care. - Discharged to hospice care. - Discharged/transferred to LTACC. - Discharged/transferred to Psychiatric facility. - Discharged/transferred to SNF. - Discharged/transferred to other acute care facility. - Expired - Left against medical advice (AMA). ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Category type of the request. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### ReferenceCaseType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of reference case that's associated with the care request extension. This field is available in API version 58.0 and later. - **Possible values**: - Associated Case - Prior Case ### ReopenDecisionDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the decision on the reopen request was made. ### ReopenRequestOutcome - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The result of the reopen request. - **Possible values**: - Overturned - Upheld ### ReopenRequestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of reopen request. - **Possible values**: - Peer-to-Peer Review - Reconsideration ### RequestExtensionReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The reason for requesting the care extension. ### RequestExtnDecisionDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the decision to extend the care request extension was made. ### RequestOutcome - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the outcome of the request. - **Possible values**: - Overturned - Partially Pending - Partially Upheld - Upheld - Voided - Queued - Complete - Error ### RequestOutcomeDesc - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the request outcome. ### RequestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Category type of the request. - **Possible values**: - Admission Review - Concurrent Review - Health Services Review - Individual - Inpatient - Behavioral Health Review - Inpatient - Physical Health Review - Outpatient - Behavioral Health Review - Outpatient - Physical Health Review - Specialty Care Review ### RequestingProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider who requested a prior authorization for a care request. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: RequestingProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### ResolutionDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the care request. ### ServiceLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The level of service rendered. ### ServiceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Classification of the type of service. ### ServicingFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility where a patient receives service for a care request. This field is available in API version 55.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: ServicingFacility - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, HealthcarePractitionerFacility ### ServicingProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider who provides the service for a care request. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: ServicingProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### SubscriberId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier for the person who has subscribed to the health plan. This is a relationship field. - **Relationship Name**: Subscriber - **Relationship Type**: Lookup - **Refers To**: Account ### SubscriberMemberIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Member ID for the subscriber. ### SupportingDocUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL of supporting documentation such as a questionnaire. ### TotalAmbulanceTransportDistance - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total distance traveled during ambulance transport. ### UnitofMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the quantity associated with a prior authorization request. This field is available in API version 55.0 and later. 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. [CareRequestExtensionChangeEvent](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 62.0) Change events are available for the object. [CareRequestExtensionFeed](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. [CareRequestExtensionHistory](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. # CareRequestItem Represents 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AmbulanceTransportDistance - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Distance traveled during ambulance transport. ### AmbulanceTransportReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for ambulance transport. ### AmbulanceTransportType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of ambulance transport. ### ApprovedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days requested for the admission. ### ApprovedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the approved level of care for the patient. - **Possible values**: - Hospital - Inpatient - Hospital - Intensive Care - Hospital - Rehabilitation - Psychiatric Intensive Care - Psychiatric Room - Semi-private - Psychiatric Room and Board - Private - Psychiatric Ward - SNF - Inpatient - SNF - Rehabilitation - SNF - Specialized Care ### ApprovedQuantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The approved quantity of the care item. ### ApprovedServiceEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the approved service that the patient received. ### ApprovedServiceStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the approved service that the patient received. ### AssertionIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the requested item in the coverage information. ### AuthApprovalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier assigned to the item on approval of the authorization request. This field is available in API version 57.0 and later. ### AuthorizationRefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the authorization request associated with the requested item. This field is available in API version 57.0 and later. ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Case related to the care request. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Care request for the care request item. This is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Lookup - **Refers To**: CareRequest ### ClinicalDetermination - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical determination of the care request. - **Possible values**: - Approved - Denied - Medical Director Review Pending - Partially Approved - Reduced - Stopped - Suspended ### ClinicalDeterminationNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The notes related to the clinical determination. ### ClinicalDeterminationReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the clinical determination. This field is a relationship field. - **Relationship Name**: ClinicalDeterminationReason - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical service request associated with the care request item. This field is a relationship field. - **Relationship Name**: ClinicalServiceRequest - **Relationship Type**: Lookup - **Refers To**: ClinicalServiceRequest This field is available in API version 57.0 and later. ### CodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the denied service code. ### CodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code type for the service. ### CodeTypeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the service. ### CumulativeLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days a patient is admitted. ### CurrentLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the level of care the patient is receiving. - **Possible values**: - Hospital - Inpatient - Hospital - Intensive Care - Hospital - Rehabilitation - Psychiatric Intensive Care - Psychiatric Room - Semi-private - Psychiatric Room and Board - Private - Psychiatric Ward - SNF - Inpatient - SNF - Rehabilitation - SNF - Specialized Care ### DecisionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the last decision was made for this care request item. ### DeniedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The level of care denied for the patient. - **Possible values**: - Hospital - Inpatient - Hospital - Intensive Care - Hospital - Rehabilitation - Psychiatric Intensive Care - Psychiatric Room - Semi-private - Psychiatric Room and Board - Private - Psychiatric Ward - SNF - Inpatient - SNF - Rehabilitation - SNF - Specialized Care ### DeniedQuantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of the denied service. ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective date for the diagnosis. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for the service. ### FreeFormProcedureDescription - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Free-form description of the procedure. ### 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. ### ModifiedCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the modified service code. ### ModifiedCodeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code for the modified service. ### ModifiedCodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code type for the modified service. ### ModifiedCodeTypeIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the code type for the modified service. ### ModifiedEffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective date for the modified service. ### ModifiedEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Termination date for the modified service. ### ModifiedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the modified level of care for the patient. - **Possible values**: - Hospital - Inpatient - Hospital - Intensive Care - Hospital - Rehabilitation - Psychiatric Intensive Care - Psychiatric Room - Semi-private - Psychiatric Room and Board - Private - Psychiatric Ward - SNF - Inpatient - SNF - Rehabilitation - SNF - Specialized Care ### ModifiedModifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modifier for modified service code. ### ModifiedModifierDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modifier description for modified service code. ### ModifiedProcedureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the modified service, drug, or equipment. ModifiedProcedureCodeId will be deprecated in a future release, so use ModifiedProcedureCodeSetId instead. This is a relationship field. - **Relationship Name**: ModifiedProcedureCode - **Relationship Type**: Lookup - **Refers To**: HealthCareProcedure ### ModifiedProcedureCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set for the modified service, drug, or device associated with the care request item. This is a polymorphic relationship field. - **Relationship Name**: ModifiedProcedureCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### ModifiedQuantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The modified quantity of requested care. ### Modifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Modifier for the service code. ### Modifier2 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second modifier for service code. ### Modifier2Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the second modifier for the service code. ### Modifier3 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Third modifier for service code. ### Modifier3Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the third modifier for the service code. ### Modifier4 - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fourth modifier for service code. ### Modifier4Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the fourth modifier for the service code. ### ModifierCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The modifier code set for the service code associated with the care request item. This is a polymorphic relationship field. - **Relationship Name**: ModifierCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### ModifierDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the modifier for the service code ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: ID of the service code. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the authorization for the requested item. This field is available in API version 57.0 and later. - **Possible values**: - Routine - Stat - Urgent ### ProcedureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the service, drug, or equipment. ProcedureCodeId will be deprecated in a future release, so use ProcedureCodeSetId instead. This is a relationship field. - **Relationship Name**: ProcedureCode - **Relationship Type**: Lookup - **Refers To**: HealthCareProcedure ### ProcedureCodeSetId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set for the service, drug, or device associated with the care request item. This is a polymorphic relationship field. - **Relationship Name**: ProcedureCodeSet - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### Quantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quantity of the item that is requested. ### QuantityType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Quantity type for the request such as days, units, or visits. ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for requesting the item. This field is a polymorphic relationship field. - **Relationship Name**: ReasonCode - **Relationship Type**: Lookup - **Refers To**: CareDiagnosis, CodeSet, CodeSetBundle This field is available in API version 57.0 and later. ### RequestType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of item request. This field is available in API version 57.0 and later. - **Possible values**: - Filler Order - Instance Order - Option - Order - Original Order - Plan - Proposal - Reflex Order ### RequestedLengthOfStay - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of days requested for the admission. ### RequestedLevelOfCare - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the requested level of care for the patient. - **Possible values**: - Hospital - Inpatient - Hospital - Intensive Care - Hospital - Rehabilitation - Psychiatric Intensive Care - Psychiatric Room - Semi-private - Psychiatric Room and Board - Private - Psychiatric Ward - SNF - Inpatient - SNF - Rehabilitation - SNF - Specialized Care ### RequestedServiceEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the requested service. ### RequestedServiceStartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date of the requested service. ### RequiredResponseCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of responses required for the requested item. ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response was sent for the requested item. ### ServiceCategory - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory. ### ServiceCategoryCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Alphanumeric code that uniquely identifies a service type ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service information response associated with the requested item. This field is a relationship field. - **Relationship Name**: ServiceInformationResponse - **Refers To**: ServiceInformationResponse ### ServicingFacilityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The facility where a patient receives service of the requested item. This field is a polymorphic relationship field. - **Relationship Name**: ServicingFacility - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, HealthcarePractitionerFacility This field is available in API version 57.0 and later. ### ServicingProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The healthcare provider who provides the service of the requested item. This field is a relationship field. - **Relationship Name**: ServicingProvider - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider This field is available in API version 57.0 and later. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System from which the request was sourced. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the system from which the request was sourced. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the most recent update from the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authorization status of this service. ### StatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the action taken by the reviewer for the requested item. This field is a relationship field. - **Relationship Name**: StatusCode - **Refers To**: CodeSetBundle ### StatusReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reason for the authorization status of this service. ### SubmittedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the item request was submitted. ### TransactionNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The transaction number assigned to the request. ### TransportLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Destination location for ambulance transport. This is a relationship field. - **Relationship Name**: TransportLocation - **Relationship Type**: Lookup - **Refers To**: 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. [CareRequestItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm) (API version 59.0) Change events are available for the object. [CareRequestItemFeed](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. [CareRequestItemHistory](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. # CareRequestReviewer Represents the details of a care request reviewer including name, reviewer type, status of the care request at the end of the review, the reviewer’s notes, and date of review. A care request, care request item, care request drug, or care diagnosis can be associated with a care request reviewer. 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 ### CareRequestCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The case related to the care request. This is a relationship field. - **Relationship Name**: CareRequestCase - **Relationship Type**: Lookup - **Refers To**: Case ### CareRequestReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care request, care request item, care request drug, or care diagnosis associated with the care request reviewer. This is a polymorphic relationship field. - **Relationship Name**: CareRequestReference - **Relationship Type**: Lookup - **Refers To**: CareDiagnosis, CareRequest, CareRequestDrug, CareRequestItem ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The content document that's attached to the reviewer note. This field is a relationship field. - **Relationship Name**: ContentDocument - **Relationship Type**: Lookup - **Refers To**: ContentDocument This field is available in API version 56.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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name associated with the record. ### ReviewDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the care request was reviewed. ### ReviewerId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the user who reviewed the care request. This is a polymorphic relationship field. - **Relationship Name**: Reviewer - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider, User ### ReviewerNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The notes related to the review. ### ReviewerType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the reviewer who reviewed the care request. - **Default value**: Registered Nurse Review - **Possible values**: - Medical Director Review - Peer Review - Physician Review - Registered Nurse Review ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the care request. - **Default value**: Approved - **Possible values**: - Approved - Denied - In 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. [CareRequestReviewerChangeEvent](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 62.0) Change events are available for the object. [CareRequestReviewerFeed](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. [CareRequestReviewerHistory](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. # CareRequestSupportingCntnt Represents details about supporting content of a care request such as assessments or content documents. 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 ### CareRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The care request that the supporting content is captured for. This field is a relationship field. - **Relationship Name**: CareRequest - **Relationship Type**: Master-detail - **Refers To**: CareRequest (the master object) ### CategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code representing the category that the supporting content belongs to. This field is a relationship field. - **Relationship Name**: CategoryCode - **Refers To**: CodeSetBundle ### InformationTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code respresenting the type of supporting content added to the care request. This field is a relationship field. - **Relationship Name**: InformationTypeCode - **Refers To**: CodeSetBundle ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### ReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code representing the reason why the supporting content is required. This field is a relationship field. - **Relationship Name**: ReasonCode - **Refers To**: CodeSetBundle ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The assessment or content document used as the supporting content. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Assessment, ContentDocument ### RequestedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the supporting content was requested. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence number of the content when multiple contents are available. ### SubmissionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the channel that's used to submit the supporting content. - **Possible values**: - CDex - Fax - Other - Portal - X12 ### SubmittedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the supporting content was 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. [CareRequestSupportingCntntChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRequestSupportingCntntFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareRequestSupportingCntntHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareServiceVisit Associates a service request or a referral request (ClinicalServiceRequest) with a visit (ServiceAppointment) that’s part of that service or referral. 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 ID of the account associated with the patient who received the care service. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account This field is available in API version 59.0 and later. ### AutoVerifiedVisitEndDtTm - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the care service visit that's automatically updated from the care giver's mobile device. This field is available in API version 59.0 and later. ### AutoVrfyVisitEndLoc - **Type**: location - **Properties**: Nillable - **Description**: The end location of the care service visit that's automatically updated from the care giver's mobile device. This field is available in API version 59.0 and later. ### AutoVrfyVisitStartDtTm - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the care service visit that's automatically updated from the care giver's mobile device. This field is available in API version 59.0 and later. ### AutoVrfyVstStartLoc - **Type**: location - **Properties**: Nillable - **Description**: The start location of the care service visit that's automatically updated from the care giver's mobile device. This field is available in API version 59.0 and later. ### CarePlanContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care plan, care plan detail, goal assignment, or action plan associated with the care service visit. This field is a polymorphic relationship field. - **Relationship Name**: CarePlanContext - **Relationship Type**: Lookup - **Refers To**: ActionPlan, CarePlan, CarePlanDetail, GoalAssignment, GoalAssignmentDetail This field is available in API version 59.0 and later. ### CareServiceVisitPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care service visit plan associated with the care service visit. This field is a relationship field. - **Relationship Name**: CareServiceVisitPlan - **Relationship Type**: Lookup - **Refers To**: CareServiceVisitPlan This field is available in API version 59.0 and later. ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The service request that the visit is related to. - **Relationship Name**: ClinicalServiceRequest - **Refers To**: ClinicalServiceRequest ### EndedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care giver who ends the care service visit. This field is a relationship field. - **Relationship Name**: EndedBy - **Relationship Type**: Lookup - **Refers To**: ServiceResource This field is available in API version 59.0 and later. ### 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. ### ManVerifiedVisitEndDtTm - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the care service visit that's verified and updated by a care professional from the Home Health agency. This field is available in API version 59.0 and later. ### ManVerifiedVisitStartDtTm - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the care service visit that's verified and updated by a care professional from the Home Health agency. This field is available in API version 59.0 and later. ### ManVrfyVisitEndLoc - **Type**: location - **Properties**: Nillable - **Description**: The end location of the care service visit that's verified and updated by a care professional from the Home Health agency. This field is available in API version 59.0 and later. ### ManVrfyVisitStartLoc - **Type**: location - **Properties**: Nillable - **Description**: The start location of the care service visit that's verified and updated by a care professional from the Home Health agency. This field is available in API version 59.0 and later. ### 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 owner of the record. - **Relationship Name**: Owner - **Refers To**: - Group - User ### RelatedVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the ID of a related care service visit that’s associated with a care service visit. This field is a relationship field. - **Relationship Name**: RelatedVisit - **Relationship Type**: Lookup - **Refers To**: CareServiceVisit This field is available in API version 60.0 and later. ### RelatedVisitType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of related visit that's associated with the care service visit. This field is available in API version 60.0 and later. - **Possible values**: - Dependent - None ### SchedulingInputs - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The inputs specified by the scheduler to schedule the home visits such as clinical service request, work type, and more. ### ServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A derived field that’s used for internal purposes. This field is a polymorphic relationship field. - **Relationship Name**: ServiceRequest - **Refers To**: ClinicalServiceRequest ### SourceReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quote or party appointment request that's the source of the care service visit. This field is a polymorphic relationship field. - **Relationship Name**: SourceReferenceRecord - **Refers To**: PartyAppointmentRequest This field is available in API version 62.0 and later. ### StartedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care giver who starts the care service visit. This field is a relationship field. - **Relationship Name**: StartedBy - **Relationship Type**: Lookup - **Refers To**: ServiceResource This field is available in API version 59.0 and later. ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit that’s related to the service request. This field is a relationship field. - **Relationship Name**: Visit - **Refers To**: ServiceAppointment ### VisitType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of the care service visit. This field is available in API version 59.0 and later. - **Possible values**: - Assessment - Recurring - StartOfCare ## 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. [CareServiceVisitChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareServiceVisitPlan Associates a service request with the series of visits that are planned as part of that visit. The series of visits is represented using MaintenancePlan. 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 ### ApprovedVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of approved visits in the planned care service. This field is available in API version 59.0 and later. ### AssignedVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of visits assigned with resources in a planned service. ### AuthorizationReferenceId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care request item that’s the record of authorization for the visit. - **Relationship Name**: AuthorizationReference - **Refers To**: CareRequestItem ### CanAutoscheduleVisits - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the next series of recurring home visits is automatically scheduled when the current set ends. - **Default value**: false ### CarePlanContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the care plan, care plan detail, goal assignment, or action plan associated with the care service visit. This field is a polymorphic relationship field. - **Relationship Name**: CarePlanContext - **Relationship Type**: Lookup - **Refers To**: ActionPlan, CarePlan, CarePlanDetail, GoalAssignment, GoalAssignmentDetail This field is available in API version 59.0 and later. ### ClinicalServiceRequestId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The request for the service. - **Relationship Name**: ClinicalServiceRequest - **Refers To**: ClinicalServiceRequest ### CompletedVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of visits that have been completed as part of the service. ### CreatedVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of created visits in the planned care service. This field is available in API version 59.0 and later. ### FirstVisitStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the first visit in the set of recurring home visits. ### IsServiceAuthorizationRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the service has to be authorized before it’s provided. - **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. ### LastVisitStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the last visit in the set of recurring home visits. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the 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 ### SchedulingInputs - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The inputs specified by the scheduler to schedule the home visits such as clinical service request, work type, and more. ### ServiceRequestId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service request for the service. - **Relationship Name**: ServiceRequest - **Refers To**: ClinicalServiceRequest ### UnassignedVisitCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The number of unassigned visits in a planned service. ### VisitPlanId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The series of visits planned for a service. - **Relationship Name**: VisitPlan - **Refers To**: MaintenancePlan ## 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. [CareServiceVisitPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareServiceVisitPlanShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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() #### See Also - [Care Program Enrollments (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_careprogram_enrollment_intro.htm "Use this API to enroll multiple patients in a care program.") - [Enrollments](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resource_enroll-pantients.htm "Enroll multiple patients into a care program.") - [_Second-Generation Managed Packaging Developer Guide_: Components Available in Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/packaging_packageable_components.htm "Second-Generation Managed Packaging Developer Guide: Components Available in Managed Packages - HTML (New Window)") ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareTask Represents additional information about a healthcare-related task such as process status, beneficiary, and related tasks. 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**: A name or code that describes the task. This field is a polymorphic relationship field. - **Relationship Name**: ActionCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### ActualEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the task ends. ### ActualStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the task starts. ### BeneficiaryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The party who benefits from the task. This field is a polymorphic relationship field. - **Relationship Name**: Beneficiary - **Relationship Type**: Lookup - **Refers To**: Account, HealthcareProvider ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated clinical encounter for which the task was created. This field is a relationship field. - **Relationship Name**: ClinicalEncounter - **Relationship Type**: Lookup - **Refers To**: ClinicalEncounter ### ContentResource - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the endpoints or URLs to relevant educational resources such as PDFs. ### ExpectedEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the task is expected to end. ### ExpectedStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the task is expected to start. ### ExtlTaskDefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID or URL of the external task definition in the source system. ### GroupIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The shared ID of multiple independent tasks. ### 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. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the task is performed. This field is a polymorphic relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: HealthcareFacility, Location ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the care task record. ### OwnedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The party who's responsible for executing the task. This field is a polymorphic relationship field. - **Relationship Name**: OwnedBy - **Relationship Type**: Lookup - **Refers To**: Account, CareRegisteredDevice, Contact, User ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the care task record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ParentCareTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated care task. This field is a relationship field. - **Relationship Name**: ParentCareTask - **Relationship Type**: Lookup - **Refers To**: CareTask ### ProcessStatusId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business-specific process status of the task. This field is a polymorphic relationship field. - **Relationship Name**: ProcessStatus - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### RequestedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The party who created the task. This field is a polymorphic relationship field. - **Relationship Name**: RequestedBy - **Relationship Type**: Lookup - **Refers To**: Account, CareRegisteredDevice, Contact, HealthcareProvider, User ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence number in which the task is performed. ### ShouldIgnore - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the action specified in the task should be ignored or performed. - **Default value**: false ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the external source system. ### SourceSystemModifiedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the 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. ### StatusReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the status of the task. ### TaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The task associated with the care task. This field is a relationship field. - **Relationship Name**: Task - **Relationship Type**: Lookup - **Refers To**: 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. [CareTaskChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareTaskFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareTaskHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareTaskShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CareTaskDetail Represents extra details about a healthcare-related task such as the detail type, detail record, detail code, and detail value. 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 ### CareTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The care task associated with the care task detail. This field is a relationship field. - **Relationship Name**: CareTask - **Relationship Type**: Master-detail - **Refers To**: CareTask (the master object) ### DetailType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of information you're adding to the care task record. - **Default value**: BasedOn - **Possible values**: - ActualPerformer—Actual Performer - BasedOn—Based On - ExpectedPerformer—Expected Performer - InputType—Input Type - Insurance - OutputType—Output Type - Reason ### 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 care task 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. [CareTaskDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareTaskDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CareTaskDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CaseRelatedFile Represents the details of a file attached to a case, such as file properties, file processing details, and other additional relevant information. 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 ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The case associated with the case related file. This field is a relationship field. - **Relationship Name**: Case - **Relationship Type**: Master-detail - **Refers To**: Case (the master object) ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The content document associated with the case related file. This field is a relationship field. - **Relationship Name**: ContentDocument - **Refers To**: ContentDocument ### 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 case related file. ### ProcessDefinitionReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The batch calc job definition associated with the case related file. This field is a relationship field. - **Relationship Name**: ProcessDefinitionReference - **Refers To**: BatchCalcJobDefinition ### ProcessStage - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the stages during processing. - **Possible values**: - Mapping - Processing - Staging ### ProcessStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the case related file during processing. - **Possible values**: - Complete - Failed - InProgress - InReview ### SourceDatasetName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source dataset for processing. ### TargetDatasetName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the target data created through the transformation of the source dataset. ## 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. [CaseRelatedFileChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CaseRelatedFileHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CategorizedCareFeeAgreement Specifies the payment terms for contracts of Categorized Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CategorizedCareFeeAgreeKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key assigned to the Categorized Care Fee Agreement record. ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this categorized care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the procedure category. ### 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. ### LineofBusiness - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The line of business for which the agreed upon fee is applicable. - **Possible values**: - Commercial - Medi-Cal - Medicare ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the categorized care fee agreement. ### PricingInformation - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The agreed upon fee for the procedure category. ### ProcedureCategory - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The category of procedures covered in the Categorized Care Fee Agreement, such as Immunization. ## 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. [CategorizedCareFeeAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CategorizedCareFeeAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [CategorizedCareFeeAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # Census Bulk Upload Status (GET) Retrieves the processing status of a census bulk upload request. ## Resource /connect/health/digital-health-insurance/census-bulk-upload-status ## Available Version 67.0 ## HTTP Methods GET ## Request Parameters for GET | Parameter Name | Type | Description | Required | | --- | --- | --- | --- | | request​Id | String | The ID of the bulk upload request to check. | Required | ## Response Body for GET [Census Bulk Upload Status Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_census_bulk_upload_status_output.htm "The status information for a census bulk upload request.") # Census Bulk Upload Status Output The status information for a census bulk upload request. ## Properties | Property Name | Type | Description | | --- | --- | --- | | status | String | The current status of the upload (for example, Completed). | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[ActivityTiming](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_activitytiming.htm)** 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. - **[AllergyIntolerance](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[AuthorNote](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_authornote.htm)** 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. - **[CareObservation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_CareObservation.htm)** Represents the observed values for care metrics originating from external systems that contain biometric data. This object is available in API version 49.0 and later. - **[CarePerformer](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[CareRegisteredDevice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_careregistereddevice.htm)** 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. - **[DiagnosticSummary](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[ClinicalAlert](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[ClinicalDetectedIssue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalDetectedIssue.htm)** Represents information about a detected issue resulting from a clinical activity. This object is available in API version 55.0 and later. - **[ClinicalDetectedIssueDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_ClinicalDetectedIssueDetail.htm)** Represents additional information about a clinical detected issue. This object is available in API version 55.0 and later. - **[ClinicalEncounter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[ClinicalServiceRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[CodeSet](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[CodeSetBundle](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[ContactProfile](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_contactprofile.htm)** Represents information about an individual, such as their ethnicity, citizenship, birth place, race, and so on. This object is available in API version 57.0 and later. - **[HealthcareFacility](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[HealthCondition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[HealthPlanFacilityNetwork](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthplanfacilitynetwork.htm)** Represents the association between an insurance product or plan and a designated healthcare facility network. This entity is fundamental in healthcare management, allowing insurers and providers to accurately determine which facilities are in-network for a given patient's plan, facilitating eligibility checks and service coordination. This object is available in API version 68.0 and later. - **[HealthPlanFormularyItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthplanformularyitem.htm)** Represents which drugs, medical devices, or services are covered under specific insurance products within defined time periods. Each record establishes a relationship between Product2 insurance plans and FormularyItem records. This object is available in API version 68.0 and later. - **[HealthRiskEvaluation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_healthriskevaluation.htm)** Represents the evaluation of health risks. This object is available in API version 64.0 and later. - **[HealthRiskEvalDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_healthriskevaldetail.htm)** Represents additional details of a health risk evaluation, including the basis and reason for the evaluation. This object is available in API version 64.0 and later. - **[HealthRiskEvalOutcome](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_healthriskevaloutcome.htm)** Represents the outcome of a risk evaluation, such as the probability of disease occurrence. This object is available in API version 64.0 and later. - **[Identifier](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_Identifier.htm)** Represents identifier information for multiple objects. This object is available in API version 51.0 and later. - **[Medication](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_Medication.htm)** Represents detailed information about different medications. This object is available in API version 51.0 and later. - **[MedicationAdministration](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_objects_medicationadministration.htm)** Represents an instance of medication administered to a patient. This object is available in API version 64.0 and later. - **[MedicationDispense](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_medicationdispense.htm)** 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. - **[MedicationRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[OpportunityProductCategory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_opportunityproductcategory.htm)** Represents the junction between an Opportunity and the specific Medicare product categories the beneficiary has authorized for discussion. Each record represents one Medicare Part (e.g., Part A, Part C, Part D) included in the scope. This object is available in API version 68.0 and later. - **[PatientHealthReaction](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PatientHealthReaction.htm)** Represents a patient’s adverse reaction to an allergy, intolerance, or immunization. This object is available in API version 51.0 and later. - **[PatientImmunization](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PatientImmunization.htm)** Represents information about a patient’s immunizations. This object is available in API version 51.0 and later. - **[PatientMedicalProcedure](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[PatientMedicationDosage](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[PersonLanguage](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PersonLanguage.htm)** Represents the use and preference information about a person’s language. This object is available in API version 51.0 and later. - **[PersonName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PersonName.htm)** Represents detailed information about a person’s name. This object is available in API version 51.0 and later. - **[ProblemDefRelationship](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_objects_problemdefrelationship.htm)** Represents a junction between a problem definition and a related problem definition. This object is available in API version 64.0 and later. - **[Specimen](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_objects_specimen.htm)** Represents a sample used for analysis. This object is available in API version 64.0 and later. #### See Also - [Mapping FHIR v4.0 to Salesforce Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_overview.htm "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.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ClinicalAssessmentResponse\_\_c Represents the results of an assessment of a patient’s health condition. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AbdominalPain\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing abdominal pain. ### CardiovascularDisease\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of cardiovascular disease. ### Chills\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing chills. ### ChronicLiverDisease\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of chronic liver disease. ### ChronicLungDisease\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of chronic lung disease. ### ChronicRenalDisease\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of chronic renal disease. ### Cough\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing new or chronic coughing. ### CurrentSmoker\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient currently smokes. ### DiabetesMellitus\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of Diabetes Mellitus. ### Diarrhoea\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing diarrhea. ### FeverOverThreshold\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing a fever that’s above a given temperature threshold. ### FormerSmoker\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient previously smoked, but no longer does. ### Headache\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient is experiencing a headache. ### HighestRecordedTemperature\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The highest recorded temperature in Fahrenheit. ### HospitalizationStatus\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status describing whether the person was admitted to the hospital. - **Possible values**: - Admitted - Not\_Admitted—Not Admitted - Unknown ### Immunocompromised\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient is immunocompromised. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. ### MuscleAches\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient is experiencing muscle aches (myalgia). ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The name of this clinical assessment response. ### NauseaOrVomiting\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing nausea or vomiting. ### NeurologicalDisablity\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of a specific neurological disability. ### NeurologicalDisablityNotes\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional text describing the patient’s neurological condition. ### Occupation\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Occupation of the individual. - **Possible values**: - Childcare workers—Childcare worker - Clinical laboratory technologists and technicians—Clinical laboratory technologist or technician - Combined food preparation and serving workers, including fast food—Combined food preparation or serving worker, including fast food - Dentists—Dentist - Emergency management directors—Emergency management director - Emergency medical technicians and paramedics—Emergency medical technician or paramedic - Health practitioner support technologists and technicians—Health practitioner support technologist or technician - Healthcare support workers, all other, including medical equipment preparers—Healthcare support worker (including medical equipment preparer) - Other ### OnsetOfSymptoms\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the symptoms started. ### OtherChronicDiseases\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has a history of any other chronic diseases. ### OtherChronicDiseasesNotes\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional text describing the patient’s other chronic diseases. ### OtherSymptoms\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing any other symptoms not specified on the assessment form. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. ### ParentalConsent\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether consent was provided to interview a minor. ### Patient\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The person account of the individual whose health condition is described in the assessment. ### PrimaryCarePhysician\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the person's primary care physician. ### ProviderFacilityName\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the provider of healthcare services such as the hospital, clinic, or medical practitioner other than a primary care physician. ### RunnyNose\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing a runny nose. ### ShortnessOfBreath\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing shortness of breath. ### SoreThroat\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has been experiencing a sore throat. ### SubjectiveFever\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text describing whether the patient has felt feverish, even if body temperature was not measured. ### TestingFacilityName\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the facility where the testing was done. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | - **[ClinicalEncounterDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ClinicalEncounter for Intelligent Appointment Management 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. Multiple features use this object. See [ClinicalEncounter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ClinicalMeasure Represents a structured and computable definition of a health-related measure for identifying care gaps. 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 ### ApplicationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The application used for calculating the measure. ### ApplicationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of application used for calculating the measure. - **Possible values**: - Apex - Custom - ExpressionSet—Expression Set - Flow - IntegrationProcedure—Integration Procedure ### Author - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual or organization that primarily authored the measure. ### ClinicalRcmdSummary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A summary of relevant clinical guidelines or other clinical recommendations supporting the measure. ### ClinicalUsage - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of how the measure is used. ### CompositeScoringType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The scoring method used to combine the component measures to determine the composite score. - **Possible values**: - All-Or-Nothing - Linear - Opportunity - Weighted ### CopyrightLabel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The copyright label of a measure. ### CopyrightStatement - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A copyright statement of the measure and/or its contents. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the measure. ### Disclaimer - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A disclaimer for the use of the measure or its referenced content. ### Editor - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual or organization responsible for editing the measure. ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The end date of a measure evaluation period. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date of a measure evaluation period. ### Endorser - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual or organization responsible for endorsing the measure. ### IntendedJurisdictionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The legal or geographic region where the measure is intended to be used. This field is a polymorphic relationship field. - **Relationship Name**: IntendedJurisdictionCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### IsExperimental - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a measure was authored for experimental purposes (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. ### LastReviewedDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the measure was last reviewed. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed the record. ### MeasureCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the high-level category that the measure belongs to, such as Assessment or Treatment. - **Possible values**: - Assessment - Education - Treatment ### MeasureType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the measure type based on what the measure calculates. - **Possible values**: - Composite - Outcome - Patient-Reported-Outcome - Process - Structure ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: A human-friendly name for a measure. ### 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 ### PopulationBasisTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the population basis type for a measure when the basis is different from the subject. This field is a relationship field. - **Relationship Name**: PopulationBasisTypeCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The problem definition associated with the measure. This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Lookup - **Refers To**: ProblemDefinition ### PublisherApprovalDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date the measure was approved by the publisher. ### PublisherContact - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The contact details of the publisher. ### PublisherName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The individual or organization that publishes and maintains the measure. ### Purpose - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A short explanation of why a measure is needed. ### Rationale - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A detailed reason for why the measure exists, inlcuding its objective and impact. ### RelatedResources - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Supplementary resources or materials supporting a measure, such as additional documentation and citations. ### Reviewer - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual or organization responsible for reviewing the measure. ### RiskAdjustmentMethod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the adjustment method for risks, such as clinical severity and conditions present at the start of care that may influence measure scores. ### ScoreAggregationMethod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the method used to combine the different measure scores of each population into one aggregated result. ### ScoreImprovementIndication - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether an increase or decrease in score is the preferred result for a measure. - **Possible values**: - Decrease - Increase ### ScoringType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The scoring type used for calculating the measure. - **Possible values**: - Cohort - Continuous Variable - Proportion - Ratio ### ScoringUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifes the expected unit of measure for the measure score when the unit can't be inferred from the measure logic. This field is a relationship field. - **Relationship Name**: ScoringUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external system of record. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record in the source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the record was last modified in the source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of a measure, such as draft, active, retired, or unknown. - **Possible values**: - Active - Draft - Retired - Unknown ### SubjectCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subject category that the measure is intended for. - **Possible values**: - Device - Location - Organization - Patient - Practitioner - RelatedPerson ### Subtitle - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A subtitle for a measure, adding additonal context. ### SupportedContext - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The context that the measure is intended to support. ### SystemReadableName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A computer-friendly name for a measure. ### TermCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies description of an individual term used within the measure. This field is a relationship field. - **Relationship Name**: TermCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### VersionNumber - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The version of a measure that is managed by the author. ## 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. [ClinicalMeasureFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ClinicalMeasureCriteria Represents a computable criteria of a health-related measure. 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 ### AggregateMethodType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The aggregation method used for a measure score. - **Possible values**: - Average - Count - Maximum - Median - Minimum - Sum ### CriteriaCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code of the criteria. This field is a polymorphic relationship field. - **Relationship Name**: CriteriaCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### CriteriaExpression - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expression used to define the criteria. ### CriteriaType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of criteria that the measure checks for. - **Possible values**: - PopulationCriteria—Population Criteria - StratifierCriteria—Stratifier Criteria - StratifierCriteriaComponent—Stratifier Criteria Component - SupplementalData—Supplemental Data ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the criteria. ### 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 clinical measure criteria. ### 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 ### ParentCriteriaId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The associated parent criteria record. This field is a relationship field. - **Relationship Name**: ParentCriteria - **Relationship Type**: Lookup - **Refers To**: ClinicalMeasureCriteria ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The reference record of the object that is associated with the criteria. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Relationship Type**: Lookup - **Refers To**: ClinicalMeasure, ClinicalMeasureCriteriaGrp ## 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. [ClinicalMeasureCriteriaFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureCriteriaHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureCriteriaShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ClinicalMeasureCriteriaGrp Represents a group of computable criteria for a health-related measure. 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 ### ClinicalMeasureId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The clinical measure that the criteria group belongs to. This field is a relationship field. - **Relationship Name**: ClinicalMeasure - **Relationship Type**: Lookup - **Refers To**: ClinicalMeasure ### CriteriaGroupCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique code associated with the clinical measure criteria group. This field is a polymorphic relationship field. - **Relationship Name**: CriteriaGroupCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the clinical measure criteria 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. ### MeasureType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the measure type the criteria group belongs to based on what the measure calculates. - **Possible values**: - Composite - Outcome - Patient-Reported-Outcome - Process - Structure ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the clinical measure criteria group. ### PopulationBasisTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the population basis type for a measure the criteria group belongs to, when the basis is different from the subject. This field is a relationship field. - **Relationship Name**: PopulationBasisTypeCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### ProgramName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The program used for calculating the measure that the criteria group belongs to. ### ProgramType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of program used for calculating the measure that the criteria group belongs to. - **Possible values**: - Apex Class - Expression Set - Flow - OmniStudio Integration Procedure ### ScoreAggregationMethod - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the method used to combine the different measure scores of each population into one aggregated result. ### ScoreImprovementIndication - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether an increase or decrease in score is the preferred result for the measure that the criteria group belongs to. - **Possible values**: - Decrease - Increase ### ScoringType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The scoring type used for calculating the measure the criteria group belongs to. - **Possible values**: - Cohort - Continuous-Variable - Proportion - Ratio ### ScoringUnitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the expected unit of measure for the measure score when the unit can't be inferred from the measure logic. This field is a relationship field. - **Relationship Name**: ScoringUnit - **Relationship Type**: Lookup - **Refers To**: UnitOfMeasure ### SubjectCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subject category of the measure that the criteria group belongs to. - **Possible values**: - Device - Location - Organization - Patient - Practitioner - Related Person ## 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. [ClinicalMeasureCriteriaGrpFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ClinicalMeasureCriteriaGrpHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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 | - **[ClinicalServiceRequestDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 for Home Health Represents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’s healthcare. Multiple features use this object. See [ClinicalServiceRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 for Home Health Associates records from different objects to a clinical service request record to add more information to it. This is a multi-object junction object. Multiple features use this object. See [ClinicalServiceRequestDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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."). # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # Common Search Criteria Input Search filters that apply to both provider and asset searches. ## JSON Example { "commonSearchCriteria": { "facilityName": "City General Hospital", "facilityAddress": { "text": "123 Main St, Anytown, CA 90210, USA", "line": \[ "123 Main St", "Suite 100" \], "city": "Anytown", "district": "Any County", "state": "CA", "postalCode": "90210", "country": "USA", "latitude": 34.0522, "longitude": -118.2437 }, "radius": 25, "distanceUnit": "kilometers" } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | facilityName | String | The name of the facility. | Optional | | facilityAddress | Object | Detailed address information for the facility. See [Address Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_address_input_representation.htm "The detailed address information for a facility used as search criteria."). | Optional | | radius | Integer | The search radius around the specified longitude and latitude. Minimum value is 0, maximum is 100. | Optional | | distanceUnit | String | The unit of measurement for the search radius. Valid values are miles or kilometers. | Optional | # 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. | # CondIntrctnHlthRskAdjFctr Stores the risk adjustment factor for patients and members based on the set of interacting conditions they are diagnosed with and the status of their benefits eligibility. 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 ### CmnyFullBnftDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### CmnyPartialBenefitDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CmnyPartialBnftDualDsbl - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### Community - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home. ### CommunityFullBnftDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CommunityNonDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of their age. ### CommunityNonDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of a disability. ### ConditionCodeList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the first set of condition codes for the condition interactions that the risk adjustment factors are defined for. ### Institutional - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at a healthcare facility. ### InteractingCondCodeList - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the codes of the interacting conditions for the condition interactions that the risk adjustment factors are defined for. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the specified condition interactions and risk adjustment factor combinations are currently active. - **Default value**: false ### IsDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the interaction is with a condition or a disability. - **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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PublishedYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year when the risk adjust factors were published. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # confidenceScore The confidence score assigned by the extraction model for this field value. ## Signature public Double confidenceScore {get; set;} ## Property Value Type: Double # 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 Custom Fields Custom fields extend the standard Contact object for use in Emergency Response Management. ## Fields ### ConditionStatus\_\_pc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents a person’s condition based on their most recent test or assessment. - **Possible values**: - Asymptomatic - Asymptomatic - Declined to Participate - Cured - Evaluated - No Risk - Symptomatic - Symptomatic - Declined to Participate ### Monitored\_at\_Home\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Whether a person’s condition is being monitored at their home, rather than a clinical setting. - **Possible values**: - No - Yes ### StatusGroup\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Categorizes a person’s stage within the testing and monitoring process. - **Possible values**: - Monitored - Positive - Ready for intake - Unknown - Unmonitored ### Testing\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the result of a person’s most recent test. - **Possible values**: - Negative Test - Positive Test - Test Results Pending—Test Results Awaited - Test Scheduled - Testing Recommended - Unknown # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 } # Contact Encounter (POST) for Business APIs Load details of contact encounters into the system. This resource is documented with Emergency Response Management. See [Contact Encounter (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_resource_contact_encounter_business_api.htm "Load details of contact encounters into the system."). # ContactEncounter Represents a period of time during which two or more people were in close proximity to each other. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Actual\_Participant\_Count\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The confirmed number of people who were present during the encounter. ### Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Text describing the encounter. ### DiseaseInvestigationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The disease investigation associated with the contact encounter. This field is a relationship field. - **Relationship Name**: DiseaseInvestigation - **Refers To**: DiseaseInvestigation ### EndTime\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the encounter ended. ### EstimatedParticipantCount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The estimated number of people who were present during the encounter. ### ExposureSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the source of the exposure. - **Possible values**: - Animal Contact - Environment - Air - Environment - Chemical - Environment - Water - Event - Facility - Person Contact ### ExposureSourceDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the exposure source. ### ExposureType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of disease exposure the patient encountered. - **Possible values**: - Direct Contact - Ingestion - Inhalation ### Location\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the encounter took place. ### StartTime\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the encounter began. ### LastActivityDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Value is one of the following, whichever is the most recent: - Due date of the most recent event logged against the object. - Due date of the most recently closed task associated with the object. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The name of this contact encounter. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns this record. # ContactEncounterParticipant Represents a person who was present during a contact encounter. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account associated with the contact encounter participant. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the contact encounter participant. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ContactEncounter\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contact encounter that this person was involved in. ### Contact\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A contact who was involved in the contact encounter. ### EndTime\_\_c - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the contact encounter ended for this person. ### Lead\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A lead who was involved in the contact encounter. ### StartTime\_\_c - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time when the contact encounter began for this person. ### LastActivityDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Value is one of the following, whichever is the most recent: - Due date of the most recent event logged against the object. - Due date of the most recently closed task associated with the object. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: An auto-generated unique ID for this record. ### TransmissionMode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the contact encounter participant acquired the disease or contracted it through transmission. - **Possible values**: - Acquired - Transmitted ### RiskLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the risk level of an individual for an infection based on their exposure to the contact encounter participant. - **Possible values**: - HighRisk - LowRisk # 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. | # ContactProfile Represents information about an individual, such as their ethnicity, citizenship, birth place, race, and so on. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AdvancementGraduationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date of the person's first graduation from an institution. ### BirthCountryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual's country of birth. This field is a relationship field. - **Relationship Name**: BirthCountry - **Refers To**: GeoCountry ### BirthPlace - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual's place of birth. ### BirthSex - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the sex of an individual assigned at birth, as defined by the Office of the national Coordinator for Health IT (ONC). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). - **Possible values**: - Female - Intersex - Male - PreferNotToDisclose—Prefer not to Disclose - Unknown ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contact associated with the contact profile record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Master-detail - **Refers To**: Contact (the master object) ### Ethnicity - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the ethnicity of the individual. - **Possible values**: - Hispanic or Latino - Not Hispanic or Latino - Not Selected ### GenerationalCohort - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person's age group, or generational cohort, based on their birth date. ### HighestEducationLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the highest educational qualification of the individual. - **Possible values**: - Graduate - High School - Masters - Other - PhD ### HousingStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the housing status of the contact, such as evicted, homeless, or home owner. ### IsFirstGenerationStudent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the individual is the first generation to enroll in education beyond high school. - **Default value**: false ### 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. ### LivingArrangementType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of living arrangement, such as alone or with parents. ### Location - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The location where the contact currently resides. ### MilitaryBranch - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the military branch if the individual has ever enlisted in the military. - **Possible values**: - Air Force - Army - Coast Guard - Marine Corps - Navy - Other - Space Force ### MilitaryService - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the current status of military service. - **Possible values**: - Active Duty - Active Reserve - Full time - Other - Part time - Retired - Unknown - Veteran ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name for this record. ### PrimaryCitizenshipId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The primary citizenship held by the individual. This field is a relationship field. - **Relationship Name**: PrimaryCitizenship - **Refers To**: GeoCountry ### PrimaryCitizenshipType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of primary citizenship held by the individual. - **Possible values**: - Asylum - National - Other - Refugee ### Race - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the race of the individual. - **Possible values**: - Alaska Native - American Indian - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White ### ResidenceSubType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the subtype of residence. ### ResidenceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of residence, such as trailer, single-family home, or assisted living. ### SecondaryCitizenshipId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The secondary citizenship of the individual if they hold dual citizenship. This field is a relationship field. - **Relationship Name**: SecondaryCitizenship - **Refers To**: GeoCountry ### SecondaryCitizenshipType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of secondary citizenship held by the individual. - **Possible values**: - Asylum - National - Other - Refugee ### TribalAffiliationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the tribe affiliated with the contact. ### Website - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: A website that’s associated with the contact. # 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 Hub File Detail Full representation details for a Content Hub file. ## JSON example { "externalId": "case1.pdf", "fileExtension": "pdf", "mimeType": "application/pdf", "name": "case1.pdf", "presignedUrl": "https://acme.s3.us-east-2.amazonaws.com/case1.pdf?response-content-disposition=inline&X-Amz-...", "title": "case1" } ## Properties | Property Name | Type | Description | | --- | --- | --- | | externalId | String | Durable identifier of the file in the external data source. | | fileExtension | String | File extension without a leading dot. | | mimeType | String | MIME type of the file content. | | name | String | File name. | | presignedUrl | String | Temporary presigned URL for inline document preview. | | title | String | Title of the file. | # Content Hub File Detail (GET) Retrieves details for a single Content Hub file, including a presigned preview URL. ## Resource /connect/document-ai-automation/content-hub/files/{externalId} ## Available Version 68.0 ## HTTP Methods GET ## Parameters | Parameter Name | Type | Parameter Type | Required | Description | | --- | --- | --- | --- | --- | | externalId | String | Path | Required | URL-encoded external identifier of the file. | ## Response Body for GET [Content Hub File Detail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_content_hub_file_detail.htm "Full representation details for a Content Hub file.") # Content Hub Item Represents an individual item, such as a folder or file, inside a Content Hub repository. ## Properties | Property Name | Type | Description | | --- | --- | --- | | contentSize | Long | Size of the item content in bytes. Null or zero for folders. | | externalId | String | Durable identifier of the item in its external data source. | | fileExtension | String | File extension without a leading dot. | | fileType | String | Classifier for the file type. | | isFolder | Boolean | Specifies whether the item is a folder (true) or a file (false). | | modifiedDate | String | Timestamp when the content was last modified, in RFC 822 timezone format. | | name | String | Name of the item. | | title | String | Title of the item. | # Content Hub Item Collection Collection of items (folders and files) within a specified Content Hub repository hierarchy. ## JSON example { "items": \[ { "externalId": "referrals/", "name": "referrals", "isFolder": true }, { "externalId": "case1.pdf", "name": "case1.pdf", "title": "case1", "isFolder": false, "fileExtension": "pdf", "contentSize": 248213, "modifiedDate": "2026-05-19T06:22:40.000+0000" } \] } ## Properties | Property Name | Type | Description | | --- | --- | --- | | items | List<[Content Hub Item](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_content_hub_item.htm "Represents an individual item, such as a folder or file, inside a Content Hub repository.")\> | List of items within the given repository path. | # Content Hub Items (GET) Lists items, including folders and files, inside a Content Hub repository. ## Resource /connect/document-ai-automation/content-hub/repositories/{repositoryId}/items ## Available Version 68.0 ## HTTP Methods GET ## Parameters | Parameter Name | Type | Parameter Type | Required | Description | | --- | --- | --- | --- | --- | | repositoryId | String | Path | Required | The 15- or 18-character Salesforce ID of the Content Hub repository. | | parentExternalId | String | Query | Optional | Parent identifier of a folder. Omit this parameter to retrieve items at the root level. | ## Response Body for GET [Content Hub Item Collection](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_content_hub_item_collection.htm "Collection of items (folders and files) within a specified Content Hub repository hierarchy.") # Content Hub Repositories (GET) Lists Content Hub repository records accessible to the user. ## Resource /connect/document-ai-automation/content-hub/repositories ## Available Version 68.0 ## HTTP Methods GET ## Response Body for GET [Content Hub Repository Collection](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_content_hub_repository_collection.htm "Collection of Content Hub repositories (external data sources) accessible to the user.") # Content Hub Repository Represents details of a single Content Hub repository or external data source. ## Properties | Property Name | Type | Description | | --- | --- | --- | | id | String | ID of the Content Hub repository. | | apiName | String | Developer name of the external data source. | | label | String | User-facing label of the external data source. | | type | String | Type of repository or external data source. | # Content Hub Repository Collection Collection of Content Hub repositories (external data sources) accessible to the user. ## JSON example { "repositories": \[ { "id": "0XS5e000000abcDEF", "apiName": "Acme\_S3", "label": "Acme S3 Bucket", "type": "contentHubAWSS3" } \] } ## Properties | Property Name | Type | Description | | --- | --- | --- | | repositories | List<[Content Hub Repository](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_content_hub_repository.htm "Represents details of a single Content Hub repository or external data source.")\> | List of Content Hub repositories. | # ContractPaymentAgreement Stores information about the contract payment agreement associated with a contract. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AgreementType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The payment type supported in the contract payment agreement. - **Possible values**: - Bundled Care Fee Agreement - Capitation Care Fee Agreement - Categorized Care Fee Agreement - Percentile Based Care Fee Agreement - Preventive Care Agreement - Shared Saving Payment Agreement - Standard Care Fee Agreement ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract associated with the contract payment agreement. This is a relationship field. - **Relationship Name**: Contract - **Relationship Type**: Master-Detail - **Refers To**: Contract ### ContractPaymentAgreementKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key assigned to the Contract Payment Agreement record. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the contract payment agreement. ### EligibleProcedureCodeList - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The procedure codes that are covered in the contract payment agreement. This value is applicable for Capitation and Shared Savings payment type. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date until when the contract payment agreement is effective. ### FeeScheduleDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fee schedule definition record associated with the contract payment agreement. This value is applicable only for Fee-for-Service payment types. This is a relationship field. - **Relationship Name**: FeeScheduleDefinition - **Relationship Type**: Lookup - **Refers To**: FeeScheduleDefinition ### 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. ### LineofBusiness - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The line of business to which the contract payment agreement is applicable. - **Possible values**: - Commercial - Medi-Cal - Medicaid - Medicare ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the contract payment agreement associated with the contract. ### StandardFeeCalculationPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The percentage of the baseline fees of the fee schedule definition that's used to calculate the negotiated fees for the Fee-for-Service payment types. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date from when the contract payment agreement is effective. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the contract payment agreement. - **Possible values**: - ACTIVATED—Activated - DEACTIVATED—Deactivated - DRAFT—Draft ## 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. [ContractPaymentAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ContractPaymentAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ContractPaymentAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Coverage Requirement Discovery Payer organizations in the healthcare industry can use the FHIR-aligned Coverage Requirement Discovery (CRD) data model to help providers access member and coverage-related information in real time, directly from their Electronic Health Records (EHR) system. The automation of coverage requirement discovery reduces time spent on administrative tasks, improves the chances of coverage approval, and helps in reducing human errors.
Available in: Enterprise and Unlimited editions of Health Cloud
When a provider submits a coverage requirement discovery request, you can use the CRD data model to validate the member and their coverage, assess the need for pre-authorization, and check the required documentation. Coverage Requirement Discovery objects are available to users with the Hls Clinical Decision Support permission set. ![Coverage Requirement Discovery Diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/sforce_hc_crd_erd.png) - **[ServiceInfoRequestDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforequestdetail.htm)** Represents additional details about a service information request, such as the detail type and detail code. This object is available in API version 63.0 and later. - **[ServiceInformationRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinformationrequest.htm)** Represents information about a service information request, such as the date and time when the request was submitted and the type of service requested. This object is available in API version 63.0 and later. - **[ServiceInformationResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinformationresponse.htm)** Represents a response to a service information request. This object is available in API version 63.0 and later. - **[ServiceInfoResponseAction](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforesponseaction.htm)** Represents actions to be performed as suggested by a service information response. This object is available in API version 63.0 and later. - **[ServiceInfoResponseCoverage](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforesponsecoverage.htm)** Represents coverage details about a service information response. For example, if additional information or documentation is required for the coverage to be provided. This object is available in API version 63.0 and later. - **[SvcInfoRespCoverageDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_svcinforespcoveragedetail.htm)** Represents additional coverage details about a service information response. This object is available in API version 63.0 and later. - **[ServiceInfoRespOvrideOpt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforespovrideopt.htm)** Represents the possible reasons for overriding a service information response. This object is available in API version 63.0 and later. - **[ServiceInfoRespResourceUrl](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforespresourceurl.htm)** Represents the URLs of resources relevant to a service information response. This object is available in API version 63.0 and later. - **[ServiceInfoRespSuggestion](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforespsuggestion.htm)** Represents suggestions in a service information response. For example, suggesting a change in medication dosage. This object is available in API version 63.0 and later. - **[SvcInfoRelatedQuestionnaire](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_svcinforelatedquestionnaire.htm)** Represents the questionnaire associated with a service information request or service information response coverage. This object is available in API version 63.0 and later. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CoverageBenefit for Health Insurance Represents the benefits provided to a covered member by a purchaser’s plan. Multiple features use this object. See [CoverageBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefit.htm "Represents the benefits provided to a covered member by a purchaser’s plan."). # CoverageBenefit for Home Health Represents the benefits provided to a covered member by a purchaser’s plan. Multiple features use this object. See [CoverageBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefit.htm "Represents the benefits provided to a covered member by a purchaser’s plan."). # CoverageBenefit for Pharmacy Benefits Verification Represents the benefits provided to a covered member by a purchaser’s plan. Multiple features use this object. See [CoverageBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefit.htm "Represents the benefits provided to a covered member by a purchaser’s plan."). # CoverageBenefitItem Specific service covered by the insurance plan. This object is available in API version 53.0 and later. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CoverageBenefitItem for Health Insurance Represents a service covered by the insurance plan. Multiple features use this object. See [CoverageBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititem.htm "Specific service covered by the insurance plan. This object is available in API version 53.0 and later."). # CoverageBenefitItem for Home Health Represents a service covered by the insurance plan. Multiple features use this object. See [CoverageBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititem.htm "Specific service covered by the insurance plan. This object is available in API version 53.0 and later."). # CoverageBenefitItem for Pharmacy Benefits Verification Represents a service covered by the insurance plan. Multiple features use this object. See [CoverageBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititem.htm "Specific service covered by the insurance plan. This object is available in API version 53.0 and later."). # CoverageBenefitItemLimit Allows you to track details associated with a specific benefit as it relates to expenditures, limits, coverage levels, eligibility, 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # CoverageBenefitItemLimit for Pharmacy Benefits Verification Represents expenditures, limits, coverage levels, eligibility, and exclusions for a specific benefit. Multiple features use this object. See [CoverageBenefitItemLimit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_coveragebenefititemlimit.htm "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."). # CRDMetricData The CRDMetricData FHIR resource maps to the ServiceInformationRequest, ServiceInfoRequestDetail, ServiceInfoResponseCoverage, SvcInfoRespCoverageDetail,ServiceInfoResponseAction ServiceInfoRespSuggestion, ServiceInfoRespOvrideOptobjects. ## FHIR V4.0 - Coverage Requirement Discovery Data Model Mapping Here’s how the fields defined by FHIR for [CRDMetricData](https://build.fhir.org/ig/HL7/davinci-crd/StructureDefinition-CRDMetricData.html) and the [CDS hooks specifications](https://cds-hooks.hl7.org/2.0/) map to the fields in Salesforce. Table 1. CRDMetricData - Salesforce | CRDMetricdata element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | source | ServiceInformationRequest.SourceType | Picklist | 1.1 | N/A | | hookInstance | ServiceInformationRequest.SvcRqstInvocationIdentifier | Text | 1.1 | N/A | | hookType | ServiceInformationRequest.ServiceType | Picklist | 1.1 | N/A | | providerId | ServiceInformationRequest.RequesterStandardIdentifier | Lookup: Identifier | 1.1 | N/A | | groupId | ServiceInformationRequest.RequesterOrgStdIdentifier | Lookup: Identifier | 1.1 | N/A | | payerId | ServiceInformationRequest.RecipientOrgIdentifier | Lookup: Identifier | 1.1 | N/A | | requestTime | ServiceInformationRequest.RequestDateTime | DateTime | 1.1 | N/A | | responseTime | ServiceInformationRequest.ResponseDateTime | DateTime | 0.1 | N/A | | httpResponse | ServiceInformationRequest.ResponseCode | Integer | 1.1 | N/A | | issue | ServiceInfoRequestDetail.DetailType | Picklist | 0.M | Select Issue as the picklist value in DetailType. | | issue.code | ServiceInfoRequestDetail.DetailCodeType | Picklist | 1.1 | N/A | | issue.details | ServiceInfoRequestDetail.DetailCode | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | | tokenUse | ServiceInformationRequest.AccessTokenUsageStatus | Picklist | 0.1 | N/A | | orderDetail | ServiceInfoRequestDetail.DetailType | Picklist | 0.M | Select Order Detail as the picklist value in DetailType. | | Card.summary | ServiceInformationResponse.Summary | Text | 0.1 | CDS specifications of Cardattributes. | | Card.uuid | ServiceInformationResponse.Identifier | Text | 0.1 | CDS specifications of Cardattributes. | | Card.detail | ServiceInformationResponse.AdditionalNote | String Plus Clob | 0.1 | CDS specifications of Cardattributes. | | Card.indicator | ServiceInformationResponse.UrgencyIndicator | Picklist | 0.1 | CDS specifications of Cardattributes. | | Card.selectionBehavior | ServiceInformationResponse.SuggestionSelectionType | Picklist | 0.1 | CDS specifications of Cardattributes. | | Card.suggestions | ServiceInfoRespSuggestion | Object | 0.1 | CDS specifications of Cardattributes. | | Suggestion. label | ServiceInfoRespSuggestion.Name | Text | 1.1 | CDS specifications of Suggestionattributes. | | Suggestion.uuid | ServiceInfoRespSuggestion.Identifier | Text | 0.1 | CDS specifications of Suggestionattributes. | | Suggestion.isRecommended | ServiceInfoRespSuggestion.IsHighlyRecommended | Boolean | 0.1 | CDS specifications of Suggestionattributes. | | Suggestion.action | ServiceInfoResponseAction | Object | 0.1 | CDS specifications of Suggestionattributes. | | Action.type | ServiceInfoResponseAction.Type | Picklist | 1.1 | CDS specifications of Actionattributes. | | Action.description | ServiceInfoResponseAction.Description | String Plus Clob | 1.1 | CDS specifications of Actionattributes. | | Action.resource | ServiceInfoResponseAction.Context | String Plus Clob | 0.1 | CDS specifications of Actionattributes. | | Action.resourceId | ServiceInfoResponseAction.ContextIdentifier | Text | 0.1 | CDS specifications of Actionattributes. | | Card.overrideReasons | ServiceInfoRespOvrideOpt | Object | 0.M | N/A | | Source.label | ServiceInformationResponse.ReferenceSourceName | String | 0.1 | CDS specifications of Sourceattributes. | | Source.url | ServiceInformationResponse.ReferenceSourceUrl | URL | 0.1 | CDS specifications of Sourceattributes. | | Source.icon | ServiceInformationResponse.ReferenceSourceIconUrl | URL | 0.1 | CDS specifications of Sourceattributes. | | Source.topic | ServiceInformationResponse.ReferenceSourceCategoryCodeId | Lookup: Code Set | 0.1 | CDS specifications of Sourceattributes. | | response.type | ServiceInformationResponse.ResponseSubtype | Picklist | 0.1 | N/A | | response.focus | ServiceInformationResponse.FocusType | Multi-picklist | 0.M | N/A | | response.engagement | ServiceInformationResponse.ResponseEngagementStatus | Picklist | 0.1 | N/A | | response.coverageInfo.covered | ServiceInfoResponseCoverage.CoverageIndicator | Picklist | 0.1 | N/A | | response.coverageInfo.paNeeded | ServiceInfoResponseCoverage.PreapprovalRequirementInd | Picklist | 0.1 | N/A | | response.coverageInfo.docNeeded | ServiceInfoResponseCoverage.RequiredDocumentationType | Picklist | 0.1 | N/A | | response.coverageInfo.infoNeeded | ServiceInfoResponseCoverage.RequiredAddlInfoType | Picklist | 0.1 | N/A | | response.coverageInfo.assertionId | ServiceInfoResponseCoverage.CoverageAssertionIdentifier | Picklist | 0.1 | N/A | | response.coverageInfo.satisfiedId | ServiceInfoResponseCoverage.PreapprovalIdentifier | String | 0.1 | N/A | | response.coverageInfo.businessLine | ServiceInfoResponseCoverage.CoveragePlanTypeId | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | # Create Appointment When the patient selects an available slot, the call center agent books the appointment, which triggers a Get Slot Status REST call to the EHR system. 1. Health Cloud makes a Get Slot Status REST call. An error is displayed to the call center agent if the slot is no longer available. 2. Health Cloud creates a Service Appointment record and a Healthcare Practitioner Facility Appointment junction between the Service Appointment and Healthcare Practitioner Facility. 3. Health Cloud makes a Create (Book) Appointment REST call. - Service Appointment is updated with the response. - An error is displayed to the call center agent if the booking is rejected. - **Type**: Resource - **Verb**: POST - **Default URL Path**: \[base\]/Appointment/\[sourceSystem\] Your Base URL is configured in Setup > Appointment Scheduling. All communications with the external system use the FHIR R4 standard. ## Request Body The resourceType, identifier, cancelationReason, serviceType, appointmentType, slot, comment, and status are the minimum required fields in the request that Health Cloud sends. { **"resourceType" : "Appointment", "identifier" : \[{ Identifier }\],** //See Note below **"cancelationReason" : { CodeableConcept }, "serviceType" : \[{ CodeableConcept }\], //** From WorkType --> AppointmentType **"appointmentType" : { CodeableConcept }, //** From WorkType --> serviceType **"slot" : \[{ Reference(Slot) }\], //**Health Cloud sends the slot ID received from the Find Slots API response. **"comment" : "",** "participant" : \[{"type" : \[{ CodeableConcept }\], //Health Cloud sends sourcePatientId "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson | Device|HealthcareService|Location) }, //Health Cloud sends the source practitioner id **"status" : ""**, \] } ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note For "identifier," Health Cloud sends 3 records: - Salesforce unique appointment id - Salesforce unique patient id - Source system (for multi-source systems only) ## Response Codes - 200: Success - 400: Bad request - 401: Unauthorized - 404: Slot or patient not found - 5xx: Server error ## Response Body To map slots, resourceType, id, identifier, serviceType, appointmentType, slot, participant, actor, and status are required in the FHIR response. { "resourceType" : "Appointment", "id" : "" "identifier" : \[{ Identifier }\], //Source system identifier mandatory in the response if there are multiple source systems "cancelationReason" : { CodeableConcept }, "serviceCategory" : \[{ CodeableConcept }\], "serviceType" : \[{ CodeableConcept }\], "specialty" : \[{ CodeableConcept }\], "appointmentType" : { CodeableConcept }, "reasonCode" : \[{ CodeableConcept }\], "reasonReference" : \[{ Reference(Condition|Procedure|Observation|ImmunizationRecommendation) }\], "priority" : "", "description" : "", "supportingInformation" : \[{ Reference(Any) }\], "start" : "",// start of the appointment - ISO 8601 format "end" : "",// end of the appointment - ISO 8601 format "minutesDuration" : "", "slot" : \[{ Reference(Slot) }\], "created" : "", "comment" : "", "patientInstruction" : "", "basedOn" : \[{ Reference(ServiceRequest) }\], "participant" : \[{"type" : \[{ CodeableConcept }\],//Patient EHR id "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson | Device|HealthcareService|Location) }, //Practitioner EHR id "required" : "", "status" : "", // Mandatory in the response "period" : { Period }}\], "requestedPeriod" : \[{ Period } \] } ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note "Cancelation" is spelled with one L, per the FHIR R4 specification. The valid values for status are: - proposed - pending - booked - arrived - fulfilled - cancelled - noshow - entered-in-error - checked-in - waitlist If the request cannot be processed for any reason (e.g. it’s unsupported, there’s a timeout, etc.) status is returned as proposed. #### See Also - [FHIR Resource: Appointment](https://www.hl7.org/fhir/Appointment.html) # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_create_provider_api.htm#hc_create_provider_api_api)** Notes about lookups - **[Supported Fields](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_create_provider_api.htm#hc_create_provider_api_resource)** Details and JSON samples - **[Code Samples](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Quote for Home Visits Action Create a quote for patient home visits based on the specified visit details. This action is available in API version 63.0 and later. ## Special Access Rules The Create Quote for Home Visits action is available when Home Health is enabled. This action is available to users that have access to Home Health Quote perm set. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createQuoteForHomeVisits 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
quoteName String Required

The name of the quote to be created for a patient's home visits.
priceBookId String Required

The ID of the price book to use to create the quote for a patient's home visits.
accountId String The person account ID of the patient for whom the quote is to be created.
opportunityId String The ID of the opportunity to use to create the quote for a patient's home visits.
startDateTime DateTime The date and time when the quote takes effect.
endDateTime DateTime The date and time after which the quote is no longer valid.
workTypeIds List<String> The collection of IDs of work types that the quote is created for.
visitCount Integer The number of home visits that the quote is created for.
isTravelInventoryIncluded Boolean Indicates whether the travel and inventory associated with the home visit are included in the quote.
resourceTravelDistance Double The distance that a care resource has to travel to provide home healthcare to the patient.
pricingPreference String The attribute-based pricing preference that's used as an input in the PlaceQuote API for creating the quote.
Possible values are:
  • System
  • Force
  • Skip.

The default value is System.
currencyCode String The currency code to be used in the quote.
productPricingAttributeDetails List<Object> A collection of Apex heathcloudext_productPricingAttributeDetails records that contain the pricing attribute details for the products included in the quote.
## Outputs | Output | Type | Description | | --- | --- | --- | | quoteId | String | The ID of the quote record that was created for the patient's home visits. | | errorMessage | String | The description of the error encountered while creating the quote. | | errorCode | String | The code of the error encountered while creating the quote. | ## Example **POST** This sample request is for the Create Quote for Home Visits action.  { "inputs": \[ { "quoteName": "Quote For Charles", "priceBookId": "01sxx0000005qWXAAY", "accountId": "001xx000003GaC7AAK", "startDateTime": "2024-08-18T00:00:00.000Z", "endDateTime": "2024-08-25T00:00:00.000Z", "workTypeIds": \[ "08qxx0000004C92AAE" \], "visitCount": 2, "isTravelInventoryIncluded": false, "productPricingAttributeDetails": \[ { "productId": "08qxx0000004C92AAE", "unitCount": 1, "pricingAttributeList": \[ { "attributeDefinitionId": "dayBasedAttributeDefinitionId", "attributeValue": "Sunday" } \] } \] } \] } This sample response is for the Create Quote for Home Visits action. { "actionName": "createQuoteForHomeVisits", "isSuccess": true, "outputValues": { "quoteId": "0Q0XXXXXXXXXXXXXXX", "errorMessage": null, "errorCode": null } } # Create Referral Action Create a patient referral record. A patient referral consists of multiple objects, such as an account, clinical service request, and clinical service request detail. This action is available in API version 59.0 and later for users with the Health Cloud license. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createReferral 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 | | --- | --- | --- | | matchDuplicates | Boolean | Indicates whether to match a duplicate record that has the highest matching confidence (true) or not (false). | | performers | String\[\] | Required. Comma-separated list of IDs of the organizations or practitioners who perform the service. | | referralDetailsRecords | Reference | Collection of ClinicalServiceRequestDetails records that contain the referral information. | | referralNotes | String | Referral notes. | | referralRecord | Reference | Required. ClinicalServiceRequest record that contains referral information. | | requesterId | String | Required. ID of the provider requesting the service. | | subjectRecord | Reference | Required. Account details of the patient being referred. | ## Outputs | Output | Type | Description | | --- | --- | --- | | referralIds | String\[\] | List of IDs of the new referral records. | ## Example **Sample Request** { "inputs":\[ { "subjectRecord":{ "Id":"001RM000005bZVvYAM", "FirstName":"Joe", "LastName":"Clark" }, "requesterId":"001RM000005bZW0YAM", "performers":\[ "001RM000005bZW5YAM" \], "referralRecord":{ "Priority":"Routine", "Status":"Draft", "Type":"Plan" }, "matchDuplicates":false, "referralNotes":"This is an urgent request", "referralDetails":\[ { "detailType":"Insurance", "detailRecordType":"Member Plan", "detailRecordId":"0SqRM00000000N10AI" } \] } \] } **Sample Response** { "errors": null, "isSuccess": true, "outputValues": { "referralIds": \[ "0lvxx00004000001AAB" \] } } # Create Template of Service Appointment Action Create a service appointment record of Cancelled status that's used as a template for creating the actual service appointment record while scheduling home visits manually. This action is available in API version 66.0 and later for users with the Home Health enabled. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/createTemplateOfServiceAppt 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 | String | Required. The person account ID of the patient to schedule the visits for. | | clinicalServiceRequestId | String | Required. The ID of the clinical service request record that's associated with the home visits to be scheduled. | | firstVisitEndDateTime | DateTime | The date and time when the first recurring home visit ends. | | firstVisitStartDateTime | DateTime | Required. The scheduled date and time for the start of the first recurring home visit. | | flowInterviewId | String | Required. The ID of the flow interview to set the service appointment template's Comment field to when manually scheduling home visits. | | operatingHoursId | String | The ID of the operating hours record that specifies the time slots to schedule the home visit for. | | recurrenceFrequencyType | Picklist | Required. Specifies the type of recurring home visits. If Weekly is specified, Recurring Days List is required. Valid values are Daily and Weekly. | | recurringDaysList | String | The comma-delimited list of days to schedule recurring home visits for the patient. For example, Monday, Thursday, and Saturday. | | schedulingPolicyId | String | Required. The ID of the home health scheduling policy to be used to identify care resources available for the home visits. | | serviceAppointmentAddress | SObject | Required. The service appointment record that contains the home visit address specified by the user and is used to create the actual service appointment. | | serviceTerritoryId | String | Required. The ID of the service territory record that contains the care resources to be assigned to the visits. | | skillsIdsList | String | The comma-delimited list of record IDs of all skills required for the home visits. | | visitsRequired | Integer | Required. The number of recurring home visits to be scheduled. | | workTypeId | ID | The ID of the work type record that's associated with the clinical service request of the home visit. | # 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
# Crisis Support Center Management The Crisis Support Center Management data model lets users provide a range of crisis services from a single app. Use a simplified intake flow, search for providers and beds across facilities, and more.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud or Life Sciences Cloud
Crisis Support Center Management objects are available to users who are assigned the Health Cloud Crisis Support Center Management App permission set and the Health Cloud Crisis Support Center Management permission set license. Users also need the Health Cloud Foundation permission set and the Health Cloud Platform permission set license. - **[CareFacilityBed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carefacilitybed.htm)** Represents information related to different bed types at a facility with associated care programs and products. This object is available in API version 58.0 and later. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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
# 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 The list of records that were saved and are passed for post-save processing. ## Signature public List data {get; set;} ## Property Value Type: List # data The response data returned after post-save processing. ## Signature public String data {get; set;} ## Property Value Type: String # data The list of extracted document nodes to be processed during post-transformation. ## Signature public List data {get; set;} ## Property Value Type: List # data The list of extracted document nodes to be processed during post-transformation. ## Signature public List data {get; set;} ## Property Value Type: List # 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 | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_diagnosticreport.png) #### See Also - [DiagnosticSummary](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 | - **[DiagnosticSummaryDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_diagnosticsummarydetail.htm)** 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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Disease Surveillance Disease Surveillance tracks and manages disease data and public health activities. Use the Disease Surveillance data model to centralize patient information, including demographics, disability status, medications, and specimens. Streamline health monitoring and enable timely, informed decision making by gaining a comprehensive view of disease-related data, such as definitions, investigations, and outbreaks.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud

To use this data model, go to Setup and enable **Disease Surveillance** on the Public Health Settings page. ![Diagram of the disease surveillance data model showing object relationships](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_disease_surveillance_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/disease-surveillance.html "HTML (New Window)"). # DiseaseDefinition Represents a disease definition that public health organizations regularly monitor to identify and prevent outbreaks. This object is available in API version 64.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, Sort, Update - **Description**: The date the disease definition becomes active. ### AuthorityReportingLevel - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the scope for reporting the disease. - **Possible values**: - Global - Local - National - State ### ClinicalDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A clinical description of the disease definition that details the initial symptoms or physical and clinical findings. ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional details related to the disease definition. ### DocumentVersionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The document version used for data extraction. This field is a relationship field. - **Relationship Name**: DocumentVersion - **Refers To**: ContentVersion ### ExpirationDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The expiration date of disease definition. ### IcdCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The International Classification of Diseases (ICD) code set bundle associated with the disease definition. This field is a relationship field. - **Relationship Name**: IcdCode - **Refers To**: CodeSetBundle ### IsHighRisk - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the disease is high risk (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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the disease. ### 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 ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent problem definition associated with the disease definiton. This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Master-detail - **Refers To**: ProblemDefinition (the master object) ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the disease definition. - **Default value**: Draft - **Possible values**: - Active - Draft - Inactive ### Summary - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The summary of the disease definition. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of disease definition. - **Possible values**: - Animal Borne - Blood Borne - Food or Water Borne - None - Respiratory Disease - Sexually\_Transmitted\_Infection - Vaccine Preventable ## 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. [DiseaseDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseDefinitionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DiseaseDefinitionCondition Represents a condition for disease definition criteria. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ConditionMatchRequirement - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the level of strictness required when matching the criteria condition. - **Default value**: Sufficient - **Possible values**: - Necessary - Sufficient - Supportive ### Description - **Type**: textarea - **Properties**: Create, Update - **Description**: The description of the disease definition criteria condition. ### DiseaseDefinitionCriteriaId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The disease definition criteria associated with the disease definition criteria condition. This field is a relationship field. - **Relationship Name**: DiseaseDefinitionCriteria - **Relationship Type**: Master-detail - **Refers To**: DiseaseDefinitionCriteria (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 disease definition criteria condition. ## 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. [DiseaseDefinitionConditionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseDefinitionConditionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DiseaseDefinitionCriteria Represents disease definition criteria, such as clinical, laboratory, and epidemiologic linkage used to diagnose diseases. This object is available in API version 64.0 and later. ## 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 of the disease definition criteria. ### DiseaseDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The disease definition associated with the disease definition criteria. This field is a relationship field. - **Relationship Name**: DiseaseDefinition - **Relationship Type**: Master-detail - **Refers To**: DiseaseDefinition (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 disease definition criteria. ### ParentCriteriaId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent criteria associated with disease definition criteria. This field is a relationship field. - **Relationship Name**: ParentCriteria - **Refers To**: DiseaseDefinitionCriteria ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the disease definition criteria. - **Possible values**: - Case Classification - Clinical - Laboratory ## 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. [DiseaseDefinitionCriteriaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseDefinitionCriteriaHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DiseaseInvestigation Represents an investigation of a disease. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssigneeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The user responsible for conducting the disease investigation. This field is a polymorphic relationship field. - **Relationship Name**: Assignee - **Refers To**: User ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Comments or notes related to the disease investigation. ### DiseaseDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The disease definition associated with the disease investigation. This field is a relationship field. - **Relationship Name**: DiseaseDefinition - **Refers To**: DiseaseDefinition ### DiseaseOutbreakId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The disease outbreak associated with the disease investigation. This field is a relationship field. - **Relationship Name**: DiseaseOutbreak - **Refers To**: DiseaseOutbreak ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the disease investigation. ### 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 disease investigation. ### 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 ### RelatedDiseaseInvestigationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A related disease investigation associated with the disease investigation. This field is a relationship field. - **Relationship Name**: RelatedDiseaseInvestigation - **Refers To**: DiseaseInvestigation ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date and time of the disease investigation. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the disease investigation. - **Default value**: InProgress - **Possible values**: - Completed - InProgress - NotStarted ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of disease investigation. - **Possible values**: - Clinical - Environmental - Epidemiologic - Laboratory - Source Investigation - Vector Surveillance ## 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. [DiseaseInvestigationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseInvestigationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseInvestigationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseInvestigationShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DiseaseInvestigationCase Represents a junction between a disease investigation and a case. This object is available in API version 64.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, Update - **Description**: The case associated with the disease investigation. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### DiseaseInvestigationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent disease investigation associated with the case. This field is a relationship field. - **Relationship Name**: DiseaseInvestigation - **Relationship Type**: Master-detail - **Refers To**: DiseaseInvestigation (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**: Name of the disease investigation case. ## 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. [DiseaseInvestigationCaseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseInvestigationCaseHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DiseaseOutbreak Represents a disease outbreak monitored by the public health organization. This object is available in API version 64.0 and later. ## 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 of the disease outbreak. ### DetectionDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time of the disease outbreak detection. ### DiseaseDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The disease definition associated with the disease outbreak. This field is a relationship field. - **Relationship Name**: DiseaseDefinition - **Refers To**: DiseaseDefinition ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The end date and time of the disease outbreak. ### 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. ### LocationReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The location, address, or healthcare facility associated with the disease outbreak. This field is a polymorphic relationship field. - **Relationship Name**: LocationReferenceRecord - **Refers To**: Address, HealthcareFacility, Location ### ManuallyRecordedconfirmedCnt - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manually recorded count of people affected by the disease outbreak, based on informal reports. ### ManuallyRecordedsuspectedCnt - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The manually recorded count of people suspected to be affected by the disease outbreak, based on informal reports. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the disease outbreak. ### OutbreakLevel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the geographical scope of the outbreak, such as local, multi-jurisdictional, provincial, national, or facility-based. - **Possible values**: - Facility - Local - MultiJurisdictional - National - Provincial ### 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 ### RelatedDiseaseOutbreakId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A related outbreak associated with the disease outbreak. This field is a relationship field. - **Relationship Name**: RelatedDiseaseOutbreak - **Refers To**: DiseaseOutbreak ### ReportedById - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The user who reported the disease outbreak. This field is a polymorphic relationship field. - **Relationship Name**: ReportedBy - **Refers To**: User ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The start date and time of the disease outbreak. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the disease outbreak. - **Possible values**: - Completed - InProgress - New ### TotalConfirmedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total confirmed count of people affected by the disease outbreak. ### TotalSuspectedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The total suspected count of people affected by the disease outbreak. ## 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. [DiseaseOutbreakChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseOutbreakHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseOutbreakOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DiseaseOutbreakShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # Document AI Automation Leverage the generative AI capabilities of Document AI Automation to automatically extract data from PDFs, such as lab reports and disease definitions, and convert it into structured Health Cloud records. Focus on critical tasks by reducing manual data entry efforts, and ensure consistent case intake and disease data management, facilitating faster follow-up and investigation. Use these resources to leverage Document AI Automation: - **[Document Template Match](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resource_document_template_match.htm)** Automatically identifies the Document AI Automation template for a specified document. - **[Extract Document Data (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_extract_document_data.htm)** Synchronously extracts unstructured file data using an intelligent ingestion template. - **[Transform Extracted Data (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_transform_extracted_data.htm)** Transforms stringified JSON extraction outputs into organized object mapping parameters synchronously. - **[Post Transform Data Processing (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_post_transform_processing.htm)** Synchronously runs custom post-processing layout adjustments on transformed hierarchical models. - **[Save Transformed Records (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_save_transformed_records.htm)** Synchronously commits structured object tree models directly to core database layers. - **[Post Save Operations (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_post_save.htm)** Launches downstream notification alerts and validation calculations against saved objects. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Template Match Automatically identifies the Document AI Automation template for a specified document. ## Resource /connect/document-ai-automation/actions/match-template ## Available Version 67.0 ## HTTP Methods POST ## Properties | Property Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | sourceType | String | The source type of the document. Valid values are ContentDocument, AmazonS3, or ContentHub. | Required | | contentDocumentId | String | The native Salesforce ContentDocument ID. | Required when sourceType is set to ContentDocument. | | documentUrl | String | The pre-signed Amazon S3 URL pointing to the document location. | Required when sourceType is set to AmazonS3. | | contentHubRepositoryId | String | The Content Hub repository ID for the external connection. | Required when sourceType is set to ContentHub. | | externalId | String | The external object key within the Content Hub repository. | Required when sourceType is set to ContentHub. | | templates | List | A list of template IDs or developer names to match against. If omitted, the top 20 newest active templates are considered. | Optional | ## Response Body for POST [Template Match Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_response_template_match_output.htm "Output details returning matched document templates.") # DocumentAI Namespace The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing. The DocumentAI namespace includes these classes and interfaces. - **[Error](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_error.htm)** Represents an error encountered during Document AI processing. - **[DuplicateRuleConfiguration](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_duplicate_rule_config.htm)** Represents the configuration used to perform duplicate detection during Document AI processing. - **[DuplicateObjectConfiguration](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_duplicate_object_config.htm)** Represents the duplicate detection configuration for a specific entity in Document AI processing. - **[PostTransformInput](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_post_transform_input.htm)** Represents the input payload provided to the Document AI post-transform process. - **[PostTransformResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_post_transform_result.htm)** Represents the output returned from the Document AI post-transform process. - **[ExtractionMetadata](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_extraction_metadata.htm)** Represents additional metadata returned during Document AI processing, including matching resolution details and manual review requirements. - **[Node](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node.htm)** Represents a structured entity node in Document AI processing, containing object details, extracted attributes, and potential matching record information. - **[MatchingRecord](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_matching_record.htm)** Represents a potential existing record identified during Document AI matching or duplicate detection. - **[Attribute](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_attribute.htm)** Represents an extracted field-level attribute within a Document AI node, including its value, metadata, confidence score, and potential matching information. - **[PostSaveInput](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_post_save_input.htm)** Represents the input payload for the Document AI post-save process, containing version information and saved record details. - **[SavedRecordDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_saved_record_detail.htm)** Represents a record that was created or updated during Document AI processing and is included in the post-save context. - **[PostSaveResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_post_save_result.htm)** Represents the output returned from the Document AI post-save process, including status and error details. - **[BatchProcessor](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_batch_processor.htm)** This is schedule apex used to schedule the batch job for batch document ai. - **[ObjectConfig](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_object_config.htm)** A configuration wrapper class for Document AI operations. # Documentation Templates and Rules Da Vinci Documentation Templates and Rules (DTR) is a framework under the HL7 FHIR standards that facilitates the exchange of documentation requirements in the healthcare industry. DTR enables the use of standardized templates and rules in the exchange of critical healthcare documentation, ensuring compliance and reducing administrative burden.
Available in: Enterprise and Unlimited editions of Health Cloud
Documentation Templates and Rules uses objects in the Coverage Requirement Discovery (CRD) data model. To learn more about the Coverage Requirement Discovery objects, see [Coverage Requirement Discovery](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_coverage_requirement_discovery_data_model.htm). Documentation Templates and Rules objects are available to users with the Hls Clinical Decision Support permission set. ![Documentation Templates and Rules Diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/sforce_hc_dtr_erd.png) - **[ServiceInfoRequestOperation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforequestoperation.htm)** Represents the system operation performed for a service information request such as a session launch or a questionnaire package operation. This object is available in API version 63.0 and later. - **[ServiceInfoRqstOpOutcome](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceinforqstopoutcome.htm)** Represents the outcome of a service information request operation. This object is available in API version 63.0 and later. # DocumentChecklistItem Represents a checklist item for a documentation file upload. This object is available in API version 47.0 and later. ## Supported Calls describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search() ## Fields ### AccountId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Read only. The ID of the account the document checklist item belongs to. The value of the field is set internally using the ParentRecordId field. ### Comments - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Comments added when validating a target reference object against the document checklist item. This field is available only if you have enabled Integrated Onboarding for Financial Services Cloud. ### DocumentCategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The document category related to the document checklist item. This field is available only if you have enabled Integrated Onboarding for Financial Services Cloud. This field is a relationship field. ### DocumentTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the document type for the document checklist item. ### Instruction - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Instructions associated with the document checklist item. ### IsAccepted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the file has been accepted. - **Default value**: False ### IsFrozen - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the item can no longer be modified. - **Default value**: False ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates if the document checklist item is required. - **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 document checklist item. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user who owns this record. ### ParentRecordId - **Type**: master-detail reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Original parent object the document checklist item belonged to. ### ReceivedDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is a relationship field. - **Relationship Name**: ReceivedDocument - **Relationship Type**: Lookup - **Refers To**: ReceivedDocument ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Uploaded document checklist item status. - **Default value**: New - **Possible values**: - Accepted - New - Pending - Waived - Not Verified - Rejected ### UploadedById - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Person who uploaded the file. ### ValidatedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who validated the target reference object against the document checklist item. This field is available only if you have enabled Integrated Onboarding for Financial Services Cloud. ### ValidationDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the target reference object was validated. This field is available only if you have enabled Integrated Onboarding for Financial Services Cloud. ### WhoId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Person that the uploaded documentation pertains to. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [DocumentChecklistItemFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DocumentChecklistItemHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DocumentChecklistItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DocumentChecklistItemShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DocumentExtractionDef Represents the metadata definition used to manage and execute document data extraction processes. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.262.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location Replace DEVELOPER\_NAME with the developer name of the definition. DocumentExtractionDef values are stored in the DEVELOPER\_NAME.documentExtractionDef file in the documentExtractionDefs directory. ## Version DocumentExtractionDef is available in API version 66.0 and later. ## Fields ### batchProcessingStartTime - **Field Type**: dateTime - **Description**: The date and time when batch processing starts. Files with earlier timestamps are excluded during processing. ### batchUser - **Field Type**: User - **Description**: The user associated with the batch processing. ### description - **Field Type**: string - **Description**: The description of the document extraction definition. ### documentExtractionDefVer - **Field Type**: [DocumentExtractionDefVer](#DocumentExtractionDefVer) - **Description**: An array of specific version settings configuration objects metadata details associated with this definition. ### documentExtrctDefProcFldr - **Field Type**: [DocumentExtrctDefProcFldr](#DocumentExtrctDefProcFldr) - **Description**: The destination or source target file directories utilized for document data intake and execution processing. ### isActive - **Field Type**: boolean - **Description**: Indicates whether the document extraction definition is currently active (true) or inactive (false). ### isReviewRequired - **Field Type**: boolean - **Description**: Indicates whether the extraction requires review before the data is saved (true) post-extraction parsing cycles. ### label - **Field Type**: string - **Description**: The user-facing display label assigned to the DocumentExtractionDef interface reference component entity. ### status - **Field Type**: DocumentExtractionDefStatus (enumeration of type string) - **Description**: The status of the document extraction definition. - **Possible values**: - BatchDefined - BatchActive ### type - **Field Type**: DocumentExtractionDefType (enumeration of type string) - **Description**: The type of document extraction definition, such as standard (pre-defined) or custom. - **Possible values**: - Standard - Custom ## DocumentExtractionDefVer ### confidenceThreshold - **Field Type**: int - **Description**: The minimum target parsing percentage target reliability score limit needed to assume accurate field target identification values. ### contextMappingConfig - **Field Type**: string - **Description**: The contextual data JSON string schema properties layout blueprint rule map definitions metadata block references path tracking array context. ### description - **Field Type**: string - **Description**: A localized detailed log note describing updates modifications structural variation purpose for this unique schema line record definition item. ### documentExtractionDefStep - **Field Type**: [DocumentExtractionDefStep](#DocumentExtractionDefStep) - **Description**: An object collection mapping sub-step definitions tracking exact layout actions scheduled during runtime extraction sequences. ### isActive - **Field Type**: boolean - **Description**: Specifies if this individual instance specification criteria variant is actively queried during systemic runtime analysis operations. ### largeLanguageModel - **Field Type**: string - **Description**: The identifying string name or version designation of the targeted Large Language Model engine pipeline system utilized. ### llmInputPrompt - **Field Type**: string - **Description**: The structural systemic instruction or system prompt template text sequence supplied directly to the parsing large language model platform engine. ### versionNumber - **Field Type**: int - **Description**: The unique sequential revision integer tracked for this layout iteration mapping block profile data records configuration. ## DocumentExtractionDefStep ### executionProcessReference - **Field Type**: string - **Description**: The unique component path developer key string reference matching the automation runtime execution pipeline logic block element engine. ### stepNumber - **Field Type**: int - **Description**: The sorting hierarchy sequencing index tracking the relative ordering path allocation logic map positioning order for execution. ### stepType - **Field Type**: DocExtractReqStepType (enumeration of type string) - **Description**: Defines the operational category action logic behavior module processed through this specific sequenced execution schema element state item. - **Possible values**: - Extract - Transform - PostTransformAction - Save - PostSaveAction - Validation ## DocumentExtrctDefProcFldr ### ContentHubRepositoryId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Files Connect Repository ID of this Document Extraction Definition Processing Folder. - **Relationship Name**: ContentHubRepository - **Relationship Type**: Lookup - **Refers To**: ContentHubRepository ### folderPath - **Field Type**: string - **Description**: The absolute uniform identifier path url map text pattern resolving locations target destination directory container locations repository asset paths. ### folderType - **Field Type**: DocExtractDefFldrType (enumeration of type string) - **Description**: Identifies the file system interface backend hosting vendor engine target destination configuration format tracking specification metadata blocks. - **Possible values**: - ContentFolder - Amazon - AzureBlob ### lastProcessedTime - **Field Type**: dateTime - **Description**: The date time record mark capturing historical execution sweeps tracking the absolute instance execution runtime cycle. ## Declarative Metadata Sample Definition The following is an example of a DocumentExtractionDef component. true The following is an example package.xml that references the previous definition. \* DocumentExtractionDef 66.0 # DocumentExtractionRequest Represents a request to extract documents. 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 ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the document. This field is a relationship field. - **Relationship Name**: ContentDocument - **Refers To**: ContentDocument ### DocumentUploadMethod - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the document was added manually by a user or automatically by the system. - **Possible values**: - Automatic - Manual ### 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 document. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the document. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this document. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ServiceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the category for the type of service being provided. - **Possible values**: - OpenAIComplianceClauseExtraction - IntelligentDocumentProcessing - EinsteinGPTService ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the document clause extraction review status. - **Possible values**: - ExtractionFailed - ExtractionInProgress - ReviewCompleted - ReviewExpired - ReviewInProgress - ReviewNotStarted - SaveCompleted - SaveFailed - SaveInProgress ### StatusReason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the record's current status. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the document extraction request. - **Possible values**: - CaseIntakeForm - CompliancePolicyClauseExtraction - DiseaseDefinition - RegulationClauseExtraction ## 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. [DocumentExtractionRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [DocumentExtractionRequestShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DocumentExtractionRqstStep Represents each step involved in the document extraction request process. This object is available in API version 64.0 and later. ## Example ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### DocumentExtractionRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent document extraction request associated with the document extraction request step. This field is a relationship field. - **Relationship Name**: DocumentExtractionRequest - **Relationship Type**: Master-detail - **Refers To**: DocumentExtractionRequest (the master object) ### InputData - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The JSON input required for the current document extraction request step. ### 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 document. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the document extraction request step. ### OutputData - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The JSON output of the current step, which is passed as input for the next step. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the document extraction request step. - **Possible values**: - Completed - Error - InProgress - New ### StatusReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The reason for the document extraction request step status. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of document extraction request step. - **Possible values**: - Extract - Save - Transform ## 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. [DocumentExtractionRqstStepHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # DocumentExtrctDefProcFldr Represents a Document Extraction Definition Processing Folder record in your Salesforce org. This object is available in API version 67.0 and later. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update() ## Supported REST API Calls DELETE, GET, HEAD, PATCH, POST, Query ## Fields ### ContentHubRepositoryId - **Type**: Reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Files Connect Repository ID of this Document Extraction Definition Processing Folder. - **Relationship Name**: ContentHubRepository - **Relationship Type**: Lookup - **Refers To**: ContentHubRepository ### CreatedById - **Type**: Reference - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: The Created By ID of this Document Extraction Definition Processing Folder. - **Relationship Name**: CreatedBy - **Relationship Type**: Lookup - **Refers To**: User ### CreatedDate - **Type**: Datetime - **Properties**: Defaulted on create, Filter, Sort - **Description**: The Created Date of this Document Extraction Definition Processing Folder. ### DocumentExtractionDefId - **Type**: Reference - **Properties**: Create, Filter, Group, Sort - **Description**: The Document Extraction Definition ID of this Document Extraction Definition Processing Folder. - **Relationship Name**: DocumentExtractionDef - **Relationship Type**: Lookup - **Refers To**: DocumentExtractionDef ### FolderPath - **Type**: Textarea - **Properties**: Create, Update - **Description**: The Folder Path of this Document Extraction Definition Processing Folder. ### FolderType - **Type**: Picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Possible values**: - Amazon—Amazon S3 - AzureBlob—Azure Blob - ContentFolder—Content Folder ### Id - **Type**: Id - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: The Document Extraction Definition Processing Folder ID of this Document Extraction Definition Processing Folder. ### IsDeleted - **Type**: Boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: The Deleted of this Document Extraction Definition Processing Folder. ### LastModifiedById - **Type**: Reference - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: The Last Modified By ID of this Document Extraction Definition Processing Folder. - **Relationship Name**: LastModifiedBy - **Relationship Type**: Lookup - **Refers To**: User ### LastModifiedDate - **Type**: datetime - **Properties**: Defaulted on create, Filter, Sort - **Description**: The Last Modified Date of this Document Extraction Definition Processing Folder. ### LastProcessedTime - **Type**: Datetime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The Last Processed Time of this Document Extraction Definition Processing Folder. ### ManageableState - **Type**: Picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **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 ### SystemModstamp - **Type**: Datetime - **Properties**: Defaulted on create, Filter, Sort - **Description**: The System Modstamp of this Document Extraction Definition Processing Folder. ## Usage Use this object to query and manage Document Extraction Definition Processing Folders in your org. Client applications can create, update, delete, or query records associated with Document Extraction Definition Processing Folder via the API. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_documentreference.png) # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # DTRMetricData The DTRMetricData FHIR resource maps to the ServiceInformationRequest, ServiceInfoRequestDetail, ServiceInfoRequestOperation, andServiceInfoResponseCoverageobjects. ## FHIR V4.0 - Documentation Templates and Rules Data Model Mapping Here’s how the fields defined by FHIR for [DTRMetricData](https://build.fhir.org/ig/HL7/davinci-dtr/StructureDefinition-DTRMetricData-definitions.html) map to the fields in Salesforce. Table 1. DTRMetricData - Salesforce | DTRMetricdata element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | source | ServiceInformationRequest.SourceType | Picklist | 1.1 | N/A | | sofApp | ServiceInformationRequest.ApplicationUrl | URL | 0.1 | N/A | | providerId | ServiceInformationRequest.RequesterStandardIdentifier | Lookup: Identifier | 1.1 | N/A | | groupId | ServiceInformationRequest.RequesterOrgStdIdentifier | Lookup: Identifier | 1.1 | N/A | | payerId | ServiceInformationRequest.RecipientOrgIdentifier | Lookup: Identifier | 1.1 | N/A | | orderItem | ServiceInfoRequestDetail.DetailType | Picklist | 1.1 | Select Order Detail as the picklist value in DetailType. | | assertion.Id | ServiceInfoRequestDetail.DetailType | Picklist | 1.1 | Select Assertion Identifier as the picklist value in DetailType. | | assertion.Id | ServiceInfoRequestDetail.DetailValue | String | 0.1 | Enter the assertion ID in Detail Value when the detail type is Assertion Identifier. | | action.detail | ServiceInfoRequestOperation.OperationType | | 1.1 | N/A | | action.questionnaire | ServiceInfoRequestOperation.QuestionnaireUrl | URL | 0.1 | N/A | | action.requestTime | ServiceInfoRequestOperation.InitiatedDateTime | DateTime | 1.1 | N/A | | action.responseTime | ServiceInfoRequestOperation.ResponseDateTime | DateTime | 0.1 | N/A | | action.httpResponse | ServiceInfoRequestOperation.ResponseStatusCode | Integer | 0.1 | N/A | | issue | ServiceInfoRequestDetail.DetailType | Picklist | 0.M | Select Issue as the picklist value for DetailType. | | issue.code | ServiceInfoRequestDetail.DetailCodeType | Picklist | 1.1 | N/A | | issue.details | ServiceInfoRequestDetail.DetailCode | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | | doc.Reason | ServiceInformationRequest.DocRequiredReasonType | Multi-select Picklist | 0.M | N/A | | launchMode | ServiceInformationRequest.ContextType | Picklist | 0.1 | N/A | | coverageInfo.covered | ServiceInfoResponseCoverage.CoverageIndicator | Picklist | 0.1 | N/A | | coverageInfo.paNeeded | ServiceInfoResponseCoverage.PreapprovalRequirementInd | Picklist | 0.1 | N/A | | coverageInfo.docNeeded | ServiceInfoResponseCoverage.RequiredDocumentationType | Picklist | 0.1 | N/A | | coverageInfo.infoNeeded | ServiceInfoResponseCoverage.RequiredAddlInfoType | Picklist | 0.1 | N/A | | coverageInfo.assertionId | ServiceInfoResponseCoverage.CoverageAssertionIdentifier | Picklist | 0.1 | N/A | | coverageInfo.satisfiedId | ServiceInfoResponseCoverage.PreapprovalIdentifier | String | 0.1 | N/A | | coverageInfo.businessLine | ServiceInfoResponseCoverage.CoveragePlanTypeId | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | # DTRQuestionnaireResponse The DTRQuestionnaireResponse FHIR resource maps to the Assessment and AssessmentReason object. ## FHIR V4.0 - Discovery Framework Data Model Mapping Here’s how the fields defined by FHIR for [DTRQuestionnaireResponse](https://build.fhir.org/ig/HL7/davinci-dtr/StructureDefinition-dtr-questionnaireresponse.html) map to the fields in Salesforce. Table 1. DTRQuestionnaireResponse - Salesforce | DTRQuestionnaireResponse element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | QuestionnaireResponse.authored | Assessment.CompletedDateTime | DateTime | 0.1 | N/A | | QuestionnaireResponse.author | Assessment.Assessor | Reference: Account, Contact, Healthcare Provider, User | 0.1 | N/A | | QuestionnaireResponse.Identifier | Assessment.Identifier | String | 0.1 | N/A | | QuestionnaireResponse.item.answer.extension:origin | AssessmentQuestionResponse.OriginType | Picklist | 0.1 | See [InformationOrigin](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_informationorigin.htm) to learn how the AssessmentQuestionResponse fields map to the elements in the InformationOrigin resource. | | QuestionnaireResponse.item.answer.extension:origin | AssessmentQuestionResponse.ReviewerId | Reference: Account, Contact, Healthcare Provider, User | 0.1 | See [InformationOrigin](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_informationorigin.htm) to learn how the AssessmentQuestionResponse fields map to the elements in the InformationOrigin resource. | | QuestionnaireResponse.item.answer.extension:origin | AssessmentQuestionResponse.ReviewerRoleId | Reference: Code Set, Code Set Bundle | 0.M | See [InformationOrigin](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_informationorigin.htm) to learn how the AssessmentQuestionResponse fields map to the elements in the InformationOrigin resource. | | QuestionnaireResponse.extension:context | AssessmentReason.ReferenceRecordId | Reference: Clinical Service Request, Medication Request | 0.M | N/A | | QuestionnaireResponse.extension:context | AssessmentReason.ReferenceValue | String Plus Clob | 0.M | N/A | # DTRStdQuestionnaire The DTRStdQuestionnaire FHIR resource maps to the AssessmentDefinition, AssessmentQuestion, AssessmentQuestionResponse, and AssessmentQuestionVersion objects. ## FHIR V4.0 - Discovery Framework Data Model Mapping Here’s how the fields defined by FHIR for [DTRStdQuestionnaire](https://build.fhir.org/ig/HL7/davinci-dtr/StructureDefinition-dtr-std-questionnaire.html) map to the fields in Salesforce. Table 1. DTRStdQuestionnaire - Salesforce | DTRStdQuestionnaire element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | Questionnaire.extension:performerType | AssessmentDefinition.PerformerType | Multi-select Picklist | 0.M | N/A | | Questionnaire.extension:entryMode | AssessmentQuestionResponse.DisplayType | Picklist | 0.1 | N/A | | Questionnaire.effectivePeriod | AssessmentQuestionResponse.EffectiveStartDate | DateTime | 0.1 | Since Salesforce doesn’t natively support the period data type, Questionnaire.effectivePeriod is flattened into a set of effective start date and effective end date fields. | | Questionnaire.effectivePeriod | AssessmentQuestionResponse.EffectiveEndDate | DateTime | 0.1 | Since Salesforce doesn’t natively support the period data type, Questionnaire.effectivePeriod is flattened into a set of effective start date and effective end date fields. | | Questionnaire.item.extension:displayCategory | AssessmentQuestion.DisplayTextCategory | Picklist | 0.1 | Select a display text category only when the data type is Text Block. | | Questionnaire.item.extension:displayCategory | AssessmentQuestionVersion.DisplayTextCategory | Picklist | 0.1 | Select a display text category only when the data type is Text Block. | # DuplicateObjectConfiguration Represents the duplicate detection configuration for a specific entity in Document AI processing. This class defines the target entity on which duplicate detection should be performed and the set of matching rules that should be applied to identify potential duplicate records. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[DuplicateObjectConfiguration Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_dup_obj_properties.htm)** The following are properties for duplicateObjectConfiguration. # DuplicateObjectConfiguration Properties The following are properties for duplicateObjectConfiguration. - **[objectApiName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_dup_obj_objectApiName.htm)** The API name of the entity (object) on which duplicate detection should be executed. - **[matchingRuleConfigurations](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_dup_obj_matchingRuleConfigurations.htm)** A list of duplicate detection rules associated with the entity\[cite: 18\]. # DuplicateRuleConfiguration Represents the configuration used to perform duplicate detection during Document AI processing. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[DuplicateRuleConfiguration Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_dup_properties.htm)** The following are properties for duplicateRuleConfiguration. # DuplicateRuleConfiguration Properties The following are properties for duplicateRuleConfiguration. - **[matchingRuleIdOrName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_matchingRuleIdOrName.htm)** The unique identifier or developer name of the matching rule to be used for duplicate detection. # 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). - **[DigitalVerification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_digitalverification.htm)** Stores information about the verification of a related record. This object is available in API version 60.0 and later. - **[DigitalVerificationSetup](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_digitalverificationsetup.htm)** 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. - **[DigitalVerfSetupDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_digitalverfsetupdetail.htm)** 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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Emergency Response Management Use the objects, fields, and metadata that extend Salesforce for Emergency Response Management. - **[Emergency Response Management Standard and Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/erm_hc_api_objects.htm)** Salesforce Emergency Response Management provides a rich set of standard and custom objects to store and access emergency response information. - **[Emergency Response Management Custom Fields on Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_custom_fields.htm)** Emergency Response Management adds custom fields to some standard Salesforce objects. - **[Emergency Response Management Business APIs](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_business_apis.htm)** Use Business APIs for building integrations or for creating custom UI components. The APIs wrap complex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as loading details of contact encounters into the system. # Emergency Response Management Business APIs Use Business APIs for building integrations or for creating custom UI components. The APIs wrap complex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as loading details of contact encounters into the system. - **[Contact Encounter (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_resource_contact_encounter_business_api.htm)** Load details of contact encounters into the system. # Emergency Response Management Custom Fields on Standard Objects Emergency Response Management adds custom fields to some standard Salesforce objects. - **[Account Custom Fields](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_account_custom_fields.htm)** Custom fields extend the standard Account object for use in Emergency Response Management. - **[Contact Custom Fields](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_contact_custom_fields.htm)** Custom fields extend the standard Contact object for use in Emergency Response Management. - **[Lead Custom Fields](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_erm_lead_custom_fields.htm)** Custom fields extend the standard Lead object for use in Emergency Response Management. # Emergency Response Management Standard and Custom Objects Salesforce Emergency Response Management provides a rich set of standard and custom objects to store and access emergency response information. To verify the complete list of fields for an object, you can use a describe call from the API, or inspect with an appropriate tool, for example, inspecting the WSDL or using a schema viewer. - **[ClinicalAssessmentResponse\_\_c](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_clinicalassessmentresponse.htm)** Represents the results of an assessment of a patient’s health condition. - **[ContactEncounter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_contactencounter.htm)** Represents a period of time during which two or more people were in close proximity to each other. - **[ContactEncounterParticipant](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_contactencounterparticipant.htm)** Represents a person who was present during a contact encounter. - **[HousingAssessment\_\_c](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_housingassessment__c.htm)** Represents the settings for assessing the living situation of individuals. This object is available in API version 49.0 and later. - **[Visit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_visit_erm.htm)** Represents a visit to inspect or assess an applicant’s ability to perform an emergency service. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_encounter.png) #### See Also - [ClinicalEncounter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # Engagement Interaction The engagement data model stores details, such as start date and end date, time, topic, and attendees, about an interaction between a customer or a customer-authorized representative and a customer service representative (CSR) or contact center agent (CCA). You can add up to 50 custom fields each in the EngagementAttendee, EngagementInteraction, and EngagementTopic objects. The engagement objects also support quick actions that help CCAs to perform routine actions quickly without navigating to multiple pages. CCAs can also create personalized list views for engagement objects by using the My engagement attendees, My engagement interactions, and My engagement topics filters.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud
- **[EngagementInteraction](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_engagementinteraction.htm)** Represents information about an interaction between a service representative or any other specialist in an organization and the organization’s customer. Engagement interactions can be initiated through communication channels and can cover one or more topics. For example, a customer can initiate an engagement interaction by calling a service representative to inquire about an insurance claim. This object is available in API version 55.0 and later. - **[EngagementAttendee](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_engagementattendee.htm)** Represents information about an attendee of an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, this object stores information about the customer and the service representative. This object is available in API version 55.0 and later - **[EngagementTopic](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_engagementtopic.htm)** Represents information about the topics discussed by a customer and other attendees during an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, the topic of the engagement is Claim. This object is available in API version 55.0 and later. # EngagementAttendee Represents information about an attendee of an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, this object stores information about the customer and the service representative. This object is available in API version 55.0 and later ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Health Cloud permission set license is required to use this object. ## Fields ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the engagement with the attendee ends. ### EngagementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The engagement interaction, messaging session, or voice call that’s related to the attendee. This field is a relationship field. - **Relationship Name**: Engagement - **Relationship Type**: Lookup - **Refers To**: EngagementInteraction, MessagingSession, VoiceCall ### ExternalAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The external user related to the engagement, such as the customer or partner. To avoid an error, either this field or the InternalAttendeeId field must have a value. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: ExternalAttendee - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### InternalAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The internal user related to the engagement, such as the call center agent. To avoid an error, either this field or the ExternalAttendeeId field must have a value. This field is a relationship field. - **Relationship Name**: InternalAttendee - **Relationship Type**: Lookup - **Refers To**: User ### IsAuthenticated - **Type**: boolean - **Properties**: Create, Defaulted on Create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction was authenticated through interactive voice response (IVR) or Web channel (true) or not (false). This field is available in API version 56.0 and later. - **Default value**: false ### IsVerified - **Type**: boolean - **Properties**: Create, Defaulted on Create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction was verified (true) or not (false). This field is available in API version 56.0 and later. - **Default value**: false ### 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**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Engagement Attendee record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement attendee record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### Role - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The role of an engagement attendee. This field is available in API version 56.0 and later. - **Possible values**: - OnBehalf - Self ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Required. The date and time when the engagement with the attendee starts. ### VerificationTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the attendee was verified for the engagement interaction. This field is available in API version 56.0 and later. ## Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## 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. [EngagementAttendeeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") [EngagementAttendeeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") [EngagementAttendeeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") # EngagementInteraction Represents information about an interaction between a service representative or any other specialist in an organization and the organization’s customer. Engagement interactions can be initiated through communication channels and can cover one or more topics. For example, a customer can initiate an engagement interaction by calling a service representative to inquire about an insurance claim. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Health Cloud permission set license is required to use this object. ## Fields ### AttendeeVerificationTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time when the attendee was verified for the engagement interaction. You can manually set this time. If isAttendeeVerified is set to true, then if you don’t manually set this time, it’s set based on the current system date and time. ### CommunicationChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Required. The communication channel through which engagement interaction occurs. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - In Person - Video Call - Voice Call - Web Chat ### ContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the record that’s considered as the context for the engagement interaction. For example, when a customer initiates an engagement interaction by booking a service appointment for an inquiry, the service appointment is the context for that engagement interaction. This field is a polymorphic relationship field. A polymorphic field is one where the related object can be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: Context - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment, Visit ### Duration - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Read-only. The duration of the engagement interaction based on the start date time and end date time. The duration is calculated when the end time is updated. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the engagement interaction ends. ### ExternalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique external identifier of the engagement interaction. ### InitiatingAttendeeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The attendee who initiated the engagement interaction. This field is a polymorphic relationship field. A polymorphic field is one where the related object can be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: InitiatingAttendee - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### IsAttendeeAuthenticated - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction has been authenticated through IVR or Web channel (true) or not (false). - **Default value**: false ### IsAttendeeVerified - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the initiating attendee of the engagement interaction has been verified (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, 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. ### MappedState - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Specifies the state of the engagement interaction that changes when the status of the interaction gets updated. - **Default value**: New - **Possible values**: - Completed - InProgress - New ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the Engagement Interaction record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement interaction record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### PhoneNumber - **Type**: phone - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The phone number of the caller to get the context about the previous engagement interaction. This field is available in API version 57.0 and later. ### Reason - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The reason for the engagement as stated by the customer or their representative during the engagement interaction. This field is available from API version 56.0 and later. ### Sentiment - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The analyzed sentiment of the engagement interaction attendee about the engagement interaction. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Negative - Neutral - Positive ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Required. The date and time when the engagement interaction starts. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the engagement interaction, which also impacts the interaction state. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Completed - In Progress - New ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of interaction that was initiated by the attendee. Your Salesforce admin can define new field values or update the existing field values. - **Possible values**: - Inbound - Outbound ## Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## 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. [EngagementAttendeeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") [EngagementAttendeeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") [EngagementAttendeeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") # EngagementTopic Represents information about the topics discussed by a customer and other attendees during an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, the topic of the engagement is Claim. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules The Health Cloud permission set license is required to use this object. ## Fields ### EngagementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The engagement interaction, messaging session, or voice call record that’s related to the topic discussed during the engagement. This field is a relationship field. - **Relationship Name**: Engagement - **Relationship Type**: Lookup - **Refers To**: EngagementInteraction, MessagingSession, VoiceCall ### InteractionSummary - **Type**: string - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The summary of the engagement interaction. This field is available in API version 56.0 and later. ### 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**: Required. The name of the engagement topic record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The Salesforce ID of the person who owns this engagement topic record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### ParentTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The parent engagement topic record that’s associated with this engagement topic. This field is a relationship field. - **Relationship Name**: ParentTopic - **Relationship Type**: Lookup - **Refers To**: EngagementTopic ### ProcessFailureReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the reason the process failed during the engagement interaction. The source is selected from a picklist of available values, which are set by your Salesforce administrator. ### ProcessName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the process executed during the engagement interaction. ### ProcessStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the current status of the process that’s executed during the engagement interaction. Your Salesforce administrator can define new or update the existing field values. - **Possible values**: - Cancelled - Completed - Failed - Initiated ### ProcessType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of the process executed during the engagement interaction. - **Possible values**: - Flow - OmniScript - QuickAction ### RelatedPersonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person for whom the engagement interaction has been initiated. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: RelatedPerson - **Relationship Type**: Lookup - **Refers To**: Account, Contact, Lead ### TopicId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The engagement topic record that’s associated with the parent engagement topic. This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead. - **Relationship Name**: Topic - **Relationship Type**: Lookup - **Refers To**: Asset, Case, Claim, LoyaltyMemberTier, LoyaltyProgramMember, Opportunity, Order, ServiceAppointment, Voucher, TransactionJournal, and custom object ## Usage This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates. ## 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. [EngagementAttendeeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_change_event.htm "HTML (New Window)") [EngagementAttendeeFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_feed.htm "HTML (New Window)") [EngagementAttendeeHistory](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/sforce_api_associated_objects_history.htm "HTML (New Window)") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Represents an error encountered during Document AI processing. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[Error Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_properties.htm)** The following are properties for error. # 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 Properties The following are properties for error. - **[errorCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_errorCode.htm)** Identifies the type or category of error encountered during Document AI processing. - **[errorMessage](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_errorMessage.htm)** Description of the error, providing additional details to help diagnose or understand the issue. # 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 | # errorCode Identifies the type or category of error encountered during Document AI processing. ## Signature public String errorCode {get; set;} ## Property Value Type: String # errorMessage Description of the error, providing additional details to help diagnose or understand the issue. ## Signature public String errorMessage {get; set;} ## Property Value Type: String # errors The list of errors encountered during post-save processing, if any. ## Signature public List errors {get; set;} ## Property Value Type: List<> # errors The list of errors encountered during post-transformation, if any. ## Signature public List errors {get; set;} ## Property Value Type: List # ExtenisbleServiceConfig\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ImplementationClass\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the extensible service configuration. Limit: 255 characters. ### NamespacePrefix\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The prefix of the namespace. # Extract Document Data The response representation containing stringified extraction payload details. ## Properties | Property Name | Type | Description | | --- | --- | --- | | version | String | The schema mapping version model used (for example, V1). | | data | String | A stringified JSON payload detailing raw extracted key-value parameters. | | errors | List | A collection of structural extraction tracking errors. | # Extract Document Data (POST) Synchronously extracts unstructured file data using an intelligent ingestion template. ## Resource /connect/document-ai-automation/actions/extract ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "templateIdentifier": "InvoiceTemplate", "file":{ "contentDocumentId":"068xx00000xxbc", "data":"base64...", "mimeType":"application/pdf" } "pageRange": "1-5", "uploadMethod":"Manual"} ## Properties
Property Name Type Description Required
templateIdentifier String The template identifier (ID or developer name) of the target extraction template. Required
contentDocumentId String The Salesforce ID of the ContentDocument record. Required if data is empty.
data String Base64 encoded binary file string. Required if contentDocumentId is empty.
mimeType String The file format identifier (for example, application/pdf). Required if data is used.
pageRange String The targeted boundary range of pages to parse (for example, 1-5). Required when contentDocumentId is provided.
uploadMethod String Specifies the processing tracking method.
Available values are:
  • Manual
  • Automatic
 Optional
## Response Body for POST [Extract Document Data](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_extract_document_data_output.htm "The response representation containing stringified extraction payload details.") # Extract Document Data Input The request payload containing file properties and template tracking variables. ## JSON example { "templateIdentifier": "InvoiceTemplate", "file":{ "contentDocumentId":"068xx00000xxbc", "data":"base64...", "mimeType":"application/pdf" } "pageRange": "1-5", "uploadMethod":"Manual"} ## Properties
Property Name Type Description Required
templateIdentifier String The template identifier (ID or developer name) of the target extraction template. Required
contentDocumentId String The Salesforce ID of the ContentDocument record. Required if data is empty.
data String Base64 encoded binary file string. Required if contentDocumentId is empty.
mimeType String The file format identifier (for example, application/pdf). Required if data is used.
pageRange String The targeted boundary range of pages to parse (for example, 1-5). Required when contentDocumentId is provided.
uploadMethod String Specifies the processing tracking method.
Available values are:
  • Manual
  • Automatic
 Optional
# extractionMetadata Additional contextual information generated during post-transformation. ## Signature public DocumentAI.ExtractionMetadata extractionMetadata {get; set;} ## Property Value Type: String # ExtractionMetadata Represents additional metadata returned during Document AI processing, including matching resolution details and manual review requirements. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[ExtractionMetadata Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ext_meta_properties.htm)** The following are properties for extractionMetadata. # ExtractionMetadata Properties The following are properties for extractionMetadata. - **[objectConfig](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ext_meta_objectConfig.htm)** Specifies the resolution strategy applied when handling record matches during processing. - **[isManualReviewRequired](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ext_meta_isManualReviewRequired.htm)** Indicates whether the processed document requires manual review by a user. # FeatureToggleConfig\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Active - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether feature toggling is active (true) or not (false). ### DependantFeatures\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### Description\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Sort, Update - **Description**: A long text description of \[...\] ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Limit: 255 characters. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: # FeeScheduleDefinition Stores fee schedule information for contracts of Standard Care Fee Agreement types. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the Fee Schedule Definition. ### EffectiveEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The end date until when the Fee Schedule Definition is effective. ### EffectiveStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date from when the Fee Schedule Definition is effective. ### FeeScheduleDefinitionKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key assigned to the Fee Schedule Definition record. ### 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 Fee Schedule Definition. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The unique ID of the owner. 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. [FeeScheduleDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [FeeScheduleDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [FeeScheduleDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [FeeScheduleDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Subscription Publishers can use the Fast Healthcare Interoperability Resources (FHIR) Subscription data model to store subscription topics, subscriber details, the filters and parameters applied to a subscription, and other subscription details. When an event change occurs in the subscribed resource, it triggers a notification and a platform event is created as an Interoperability Topic Subscription Event record. Then, Mulesoft sends the notification to the subscriber’s endpoint in real time. The FHIR Subscription data model is available to users with the Health Cloud Foundation and the FHIR Subscription permission sets. # 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 Value Input Input representation for each field. ## Root XML tag ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | developerName | String | The developer name of the field. | Optional | 54.0 | | value | String | The value of the field. | Optional | 54.0 | # 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 | # fieldApiName The API name of the field to which the extracted value corresponds. ## Signature public String fieldApiName {get; set;} ## Property Value Type: String # fieldMatchingResolutionStrategy The resolution strategy applied when matching extracted document entities at the field level. ## Signature public String fieldMatchingResolutionStrategy {get; set;} ## Property Value Type: String # Fields on Account Health Cloud fields extend the standard Account object to represent information about patients and providers. #### See Also - [Payer](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_payer.htm "A payer is a health insurance company that helps cover the cost of member care. payer is represented by records on the Account object.") - [_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) ## Fields ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the person account is effective. ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from when the person account is no longer effective. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the person account is active (true) or not (false). - **Default value**: false ### SourceSystemIdentifier - **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. ### SourceSystemModifiedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date that the record was last modified in its source system. # Fields on Contact Health Cloud fields extend the standard Contact object to represent information about an individual. #### See Also - [_Object Reference for the Salesforce Platform_: Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contact.htm) ## Fields ### MaritalStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The individual's marital status. - **Possible values**: - Divorced - Married - Separated - Single - Widowed ### PersonSequenceInMultipleBirth - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: If the individual is part of a birth involving multiple babies, the sequence of the individual in that multiple birth. # Fields on Event and Task (Activity) Custom fields extend the standard Event and Task objects to represent information about an individual’s activities. ## Fields ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note The fields described here belong to both the Event and Task objects. However, in Object Manager, you can find these fields on the Activity object, not the Event or Task objects. This difference is because the Activity object is a supertype entity that includes the Event and Task objects. When Activity records are created, those records are saved as Event or Task records in the API. For more information about this relationship, see the [Tasks & Events Data Model](https://architect.salesforce.com/design/architecture-gallery/platform-task-events-data-model "HTML (New Window)") on the Salesforce Architects site. ### Age\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The age of the activity. ### CarePlanGoal\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the intended objectives of carrying out a care plan. This field is a relationship field. - **Relationship Name**: CarePlanGoal\_\_r - **Relationship Type**: Lookup - **Refers To**: CarePlanGoal\_\_c ### CarePlanProblem\_\_c - **Type** - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the conditions, problems, concerns, diagnoses, and so on, whose management and mitigation are handled by this plan. This field is a relationship field. - **Relationship Name**: CarePlanProblem\_\_r - **Relationship Type**: Lookup - **Refers To**: CarePlanProblem\_\_c ### CarePlanTemplate\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care plan template associated with this activity. This field is a relationship field. - **Relationship Name**: HealthCloudGA\_\_CarePlanTemplate\_\_r - **Relationship Type**: Lookup - **Refers To**: HealthCloudGA\_\_CarePlanTemplate\_\_c ### Category\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the type of activity. - **Possible values**: - Counselling - Diagnosis - Exercise - Vaccination ### Conditions\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the individual’s current condition related to this activity. - **Possible values**: - Asymptomatic - Asymptomatic - Declined to Participate - Cured - Evaluated - No Risk - Symptomatic - Symptomatic - Declined to Participate ### Contract\_Tracing\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Represents the individual’s contract tracing status related to this activity. - **Possible values**: - Completed - In Progress - Incoming - No Response ### Gender\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The individual’s gender. - **Possible values**: - Decline to Specify - Female - Male - Other ### Monitored\_at\_Home\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the activity was monitored at the individual’s home. - **Possible values**: - No - Yes ### SortOrder\_\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The order in which the task appears among other tasks associated with a goal. ### TaskType\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The list of healthcare-related tasks configured in the org. - **Default value**: Uncategorized - **Possible values**: - Administrative - Clinical - Other - Uncategorized ### Testing\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The individual’s testing status related to this activity. - **Possible values**: - Negative Test - Positive Test - Test Results Pending - Test Scheduled - Testing Recommended - Unknown # Fields on Lead Standard and custom fields extend the Lead object to represent information about an incoming patient. ## Fields ### AssignCareCoordinatorContact\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to Contact object. If populated and the AssignCareCoordinatorUser\_\_c field is blank, assigns the care coordinator role based on the contact record. ### AssignCareCoordinatorUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to User object. If populated, assigns the care coordinator role based on the user record. ### BirthDate\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The patient’s birthdate. ### BirthDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The provider's birthdate. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note This field is available in API version 61.0 and later with the Health Cloud Provider Network Management permission set. ### CreatedFromLead\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the individual was created from a converted lead (true) or not (false). ### InsuranceGroupId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Group ID of the patient or member’s insurance. ### InsuranceMemberId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Member ID of the patient or member’s insurace. ### InsuranceType\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of primary insurance: Medicare, Medicaid, commercial or self-pay. ### IsMarkedForPatientConversion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether the lead will be converted to a patient record. ### IsOutOfNetwork\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the referral is out-of-network. ### MedicalRecordNumber\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medical record number used to identify a patient. ### NumberOfLocations\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of locations associated with the lead. ### Primary\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the individual is the primary member of the household (true) or not (false). ### PrimaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### PrimaryInsurance\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Primary health insurance company associated with the patient. ### Priority\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Priority of the referral as designated by the referring provider. ### ReasonForOutOfNetworkReferral\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Reason the referral is sent out-of-network. ### ReasonForReferral\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Reason for the referral. ### ReferralStatus\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Indicates status of referral processing. ### ReferredToOrganization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the organization receiving or fulfilling the referral. ### ReferredToPractitioner\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the practitioner to whom the patient or member is being referred. ### ReferredToUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the user to whom the referral is sent. ### ReferringOrganization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the referring organization. ### ReferringPractitioner\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the practitioner who submitted the referral. ### ReferringUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the user who submitted the referral. ### RelatedAccount\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Look up to the account of the patient or member who is being referred. ### SecondaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### SourceSystemId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of an external record. This field can’t be encrypted. ### SourceSystem\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The system that created the record and owns updating rights for it. ### Specialty\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Specialty associated with the referral. ### Specialty - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Specialty associated with the provider. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note This field is available in API version 61.0 and later with the Health Cloud Provider Network Management permission set. ### TertiaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### TypeOfService\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Type of service requested. # Fields on Opportunity Standard and custom fields extend the Opportunity object to represent information about an incoming patient. ## Fields ### AssignCareCoordinatorContact\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to Contact object. If populated and the AssignCareCoordinatorUser\_\_c field is blank, assigns the care coordinator role based on the contact record. ### AssignCareCoordinatorUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to User object. If populated, assigns the care coordinator role based on the user record. ### BirthDate\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The patient’s birthdate. ### CreatedFromLead\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the individual was created from a converted lead (true) or not (false). ### PrimaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### InsuranceGroupId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Group ID of the patient or member’s insurance. ### InsuranceMemberId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Member ID of the patient or member’s insurace. ### InsuranceType\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of primary insurance: Medicare, Medicaid, commercial or self-pay. ### IsMarkedForPatientConversion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether the lead will be converted to a patient record. ### IsOutOfNetwork\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the referral is out-of-network. ### MedicalRecordNumber\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medical record number used to identify a patient. ### NumberofLocations\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of locations associated with the lead. ### Primary\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the individual is the primary member of the household (true) or not (false). ### PrimaryInsurance\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Primary health insurance company associated with the patient. ### Priority\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Priority of the referral as designated by the referring provider. ### ReasonForOutOfNetworkReferral\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Reason the referral is sent out-of-network. ### ReasonForReferral\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Reason for the referral. ### ReferralReceivedDate\_\_c - **Type**: date - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Date referral was received by the organization. ### ReferredToOrganization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the organization receiving or fulfilling the referral. ### ReferredToPractitioner\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the practitioner to whom the patient or member is being referred. ### ReferredToUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the user to whom the referral is sent. ### ReferringOrganization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the referring organization. ### ReferringPractitioner\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the practitioner who submitted the referral. ### ReferringUser\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of the user who submitted the referral. ### SecondaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### SourceSystemId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The ID of an external record. This field can’t be encrypted. ### SourceSystem\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The system that created the record and owns updating rights for it. ### Specialty\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Specialty associated with the referral. ### TertiaryDiagnosis\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Lookup to the HealthcareDiagnosis object. ### TypeOfService\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Type of service requested. # Fields on ProductRequest Health Cloud fields extend the standard ProductRequest object to associate it with care programs and to track modification history. ## Fields ### 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 - **Refers To**: CareProgramEnrollee ### LastModifiedById - **Type**: Reference - **Properties**: Aggregatable, Defaulted on create, Filter, Group, Sort - **Description**: ID of the user who last updated this object. # Fields on Service Appointment Standard and custom fields extend the standard Service Appointment object to represent information about a healthcare appointment. ## Fields ### StatusReason - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A higher-level category for explaining the value given as the status of the appointment. The picklist includes the following values, which can be customized: - None—Default value. - Proposed - NoShow - Rejected # fieldType The data type of the field (for example, String, Date, Number). ## Signature public String fieldType {get; set;} ## Property Value Type: String # FieldValue Class Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[FieldValue Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_constructors)** - **[FieldValue Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_properties)** ## FieldValue Constructors The following are constructors for FieldValue. - **[FieldValue(developerName, value)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_ctor)** Creates an instance of the [FieldValue](#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.") class with the specified parameter values. - **[FieldValue()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_ctor_2)** Creates an instance of the [FieldValue](#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.") class. ### FieldValue(developerName, value) Creates an instance of the [FieldValue](#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.") class with the specified parameter values. #### Signature public FieldValue(String developerName, String value) #### Parameters developerName Type: String The developer name of the field that is used for search results and verification. value Type: String The value of the field that is used for search results and verification. ### FieldValue() Creates an instance of the [FieldValue](#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.") class. #### Signature public FieldValue() ## FieldValue Properties The following are properties for FieldValue. - **[developerName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_developerName)** The developer name of the field that is used for search results and verification. - **[value](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_id_verification_FieldValue_value)** The value of the field that is used for search results and verification. ### developerName The developer name of the field that is used for search results and verification. #### Signature public String developerName {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 The value of the field that is used for search results and verification. #### 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) # Financial Assistance Program The financial assistance program data model helps health and 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. ![images/hc\_financial\_assistance\_program\_erd.png](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_financial_assistance_program_erd.png) - **[Applicant](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/lsc_sforce_api_objects_applicant.htm)** Specify the care program enrollee represented as an applicant. This object is available in API version 59.0 and later. - **[Benefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/lsc_sforce_api_objects_benefit.htm)** 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. - **[BenefitType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/lsc_sforce_api_objects_benefittype.htm)** 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. - **[CareProgramAssistance](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprogramassistance.htm)** Represents a junction between Care Program and Program objects. This object is available in API version 61.0 and later. - **[ProgramEnrollment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/lsc_sforce_api_objects_programenrollment.htm)** Represents details of enrollment for benefits in a program. This object is available in API version 57.0 and later. - **[ProgramEnrlEligibilityCrit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_programenrleligibilitycrit.htm)** Represents a junction between Program and Enrollment Eligibility Criteria objects. This object is available in API version 61.0 and later. - **[ProgramRecommendationRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_programrecommendationrule.htm)** Represents the eligibility criteria and recommendation for a program. This object is available in API version 61.0 and later. # Find Available Time Slots for an Appointment When a call center agent wants to schedule an appointment, the first step is to find the available time slots for providers who match the patient’s needs. The call center agent gathers selection criteria and then initiates a search to obtain the available slots for providers who match the criteria. - **Type**: Controller - **Verb**: POST - **Default URL Path**: /Slot/\_search - **Content-Type (Header)**: application/x-www-form-urlencoded Your Base URL is configured in Setup > Appointment Scheduling. All communications with the external system use the FHIR R4 standard. ## Request Body schedule:Schedule.actor:Practitioner.identifier=http://hl7.org/fhir/sid/us-npi|323,434,567,342,234,224,423 &schedule:Schedule.actor:Location.\_id=epic|555,epic|123,allscripts|124,allscripts|221,cerner|222,cerner|223,athena|331,athena|332 &schedule:Schedule.actor:Practitioner.\_id=epic|2342342,&start=ge2020-10\-10 &start=le2021-03\-31&appointment-type=epic|ROUTINE,epic|ROUTINE,cerner|RTN,athena|REGULAR &service-type=epic|H999,cerner|E100,athena|C200,allscripts|A300 &status=free &\_include=Slot:schedule &\_sort=start ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note The request payload is sent as single line. It is listed here in separate lines for readability. ## Multiple Source Systems If you are working with more than one source system, the Location.\_id gets the source system name and ID in pipe-delimited pairs, separated by commas, like this: schedule:Schedule.actor:Location.\_id=epic|1404774,cerner|1476569 For a single source system, the Location.\_id is the ID only, like this: schedule:Schedule.actor:Location.\_id=1404774,1476569 ## Response Codes - 200: Success - 400: Bad request - 401: Unauthorized - 5xx: Server error ## Response Body - To map slots, resource, resourceType, id, schedule, actor, start, and end are required in the FHIR response. - Response is a map keyed by CareProvider.careProviderId to give all available slots within the start/end range for a single practitioner+facility pair that can fulfill an appointment for the serviceTypeCode+appointmentTypeCode. - If a practitioner+facility pair is not found in the source system, the provider is ignored and nothing is returned for that careProviderId. If a practitioner+facility pair does not have availability that matches the slot range and codes, the careProviderId is returned without any slots. - By default, the list of returned slots for each provider is sorted by date/time in ascending order. - The sourceSlotId for a slot is the ID of a time slot in the source system for a care provider (eg. practitioner+facility) that can fulfill a specific serviceTypeCode+appointmentTypeCode. Given this ID during appointment booking, the source system is able to identify the practitioner, facility, time slot, service type and appointment type. { "resourceType": "Bundle", "id": "", "meta": {"lastUpdated":}, "type": "searchset", "total": n, "entry": \[ "fullUrl" : "" , "resource" : { "resourceType" : "Slot", "id" : "", "identifier" : \[{ Identifier }\], "serviceCategory" : \[{ CodeableConcept }\], "serviceType" : \[{ CodeableConcept }\], "specialty" : \[{ CodeableConcept }\], "appointmentType" : { CodeableConcept }, "schedule" : { Reference(Schedule) }, //expects to get actor in this object "status" : "", "start" : "", "end" : "", "overbooked" : , "comment" : "" } \] } ## Error Response for Multiple Source Systems { "resourceType": "Bundle", ....... "entry": \[ { "fullUrl": "http://hapi.fhir.org/baseR4/Slot/1939809", "resource": { "resourceType": "Slot", ....... }, "search": {"mode": "match"} }, { "fullUrl": "http://hapi.fhir.org/baseR4/Schedule/1939822", "resource": { "resourceType": "Schedule", "id": "1939822", ..... }, "search": {"mode": "include"} }, { //If the targeting system is FHIR R4, you get OperationOutcome resource as error. Pass it back with one of the elements in "Bundle.entry" and "extension" to identify the target system. "resourceType": "OperationOutcome", .... "extension" : \[{ "url" : "https://fhir-ehr-code.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Slot/\_search33", "value" : "cerner" }\] "issue": \[ { "severity": "error", "code": "processing", "diagnostics": "Invalid request: The FHIR endpoint on this server does not know how to handle GET operation\[Slot/\_search33\] with parameters \[\[\_include, \_pretty, schedule:Schedule.actor:Practitioner.identifier, appointment-type, service-type, schedule:Schedule.actor:Practitioner.\_id, schedule:Schedule.actor:Location.\_id\]\]" } \] } \] } ## Identifier { "use" : "", // usual | official | temp | secondary | old (If known) "type" : { CodeableConcept }, // OPTIONAL Description of identifier **"system" : "", // The namespace for the identifier value "value" : "$lt;string>", // The value that is unique ** "period" : { Period }, // OPTIONAL Time period when id is/was valid for use "assigner" : { Reference(Organization) } // OPTIONAL Organization that issued id (may be just text) } ## CodeableConcept { // from Element: extension **"coding" : \[{ Coding }\], // Code defined by a terminology system** "text" : "" // Plain text representation of the concept } ## Coding { **"system" : "", // Identity of the terminology system** "version" : "", // OPTIONAL Version of the system - if relevant **"code" : "", // Symbol in syntax defined by the system** "display" : "", // Representation defined by the system "userSelected" : // OPTIONAL If this coding was chosen directly by the user } #### See Also - [FHIR Resource: Slot](https://www.hl7.org/fhir/slot.html) # FindSlotsRequest Class Contains set of options to find available time slots for providers who match the patient’s needs. This class extends the AppointmentBase class and inherits its properties. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[FindSlotsRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_healthcloudext_FindSlotsRequest_properties)** ## FindSlotsRequest Properties The following are properties for FindSlotsRequest. - **[slotRangeEnd](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_healthcloudext_FindSlotsRequest_slotRangeEnd)** Represents the start of date range for slots in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z. - **[slotRangeStart](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_healthcloudext_FindSlotsRequest_slotRangeStart)** Represents the end of date range for slots in ISO 8601 format, for example , 2021-02-25T18:24:31.000Z. - **[isNextAvailSlot](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_healthcloudext_FindSlotsRequest_isNextAvailSlot)** In the default Apex class, if the property is set to True, gets a provider's next 160 available slots for appointment scheduling. If set to False, gets the next 500 available slots of providers in general. - **[patientId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_healthcloudext_FindSlotsRequest_patientId)** Represents a patient's AccountId. ### slotRangeEnd Represents the start of date range for slots in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z. #### Signature public String slotRangeEnd {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotRangeStart Represents the end of date range for slots in ISO 8601 format, for example , 2021-02-25T18:24:31.000Z. #### Signature public String slotRangeStart {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### isNextAvailSlot In the default Apex class, if the property is set to True, gets a provider's next 160 available slots for appointment scheduling. If set to False, gets the next 500 available slots of providers in general. #### Signature public Boolean isNextAvailSlot {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### patientId Represents a patient's AccountId. #### Signature public Boolean patientId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Health Cloud Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. #### See Also - [_Metadata API Developer Guide_: Flow](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_visual_workflow.htm "Metadata API Developer Guide: Flow - HTML (New Window)") ## FlowActionCall Health 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 only for Health Cloud include: - appointment—Create or book a new appointment. - createQuoteForHomeVisits—Create a quote for patient home visits based on the specified visit details. - createReferral—Create a patient referral record. - createTemplateOfServiceAppt—Create a template service appointment with a status of Cancelled to manually schedule home visits. - convertRecord— Convert leads to patient records within Health Cloud by setting up a simple conversion process. - getResources—Search for available resources, such as healthcare providers or medical assets, based on specified search criteria.. - getResourcesForMnlScheduling—Get recommended resources that can be used when you manually schedule a start of care visit or recurring visits. - getTranscriptForConversation—Gets the transcript for a specified conversation record such as voice call, messaging session, or chat transcript. This value is available in API version 64.0 and later. - handleResourceAbsence—Remove a service resource’s visit assignments for a specified period and optionally update the status of the affected visits to a specified value. - invokeGenericFHIR—Invoke an external service by including the provided payload as the request body and return the response received from the external service. - processReceivedDocument—Create a record with the processed results of a received document. - scheduleHomeVisitManually—Create start of care or recurring home healthcare visits and assign care resources that are manually selected by the scheduler to the visits. - scheduleHomeVisit—Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care. - scheduleRecurringHomeVisit—Create a set of recurring home healthcare visits and assign service resources to them based on the specified scheduling policy. # 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 | # Get Appointment Slots Action Get available appointment slots for healthcare providers or assets based on specified criteria. Calls the Get Appointment Slots Connect API. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getAppointmentSlots 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
appointmentTypes Array Types of appointments available for selection.
assetCategory String Category of the asset. Used only when the resource type is Asset.
channelId String Required

ID of the engagement channel.
endDate String Required

Ending date and time for the slot search in ISO 8601 format. Must be after the start date.
resourceId ID Required

ID of the healthcare provider or asset for the appointment search.
resourceType String Required

Type of resource, such as Provider or Asset. The default value is Provider.

serviceCategories Array Service categories associated with the appointment.
serviceResourceId ID ID of the service resource associated with the appointment.
serviceTerritoryId ID ID of the location, such as the service territory for a provider or the account for an asset.
serviceTypes Array Service types associated with the appointment.
sourceSystem String Source system where the appointment slots originate.
startDate String Required

Beginning date and time for the slot search in ISO 8601 format (for example, 2026-07-15T00:00:00Z).
workTypeId String Required

ID of the work type. Required unless service categories, service types, or appointment types are provided.
## Outputs | Output | Type | Description | | --- | --- | --- | | availableSlots | Array | List of available appointment slots for the requested resource and date range. | ## Example **Sample Request** { "inputs": \[ { "resourceId": "0Hnxx000000DAxx0AG", "resourceType": "Provider", "serviceTerritoryId": "0Hhxx000000Efxx0AK", "serviceResourceId": "0Hnxx000000DAxx0AG", "assetCategory": "", "startDate": "2026-07-15T00:00:00Z", "endDate": "2026-07-16T00:00:00Z", "workTypeId": "08qxx0000009cxxYAA", "channelId": "0eFxx000000Mexx2AK", "sourceSystem": "Salesforce", "serviceCategories": \[\], "serviceTypes": \[\], "appointmentTypes": \[\] } \] } **Sample Response** \[ { "availableSlots": \[ { "slotId": "slot-xyz-1", "slotStartDate": "2026-07-15T11:00:00.000Z", "slotEndDate": "2026-07-15T11:30:00.000Z", "sourceSystem": "Salesforce" }, { "slotId": "slot-xyz-2", "slotStartDate": "2026-07-15T14:30:00.000Z", "slotEndDate": "2026-07-15T15:00:00.000Z", "sourceSystem": "Salesforce" } \] } \] # Get Data Using Context Definition Action Get data from a context service using a context definition and the associated context mapping. This action is available in API version 64.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/custom/contextDataProvider/DefaultContextDataProvider 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
contextDefinitionName String Required

The API name of the context definition to get the data.
contextMappingName String The name of the context mapping that’s used to hydrate the data in the context definition. In the absence of a name, the default mapping name is used.
contextNodeApiName String The API name of the root context node if it isn't the same as the context object API name.
contextNodesDataLimit Integer The maximum number of records to retrieve.
contextNodesSortFieldName String The field name that’s used to sort the data.
contextNodesSortIsAscending Boolean The checkbox to sort the context nodes in ‌ascending order.
contextRecordId String Required

The ID of the context record associated with the context object name that’s used to hydrate the data.
contextObjectName String Required

The API name of the standard object or a Data Cloud object that’s associated with the root context node in the context mapping.
timePeriodInWeeks Integer The lookback period in weeks from the current date for fetching the data.
## Outputs | Output | Type | Description | | --- | --- | --- | | contextData | String | The data retrieved from a context service. | ## Example **GET** This sample request is for the Get Data using Context Definition action. { "inputs": \[ { "contextDefinitionName": "AccountOpportunity\_\_stdctx", "contextMappingName": "AccountOpportunityMappings", "contextId": "02ixx0000005yLxxAI", "contextObjectName": "Account" } \] } This sample response is for the Get Data using Context Definition action. { "Account": \[ { "AccountName": "Acme", "Opportunity": \[ { "CreatedDate": "2025-01-20T00:00:00.000+0000", "ParentReference": "001xx00000pfHIsxxM", "OpportunityName": "Acme - 600 Widgets", "OpportunityStage": "Needs Analysis", "OpportunityCloseDate": "2023-01-03T00:00:00.000+0000" }, { "CreatedDate": "2025-01-20T00:00:00.000+0000", "ParentReference": "001xx00000pfHIsxxM", "OpportunityName": "Acme - 1,200 Widgets", "OpportunityStage": "Value Proposition", "OpportunityCloseDate": "2022-11-07T00:00:00.000+0000" }, { "CreatedDate": "2025-01-20T00:00:00.000+0000", "ParentReference": "001xx00000pfHIsxxM", "OpportunityName": "Acme - 200 Widgets", "OpportunityStage": "Prospecting", "OpportunityCloseDate": "2023-03-08T00:00:00.000+0000" } \] } \] } # Get Resources (POST) Search for healthcare care providers or assets using the backend search engine and data. ## Resource /connect/health/appointment-management/resources ## Available Version 65.0 ## HTTP Methods POST ## Request Body for POST { "resourceType": "Provider", "providerSearchCriteria": { "providerName": "John Dae", "specialties": \[ “Cardiology”\], “planType”:\[“HMO”\] }, "commonSearchCriteria": { "facilityName": "Any Clinic", "radius": 5, "distanceUnit": "miles" }, "offset": 0, "searchLimit": 10 } **Properties**
Property Name Type Description Required
resourceType String Type of resource to search for. Possible values are:
  • Provider
  • Asset.
Required
providerSearchCriteria Provider Search Criteria Input Criteria used specifically for searching for healthcare providers. Optional
assetSearchCriteria Asset Search Criteria Input Criteria used specifically for searching for assets. Optional
commonSearchCriteria Common Search Criteria Input Search filters that apply to both provider and asset searches. Optional
orderBy String Field by which the search results should be sorted. Possible values are:
  • name
  • distanceor a valid CPSF field.
Optional
ascending Boolean Indicates if the sort order is ascending (true) or descending (false). Optional
offset Integer Starting point for retrieving a subset of search results. Minimum value is 0. Optional
searchLimit Integer Maximum number of search results to return. Minimum value is 1, maximum is 1000. Optional
## Response Body for POST [Get Resources Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_get_resources_output_representation.htm "The response body containing the results of the resource search.") # Get Resources Action Search for available resources, such as healthcare providers or medical assets, based on specified search criteria. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/connect/health/appointment-management/resources Where XX.X is the latest API version. **Formats**: JSON **HTTP Methods**: POST **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
resourceType String The type of resource to search for.
Valid values are:
  • Asset
  • Provider
providerSearchCriteria Object Search criteria specific to healthcare providers, such as specialties and languages spoken.

Use this parameter when resourceType is set to Provider.

assetSearchCriteria Object Search criteria specific to medical assets, such as asset type IDs and categories.

Use this parameter when resourceType is set to Asset.

commonSearchCriteria Object Search criteria that apply to both providers and assets, such as facility location and search radius.
orderBy String The field used to sort the search results.
ascending Boolean The sort order. Set to true for ascending or false for descending.
offset Integer The starting point for retrieving a subset of results, used for pagination.
searchLimit Integer The maximum number of search results to return.
## Outputs | Output | Type | Description | | --- | --- | --- | | assetSearchResults | List | A list of medical assets that match the search criteria. This is populated when resourceType is set to Asset. | | providerSearchResults | List | A list of healthcare providers who match the search criteria. This is populated when resourceType is set to Provider. | | error | List | A list of errors that occurred during the search, including error codes and messages. | ## Example Sample Request { "resourceType": "Asset", "assetSearchCriteria": { "assetName": "machine", "assetTypeIds": \[ "1Fwxx0000004C9bCAE", "1Fwxx0000004C96CAE" \], "assetCategories": \[ "Device", "HealthcareService", "Location" \], "status": "Active", "productCode": "PC-45678" }, "commonSearchCriteria": { "radius": 5, "distanceUnit": "miles" }, "orderBy": "distance", "ascending": true, "offset": 0, "searchLimit": 10 } Sample Response { "providerSearchResults": \[\], "assetSearchResults": \[ { "assetId": "02iSG000000DA4p0AG", "assetName": "MRI Machine Room 3", "facilityId": "001SG000000EfT80AK", "facilityName": "Downtown Imaging Center", "assetCategories": \["Device", "Imaging"\], "status": "Active", "productCode": "PC-45678" } \], "error": \[\] } # Get Resources for Manual Scheduling Action Recommend resources to use when you manually schedule a start of care visit or recurring visits. This action is available in API version 61.0 and later. ## Special Access Rules The Get Resources for Manual Scheduling action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getResourcesForMnlScheduling 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
operatingHoursId String ID of the operating hours record that specifies the time slots to schedule a home visit.
recurringDaysList List <String> Comma-delimited list of days to schedule recurring home visits. For example, Monday, Thursday, and Saturday. If recurrenceFrequencyType parameter is set to Weekly, the recurringDaysList parameter is required.
recurrenceFrequencyCount Integer

Number of recurring home visits to be scheduled Weekly or Daily, based on the value specified in the recurrenceFrequencyType parameter.

When recurrenceFrequencyType parameter value is Weekly, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per week. When recurrenceFrequencyType parameter value is Daily, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per day.

recurrenceFrequencyType String Required

Type of recurring home visits. Valid values are:

  • Daily
  • Weekly

If the value is set to Weekly, the recurringDaysList parameter is required.

resourceRecommendationCount Integer Required

Maximum number of resource recommendations to be shown to the scheduler.
schedulingPolicyId String Required

ID of the home health scheduling policy to be used to identify care resources available for the home visits.
serviceAppointmentId String Required

ID of a service appointment record that’s used to get the eligible resources for the home visits.
visitsRequired Integer Required

Number of recurring home visits to schedule.
visitType String Required

Type of home visit to fetch the resources for. Valid values are:

  • Start of Care
  • Recurring
workTypeId String ID of the work type record used to get the resources for the home visit.
## Outputs
Output Type Description
endDateTime Datetime Scheduled end for the returned slot.
grade Integer Grade for the resource recommendation.
manualSchedulingRecommendations JSON JSON collection of the resourceRecommendations parameter that contains resource details such as resource name, resource ID, and their available time intervals.
recommendationGrade Integer Grade for the resource and slot combination.
resourceId String ID of the selected service resource.
resourceName String Name of the selected service resource.
resourceRecommendations JSON JSON collection for each resource that contains resource details such as resource name, resource ID, their available time slots, and the grade for the resource recommendation.
sequence Integer Sequence of this interval in the returned list of resources.
startDateTime Datetime Scheduled start for the returned slot.
scheduleIntervalRecommendations JSON JSON that contains time interval details for the recommended resource. The details include start date, end date, grade for the time slot, and the sequence number in which the service appointment gets scheduled.
visitType String

Type of home visit to fetch the resources for. Valid values are:

  • Start of Care
  • Recurring
## Example **GET** This sample request is for the Get Resources for Manual Scheduling action. { "inputs": \[ { "visitType": "Recurring", "schedulingPolicyId": "a0cSGxx0000CD37YAG", "workTypeId": "08qSG0000004zBNYxx", "recurrenceFrequencyType": "WEEKLY", "recurrenceFrequencyCount": 2, "visitsRequired": 2, "recurringDaysList": "Monday,Tuesday", "resourceRecommendationCount": 3, "operatingHoursId": "0OHSG00000xxSUH4A4", "serviceAppointmentId": "08pSG00000xxUrdYAG" } \] } This sample response is for the Get Resources for Manual Scheduling action. { { "visitType": "Recurring", "manualSchedulingRecommendations": \[ { "resourceRecommendations": \[ { "scheduleIntervalRecommendations": \[ { "startDateTime": "2024-08-05T12:59:59.000Z", "sequence": 1, "grade": "100", "endDateTime": "2024-08-05T01:00:00.000Z" }, { "startDateTime": "2024-08-06T05:15:00.000Z", "sequence": 2, "grade": "0", "endDateTime": "2024-08-06T02:00:00.000Z" } \], "resourceName": "Allen Smith", "resourceId": "0HnSG00000085yb0xx" } \], "recommendationGrade": "85" } \] } } # Get Resources Output The response body containing the results of the resource search. ## JSON Example { "matchingProviders": \[ { "acceptedInsurancePlans": \[ "Any Plan" \], "acceptingNewPatients": true, "additionalDetails": {}, "certifications": \[\], "educationLevel": "high", "facilityAddress": { "addressText": "address", "city": "", "state": "", "postalCode": "123456", "country": "", "latitude": 22.2222, "longitude": -33.3333 }, "facilityName": "Any Hospital", "facilityPhone": "111-111-1111", "gender": "male", "languagesSpoken": \[\], "licenseCountries": \[\], "licenseRegions": \[\], "licenseStates": \[\], "licenseStatuses": \[\], "licenses": \[\], "nationalProviderIdentifier": "0123456789", "photoUrl": "/services/images/photo/001SB00000sb6aid", "providerId": "", "providerName": "Dr. John Dae", "providerType": "Medical Doctor", "sourceSystem": "cerner", "specialties": \[\], "subSpecialties": \[\] } \] } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | providerSearchResults | [Provider Search Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_provider_search_result_representation.htm "Detailed information about a single healthcare provider matching the search criteria.") | A list of healthcare providers or practitioners who match the search criteria. | Required | | assetSearchResults | [Asset Search Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_asset_search_result_representation.htm "Detailed information about a single asset or resource matching the search criteria.") | A list of available assets or resources (e.g., medical equipment, examination rooms) that match the search criteria. | Required | | errors | Array of Objects | An array of errors that were found, if any. | Optional | # Get Slot Status - **Type**: Resource - **Verb**: GET - **Default URL Path** for Single-Source System: /Slot/{sourceSlotId} - **Default URL Path** for Multi-Source System: /Slot/{sourceSystem}/{sourceSlotId} Where: - sourceSystem identifies the source system. - sourceSlotId is the ID of a time slot in the SourceSystem returned from the Find Available Slots operation. Your Base URL is configured in Setup > Appointment Scheduling. All communications with the external system use the FHIR R4 standard. ## Response Codes - 200: Success - 401: Unauthorized - 404: Slot not found - 5xx: Server error ## Response Body To map slots, resourceType, id, status, start, and end are required in the FHIR response. { "resourceType" : "Slot", "id" : "" "identifier" : \[{ Identifier }\], "serviceCategory" : \[{ CodeableConcept }\], "serviceType" : \[{ CodeableConcept }\], "specialty" : \[{ CodeableConcept }\], "appointmentType" : { CodeableConcept }, "schedule" : { Reference(Schedule) },//As we are passing \_include=Slot:schedule in query, it should include the "Schedule" resource as one of the item in "entry" field. "status" : "", "start" : "", "end" : "", "overbooked" : , "comment" : "" } The valid values for slotStatus are: - busy - free - busy-unavailable - busy-tentative - entered-in-error #### See Also - [FHIR Resource: Slot](https://www.hl7.org/fhir/slot.html) # Get Slots (POST) Get slots associated with the provider or asset. ## Resource /connect/health/appointment-management/slots ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/slots ## HTTP Methods POST ## Request Body for POST { "resources": \[ { "resourceId": "c51xx000000B1xxBCI", "serviceTerritoryId": "08pxx000000G6xxGHG", "serviceResourceId": "08pxx000000I8xxIKM", "resourceType": "Provider" } \], "channelId": "a02xx000000A8xxAGH", "workTypeId": "1Fwxx0000004C9bCAE", "startDate": "2013-12-10T09:00:00Z", "endDate": "2013-12-10T11:00:00Z", "sourceSystem": "", "appointmentTypes": \[ "FOLLOW-UP" \], "serviceCategories": \[ "serviceCategoryCode1", "serviceCategoryCode2" \], "serviceTypes": \[ "serviceTypeCode1", "serviceTypeCode2" \] } ## Request Parameters for POST
Parameter Name Type Description Required or Optional Available version
appointment​Types Array Type of the appointment. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • serviceCategories
 Required 65.0
channel​Id String Engagement channel associated with the work type. Required 65.0
endDate String End date and time for the slots range. Required 65.0
resources Resources Input Array of resources, like provider or device. Required 65.0
service​Categories Array List of broad categorizations of the service. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • appointmentType
 Required 65.0
service​Types Array List of specific services to be performed. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • appointmentType
  • serviceCategories
 Required 65.0
source​System String Source system associated with the appointment type, service type or service category. Required, if workTypeId is not provided but either appointmentType, serviceTypes, or serviceCategories is. Required 65.0
start​Date String Start date and time for the slots range. Required 65.0
workType​Id String Work type associated with the resource. Required 65.0
## Response Body for POST [Get Slots Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_get_slots.htm "Output representation for getting appointment slots.") # Get Slots Action Retrieve available appointment slots for one or more resources. This action is available in API version 65.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/connect/health/appointment-management/slots 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
appointmentTypes Array Types of appointments to search such as Follow-up. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • serviceCategories.
channelId String ID of the engagement channel associated with the appointment. Required, if an engagement channel is configured for a Work Type.
endDate String End date and time for the slot search range.
resources Array Array of resource objects to find slots for.
serviceCategories Array Category of service to find slots for. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • appointmentTypes.
serviceTypes Array Services types to find slots for. Required, if none of the following:
  • workTypeId
  • serviceCategories
  • appointmentTypes.
sourceSystem String Description of the external system defined in Salesforce, such as cerner. Required, if workTypeId is not provided.
startDate String Required.

Start date and time for the slot search range.
workTypeId String ID of the Work Type associated with the desired appointment. Required, if none of the following are provided:
  • serviceTypes
  • serviceCategories
  • appointmentTypes.
## Outputs | Output | Type | Description | | --- | --- | --- | | resourceSlotDetails | Array | List of resources and their corresponding available slots. | ## Example **POST** This sample request is for the Get Slots action. { "inputs": \[ { "startDate": "2025-07-14T00:12:00.7912", "endDate": "2025-07-15T06:59:59.000Z", "channelId": "0eFxx000000Mexx2AK", "workTypeId": "08qxx0000009cxxYAA", "sourceSystem": "Salesforce", "resources": \[ { "resourceId": "0bSxx0000004pxx2AA", "serviceTerritoryId": "0Hhxx000000Efxx0AK", "serviceResourceId": "0Hnxx000000DAxx0AG", "resourceType": "Provider", "assetCategory": "" } \], "appointmentTypes": \[\], "serviceCategories": \[\], "serviceTypes": \[\] } \] } This sample response is for the Get Slots action. \[ { "resourceSlotDetails": \[ { "resourceId": "0bSxx0000004pxx2AA", "availableSlots": \[ { "slotId": "slot-xyz-1", "slotStartDate": "2025-07-14T11:00:00.000Z", "slotEndDate": "2025-07-14T11:30:00.000Z", "sourceSystem": "Salesforce" }, { "slotId": "slot-xyz-2", "slotStartDate": "2025-07-14T14:30:00.000Z", "slotEndDate": "2025-07-14T15:00:00.000Z", "sourceSystem": "Salesforce" } \] } \] } \] # Get Slots Output Output representation for getting appointment slots. ## JSON Example { "resourceSlotDetails": \[ { "availableSlots": \[ { "slotEndDate": "2025-09-20T00:45:00Z", "slotId": "ce5b28b6-5b84-4aa8-bd29-2b25ed2dc85a", "slotStartDate": "2025-09-20T00:15:00Z", "sourceSystem": null }, { "slotEndDate": "2025-09-20T01:00:00Z", "slotId": "bebb47c9-217d-4d6d-a4f4-2788cd711242", "slotStartDate": "2025-09-20T00:30:00Z", "sourceSystem": null } \], "resourceId": "0bSxx000000000xxAQ" } \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available version | | --- | --- | --- | --- | --- | | availableSlots | Array | Array of available slots for the resource. | Small, 65.0 | 65.0 | | resourceId | String | ID of the resource. | Small, 65.0 | 65.0 | | resourceSlots | Array | Array of resources and their associated available slots. | Small, 65.0 | 65.0 | | slotEndDate | String | End date and time of the slot. | Small, 65.0 | 65.0 | | slotId | String | ID of the slot. | Small, 65.0 | 65.0 | | slotStartDate | String | Start date and time of the slot. | Small, 65.0 | 65.0 | | sourceSystem | String | Source system of the slot. | Small, 65.0 | 65.0 | # Get Transcript from Conversation Action Gets the transcript for a specified conversation record such as voice call, messaging session, or chat transcript. This action is available in API version 64.0 and later. ## Special Access Rules The Get Transcript from Conversation action is available in Home Health and Service Voice. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/custom/getTranscriptForConversation 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
conversationRecordId String Required

The ID of the voice call, messaging session, or chat transcript to get the conversation transcript for.
## Outputs | Output | Type | Description | | --- | --- | --- | | conversationTranscript | String | The conversation transcript that’s associated with the specified voice call, messaging session, or chat transcript record. | ## Example **GET** This sample request is for the Get Transcript from Conversation action. \[ { "inputParameters": { "conversationRecordId": "003XXXXXXXXXXXXXXX" } } \] This sample response is for the Get Transcript from Conversation action. { "isSuccess": true, "outputValues": { "conversationTranscript": "Agent: Hello, how can I help you?
Customer: I need help with my quotes.
" }, "errors": \[\] } # GetSlotStatusRequest Class Contains set of options to retrieve the slot status. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[GetSlotStatusRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_healthcloudext_GetSlotStatusRequest_properties)** ## GetSlotStatusRequest Properties The following are properties for GetSlotStatusRequest. - **[slotId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_healthcloudext_GetSlotStatusRequest_slotId)** Unique identifier for the time period slot in the external scheduling system that’s assigned to the appointment. - **[slotSourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_healthcloudext_GetSlotStatusRequest_slotSourceSystem)** Name of the external scheduling system from which the time period slot record came from. This information comes from Healthcare Practitioner Facility. - **[slotSourceSystemId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_healthcloudext_GetSlotStatusRequest_slotSourceSystemId)** Represents the ID of the source system from which the request was sourced. ### slotId Unique identifier for the time period slot in the external scheduling system that’s assigned to the appointment. #### Signature public String slotId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotSourceSystem Name of the external scheduling system from which the time period slot record came from. This information comes from Healthcare Practitioner Facility. #### Signature public String slotSourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotSourceSystemId Represents the ID of the source system from which the request was sourced. #### Signature public String slotSourceSystemId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # 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. ## Special Access Rules In Health Cloud, this object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssignedById - **Type**: Polymorphic lookup - **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. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the goal. ### DescriptionCodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the description of a standardized goal. This field is available only in Health Cloud with the Customer Engagement feature. - **Relationship Name**: DescriptionCode - **Relationship Type**: Lookup - **Refers To**: - CodeSet - CodeSetBundle ### ExtlGoalDefIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the goal in an external source system. ### GoalAssigneeId - **Type**: Polymorphic lookup - **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 - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the owner of this goal assignment record. - **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 - CarePlan - CarePlanActivity - GoalAssignment ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the priority of the goal. - **Possible values**: - High - Low - Medium ### ProgressionStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the progression status of the goal. - **Possible values**: - Achieved - Improved - In Progress - No Change - Sustained - Unachieved - Unattainable - Worsened ### 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. ### SourceSystemModifiedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which this item was last changed on the 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. ### StartEventCodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the event that initiates progression towards the goal. This field is a polymorphic relationship field. - **Relationship Name**: StartEventCode - **Refers To**: - CodeSet - CodeSetBundle ### 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. ### TargetCompletionDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date when the goal is targeted to be completed. ### TaskJobStatus - **Type**: picklist - **Properties**: Filter, Group, Nillable, Restricted picklist, Sort - **Description**: This field is not used in Integrated Care Management. ### TaskJobStatusMessage - **Type**: textarea - **Properties**: Nillable - **Description**: This field is not used in Integrated Care Management. ## 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. # GoalAssignmentDetail Represents additional information associated with a GoalAssignment record. This information may be the outcome of a goal or something addressed by it. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailCodeId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that represents the addition information associated to a goal. This field is used to specify standardized goal outcomes as codes. This field is a polymorphic relationship field. - **Relationship Name**: DetailCode - **Refers To**: - CodeSet - CodeSetBundle ### DetailRecordId - **Type**: Polymorphic Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References clinical records that associate additional information to a goal. This information can be an outcome or an item addressed by the goal. - **Relationship Name**: DetailRecord - **Refers To**: - CareObservation (Outcome Reference, Addressed Item) - ClinicalServiceRequest (Addressed Item) - HealthCondition (Addressed Item) - MedicationRequest (Addressed Item) - MedicationStatement (Addressed Item) ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of additional information associated to the goal. - **Possible values**: - AddressedItem—Addressed Item - OutcomeCode—Outcome Code - OutcomeReference—Outcome Reference ### GoalAssignmentId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort - **Description**: References the parent goal that is associated with the additional information, - **Relationship Name**: GoalAssignment - **Refers To**: GoalAssignment ### 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 name of the 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 ## 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. [GoalAssignmentDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [GoalAssignmentDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [GoalAssignmentDetailShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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. ## Special Access Rules In Integrated Care Management, this object represents the definition of a care plan goal in the reusable PGI library. In Health Cloud, this object is available in API version 57.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, Restricted picklist, 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. ### 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. In Health Cloud, this field is not used in Integrated Care Management. - **Relationship Name**: ParentGoal - **Relationship Type**: Lookup - **Refers To**: GoalDefinition ### 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, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the defined goal. In Health Cloud, this field is not used in Integrated Care Management. ## 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. # GroupVisitAddress Class Represents the details of the group visit address. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[addressType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_addressType)** The type of address used for the group visit. - **[city](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_city)** The city of the address where the group visit is scheduled. - **[completeAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_completeAddress)** The full, formatted address where the group visit is scheduled. - **[country](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_country)** The country of the address where the group visit is scheduled. - **[id](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_id)** The unique identifier for the group visit address. - **[postalCode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_postalCode)** The postal code of the address where the group visit is scheduled. - **[state](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_state)** The state of the address where the group visit is scheduled. - **[street](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_HomeHealth_groupVisitAddress_street)** The street address where the group visit is scheduled. ## addressType The type of address used for the group visit. ### Signature public String addressType {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## city The city of the address where the group visit is scheduled. ### Signature public String city {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## completeAddress The full, formatted address where the group visit is scheduled. ### Signature public String completeAddress {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## country The country of the address where the group visit is scheduled. ### Signature public String country {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## id The unique identifier for the group visit address. ### Signature public String id {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## postalCode The postal code of the address where the group visit is scheduled. ### Signature public String postalCode {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## state The state of the address where the group visit is scheduled. ### Signature public String state {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## street The street address where the group visit is scheduled. ### Signature public String street {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # Guest Referral Create a patient referral in a Salesforce org from an OOTB guest web form. When you send a request to create a patient referral, the API creates records in multiple objects, such as PersonAccount, ClinicalServiceRequest, and ClinicalServiceRequestDetail to store the patient referral information. ## Resource /connect/health/referral-management/guest-referrals ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/referral-management/guest-referrals ## Available Version 60.0 ## HTTP Methods POST ## JSON example Here’s an example request to create a patient referral from the OOTB web form filled by a guest user. { "captchaToken":{ "type":"ReCaptcha", "token":"09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl\_7H1ZqavwGwecshDuL0K1K9rfv0eI\_dn7pqyGA", "siteKeyDeveloperName":"GoogleSiteKey" }, "patient":{ "fields":{ "FirstName":"Charles", "LastName":"Green", "Phone":"8012345678" } }, "referralDetails":\[ { "detailType":"Insurance", "detailRecordType":"Member Plan", "fields":{ "Name":"Aetna PPO", "MemberNumber":"2345678" } }, { "detailType":"Based On", "detailRecordType":"Health Condition", "fields":{ "Condition Status":"Condition", "Diagnostic Status":"Status" } } \], "referralNotes":"This is an urgent request", "referral":{ "fields":{ "PatientInstruction":"Need Appointment ASAP.", "Priority":"Urgent" } } } Here’s an example request to create a patient referral with the provided performers and requesters in the OOTB guest web form. { "captchaToken": { "type": "ReCaptcha", "token": "09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl\_7H1ZqavwGwecshDuL0K1K9rfv0eI\_dn7pqyGA", "siteKeyDeveloperName": "GoogleSiteKey" }, "patient": { "fields": { "FirstName": "Joe", "LastName": "Clark", "Phone": "801XXXXX89" } }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" }, { "detailType": "Body Site", "detailRecordType": "Health Condition", "detailCodeId": "0hsRM000000043aYAA" }, { "detailType": "Reason Reference", "detailRecordId": "0j4RM0000004MunYAE" } \], "requester": { "id": "0cmRM0000004nAgYAI" }, "performers": \[ { "id": "0cmRM0000000l2JYAQ" }, { "id": "0cmRM0000000tnoYAA" } \], "referralNotes": "This is an urgent request", "referral": { "fields": { "Priority": "Routine", "Status": "Draft", "Type": "Plan" } } } ## Properties
Name Type Description Required or Optional Available Version
captchaToken Captcha Token Input Google captcha verification token.

Because the referral information comes from a web form, this API expects a captcha token for security reasons. The guest referral API calls the Google API to verify the provided captcha.

A Google captcha token is valid only for 2 minutes.

 Required 60.0
patient Record Fields Input[] Account details of the patient being referred. Required 60.0
performer Record Fields Input[] List of healthcare providers who perform the service.

You can provide a maximum of 5 provider IDs in a request.

 Optional 60.0
referral Record Fields Input[] Referral information. Required 60.0
referralDetails Referral Detail Input[] Patient details, such as, insurance, and health condition. Optional 60.0
referralNotes String Referral notes. Optional 60.0
requester Record Fields Input[] Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.

If the requester is new, provide information to create an account.

 Optional 60.0
## Response Body for POST [Guest Referral Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_guest_referral_output.htm "Output representation of the request to create a guest referral.") # Guest Referral Input Input representation of the request to create a patient referral record based on a guest user’s input. ## JSON example Here’s an example request to create a patient referral from the OOTB web form filled by a guest user. { "captchaToken":{ "type":"ReCaptcha", "token":"09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl\_7H1ZqavwGwecshDuL0K1K9rfv0eI\_dn7pqyGA", "siteKeyDeveloperName":"GoogleSiteKey" }, "patient":{ "fields":{ "FirstName":"Charles", "LastName":"Green", "Phone":"8012345678" } }, "referralDetails":\[ { "detailType":"Insurance", "detailRecordType":"Member Plan", "fields":{ "Name":"Aetna PPO", "MemberNumber":"2345678" } }, { "detailType":"Based On", "detailRecordType":"Health Condition", "fields":{ "Condition Status":"Condition", "Diagnostic Status":"Status" } } \], "referralNotes":"This is an urgent request", "referral":{ "fields":{ "PatientInstruction":"Need Appointment ASAP.", "Priority":"Urgent" } } } Here’s an example request to create a patient referral with the provided performers and requesters in the OOTB guest web form. { "captchaToken": { "type": "ReCaptcha", "token": "09APYnBZUChiG3s985dvsz9eHvoAMIoa6lB0qeDvL-pZjNvZ3Qg9HgZVRo4rAxebgl\_7H1ZqavwGwecshDuL0K1K9rfv0eI\_dn7pqyGA", "siteKeyDeveloperName": "GoogleSiteKey" }, "patient": { "fields": { "FirstName": "Joe", "LastName": "Clark", "Phone": "801XXXXX89" } }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" }, { "detailType": "Body Site", "detailRecordType": "Health Condition", "detailCodeId": "0hsRM000000043aYAA" }, { "detailType": "Reason Reference", "detailRecordId": "0j4RM0000004MunYAE" } \], "requester": { "id": "0cmRM0000004nAgYAI" }, "performers": \[ { "id": "0cmRM0000000l2JYAQ" }, { "id": "0cmRM0000000tnoYAA" } \], "referralNotes": "This is an urgent request", "referral": { "fields": { "Priority": "Routine", "Status": "Draft", "Type": "Plan" } } } ## Properties
Name Type Description Required or Optional Available Version
captchaToken Captcha Token Input Google captcha verification token.

Because the referral information comes from a web form, this API expects a captcha token for security reasons. The guest referral API calls the Google API to verify the provided captcha.

A Google captcha token is valid only for 2 minutes.

 Required 60.0
patient Record Fields Input[] Account details of the patient being referred. Required 60.0
performer Record Fields Input[] List of healthcare providers who perform the service.

You can provide a maximum of 5 provider IDs in a request.

 Optional 60.0
referral Record Fields Input[] Referral information. Required 60.0
referralDetails Referral Detail Input[] Patient details, such as, insurance, and health condition. Optional 60.0
referralNotes String Referral notes. Optional 60.0
requester Record Fields Input[] Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.

If the requester is new, provide information to create an account.

 Optional 60.0
# Guest Referral Output Output representation of the request to create a guest referral. ## JSON example { "error":null, "token":"0lvxx00004000001AAB" } ## Properties
Property Name Type Description Filter Group and Version Available Version
error Error Response Error details when the request fails. Small, 60.0 60.0
token String Encrypted value of the Clinical Service Request ID, Organization ID, and User ID in this format: ReferralId:OrgId:UserId.

The encrypted ID is required to link files to the created Clinical Service Request record.

 Small, 60.0 60.0
# Handle Resource Absence Action Remove a service resource’s visit assignments for a specified period and optionally update the status of the affected visits to a specified value. This action is available in API version 58.0 and later. ## Special Access Rules The Remove Visit Assignments action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/handleResourceAbsence 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
endDateTime datetime Required.

End date and time of the period to remove service resource assignments from home visits.
newServiceAppointmentStatus string Status of affected service appointments after the service resource has been removed.
serviceResourceId string Required.

ID of the service resource record to remove from home visits.
startDateTime datetime Required.

Start date and time of the period to remove service resource assignments from home visits.
## Outputs None. ## Example **POST** This sample request is for the Handle Resource Absence action. { "inputs" : \[ { "endDateTime" : "2023-07-04T12:15:45.200-700", "newServiceAppointmentStatus" : "Resolved", "serviceResourceId" : "0Hnxx0000004C92CAE", "startDateTime" : "2023-07-04T11:00:56.235-700" } \] } This sample response is for the Handle Resource Absence action. \[ { "actionName" : "handleResourceAbsence", "errors" : null, "isSuccess" : true, "outputValues" : null, "version" : 1 } \] # Health Assessments Health Cloud Assessments use the power of Discovery Framework and OmniStudio to build more complex questionnaire paths.
Available in: Enterprise and Unlimited editions with Health Cloud
The health assessments data model represents the system to create an assessment envelope and assessment envelope item to provide patients access to the assigned assessments. The Assessment standard objects are visible to users with the Health Cloud and the Health Cloud Platform permission set licenses and the Health Cloud Permission Set License permission set. Available in API version 57.0 and later. - **[AssessmentEnvelope](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_assessmentenvelope.htm)** 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. - **[AssessmentEnvelopeItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_assessmentenvelopeitem.htm)** 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. # Health Cloud Associated Objects This section provides a list of objects associated to Health Cloud standard objects with their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](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. # Health Cloud Business APIs Use the Health Cloud Business APIs for building integrations with Health Cloud or for creating custom UI components. The APIs wrap complex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as enrolling patients into a care program or creating requests for prior authorizations. To use these APIs, you are not required to understand the underlying healthcare data model. Most of the APIs are RESTful APIs, but a few are also available through Apex classes and methods. - **[REST Reference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_business_apis_rest_reference.htm)** You can access Health Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. # Health Cloud Data Model Salesforce Health Cloud provides a rich set of objects to store and access specialized health information. To verify the complete list of fields for an object, you can use a describe call from the API, or inspect with an appropriate tool, for example, inspecting the WSDL or using a schema viewer. #### See Also - [Salesforce Object Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/) - [Salesforce Developer Limits and Allocations Quick Reference](https://developer.salesforce.com/docs/atlas.en-us.264.0.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) # Health Cloud Developer Guide This guide provides information on the custom objects used by Health Cloud and their fields. Some fields may not be listed for some objects.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud
- **[Health Cloud Data Model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects.htm)** Salesforce Health Cloud provides a rich set of objects to store and access specialized health information. - **[Health Cloud Fields on Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_custom_fields.htm)** Health Cloud adds standard and custom fields to some standard Salesforce objects to represent information about individuals. These fields are available only in orgs where Health Cloud is enabled. - **[Health Cloud Platform Events](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_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.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[Emergency Response Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/erm_hc_dev_guide_overview.htm)** Use the objects, fields, and metadata that extend Salesforce for Emergency Response Management. - **[Apex Reference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_apex_reference.htm)** This Apex reference goes into detail about the built-in Apex classes, interfaces, methods, or enums for Health Cloud. - **[Health Cloud Business APIs](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_business_apis.htm)** Use the Health Cloud Business APIs for building integrations with Health Cloud or for creating custom UI components. The APIs wrap complex business logic by executing multiple tasks within a single API call. They aim to fulfill business use cases specific to the healthcare industry, such as enrolling patients into a care program or creating requests for prior authorizations. To use these APIs, you are not required to understand the underlying healthcare data model. Most of the APIs are RESTful APIs, but a few are also available through Apex classes and methods. - **[Health Cloud Tooling API Objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_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. 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)**. - **[Health Cloud Standard Invocable Actions](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_parent.htm)** Manage healthcare facilities using invocable actions. For more information on standard invocable actions, see **[REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_actions_invocable_standard.htm)** and **[Actions Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_action.meta/api_action/actions_intro.htm)**. - **[Metadata Types](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_metadata_types.htm)** - **[Health Cloud FHIR APIs](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_fhir_apis_overview.htm)** Use Salesforce Healthcare API to securely connect and interact with a system that uses Fast Health Interoperability Resources (FHIR) APIs. - **[MuleSoft Direct Integrations](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_mulesoft_direct_integrations.htm)** Use the Salesforce integration apps that are out-of-the-box integration templates with pre-built transformations that can be used to integrate Health Cloud with external systems. These integration apps are available in MuleSoft Exchange. - **[API End-of-Life Policy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_api_rest_eol.htm)** - **[Health Cloud Managed Package](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_dev_managed_package.htm)** Health Cloud originally started out as a managed package that was installed on the core Salesforce platform. Over the years, Health Cloud has gradually moved away from distributing new features through the managed packaged, and instead has built its features directly on the core Salesforce platform. # Health Cloud FHIR APIs Use Salesforce Healthcare API to securely connect and interact with a system that uses Fast Health Interoperability Resources (FHIR) APIs. The FHIR standard defined by Health Level Seven (HL7) enables health care systems to work together seamlessly. Transforming data to FHIR allows you to quickly connect data sources like Electronic Medical Record (EMR) systems and research databases. FHIR also enables rapid data exchange in mobile and web apps. To learn more, see the [Salesforce Health Care API](https://developer.salesforce.com/docs/industries/health/overview "HTML (New Window)") guide. # Health Cloud Fields on Standard Objects Health Cloud adds standard and custom fields to some standard Salesforce objects to represent information about individuals. These fields are available only in orgs where Health Cloud is enabled. - **[Fields on Account](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_account_custom_fields.htm)** Health Cloud fields extend the standard Account object to represent information about patients and providers. - **[Fields on Contact](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_contact_custom_fields.htm)** Health Cloud fields extend the standard Contact object to represent information about an individual. - **[Fields on Event and Task (Activity)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_task_custom_fields.htm)** Custom fields extend the standard Event and Task objects to represent information about an individual’s activities. - **[Fields on Lead](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_lead_custom_fields.htm)** Standard and custom fields extend the Lead object to represent information about an incoming patient. - **[Fields on Opportunity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_opportunity_custom_fields.htm)** Standard and custom fields extend the Opportunity object to represent information about an incoming patient. - **[Fields on ProductRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_productrequest_custom_fields.htm)** Health Cloud fields extend the standard ProductRequest object to associate it with care programs and to track modification history. - **[Health Cloud Referral Management Fields on Contact, Lead, and Opportunity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_referral_management_data_model_custom_fields.htm)** Standard and custom fields extend the Contact, Lead, and Opportunity objects for use in Health Cloud to represent information about referral management. - **[Fields on Service Appointment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_serviceappointment_custom_fields.htm)** Standard and custom fields extend the standard Service Appointment object to represent information about a healthcare appointment. # Health 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 Health Cloud platform. - **[ApplnFormAppealStsChgEvnt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Health Cloud Referral Management Fields on Contact, Lead, and Opportunity Standard and custom fields extend the Contact, Lead, and Opportunity objects for use in Health Cloud to represent information about referral management. ## Contact These custom fields on the Contact standard object support referral management. - ConvertedReferrals\_\_c - ReferrerScore\_\_c - TotalReferrals\_\_c ## Lead These custom fields on the Lead standard object support referral management. - AnticipatedDischargeDate\_\_c - Diagnosis\_\_c - DischargeDate\_\_c - EmergencyContactFirstName\_\_c - EmergencyContactLastName\_\_c - EmergencyContactPhone\_\_c - EmergencyContactRelationship\_\_c - Face-to-FaceEncounterDate\_\_c - Gender\_\_c - Homebound\_\_c - InsuranceGroupId\_\_c - InsuranceMemberId\_\_c - InsuranceType\_\_c - IsOutOfNetwork\_\_c - Language\_\_c - PrimaryCareProvider\_\_c - PrimaryDiagnosisDescription\_\_c - PrimaryInsurance\_\_c - Priority\_\_c - ReasonforDisqualification - ReasonForOutOfNetworkReferral\_\_c - ReasonForReferral\_\_c - ReferralStatus\_\_c - ReferredToOrganization\_\_c - ReferredToPractitioner\_\_c - ReferredToUser\_\_c - ReferrerAdmitDate\_\_c - ReferringContactName\_\_c - ReferringContactPhone\_\_c - ReferringNPI\_\_c - ReferringOrganization\_\_c - ReferringPractitioner\_\_c - ReferringUser\_\_c - RelatedAccount\_\_c - SecondaryDiagnosisDescription\_\_c - SecondaryInsurance\_\_c - SecondaryInsuranceID\_\_c - SigningProvider\_\_c - Specialty\_\_c - SSN\_\_c - Start/ResumptionofCareDate\_\_c - TypeOfService\_\_c ## Opportunity These custom fields on the Opportunity standard object support referral management. - Diagnosis\_\_c - InsuranceGroupId\_\_c - InsuranceMemberId\_\_c - InsuranceType\_\_c - IsOutOfNetwork\_\_c - PrimaryInsurance\_\_c - Priority\_\_c - ReasonForOutOfNetworkReferral\_\_c - ReferralReceivedDate\_\_c - ReferredToOrganization\_\_c - ReferredToPractitioner\_\_c - ReferredToUser\_\_c - ReferringOrganization\_\_c - ReferringPractitioner\_\_c - ReferringUser\_\_c - Specialty\_\_c - TypeOfService\_\_c # Health Cloud Standard Invocable Actions Manage healthcare facilities using invocable actions. For more information on standard invocable actions, see **[REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_rest.meta/api_rest/resources_actions_invocable_standard.htm)** and **[Actions Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_action.meta/api_action/actions_intro.htm)**. - **[Book Appointment Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_book_appointment.htm)** Create or book a new appointment. - **[Cancel Appointment Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_cancel_appointment.htm)** Cancel an existing appointment. - **[Create Referral Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_create_referral.htm)** Create a patient referral record. A patient referral consists of multiple objects, such as an account, clinical service request, and clinical service request detail. - **[Create Quote for Home Visits Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_create_quote_for_home_visits.htm)** Create a quote for patient home visits based on the specified visit details. - **[Create Template of Service Appointment Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_create_template_appointment_service.htm)** Create a service appointment record of Cancelled status that's used as a template for creating the actual service appointment record while scheduling home visits manually. - **[Get Data Using Context Definition Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_data_using_context_definition.htm)** Get data from a context service using a context definition and the associated context mapping. - **[Get Resources Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_resources.htm)** Search for available resources, such as healthcare providers or medical assets, based on specified search criteria. - **[Get Resources for Manual Scheduling Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_resources_manual_scheduling.htm)** Recommend resources to use when you manually schedule a start of care visit or recurring visits. - **[Get Slots Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_slots.htm)** Retrieve available appointment slots for one or more resources. - **[Get Appointment Slots Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_get_appointment_slots.htm)** Get available appointment slots for healthcare providers or assets based on specified criteria. Calls the Get Appointment Slots Connect API. - **[Get Transcript from Conversation Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_transcript_for_conversation.htm)** Gets the transcript for a specified conversation record such as voice call, messaging session, or chat transcript. - **[Handle Resource Absence Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_handle_resource_absence.htm)** Remove a service resource’s visit assignments for a specified period and optionally update the status of the affected visits to a specified value. - **[Process Received Document Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_process_received_document.htm)** Create a record with the processed results of the specified received document. - **[Parse Eligibility and Benefit Verification (EBV) FHIR Response Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_parse_ebv_fhir_response.htm)** Parses the first FHIR coverage eligibility response call and creates coverage benefit records. - **[Build Eligibility and Benefit Verification (EBV) Request Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_build_ebv_request.htm)** Builds the request payload to initiate the eligibility and benefits verification process. - **[Parse Eligibility and Benefit Verification (EBV) Response Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_parse_ebv_response.htm)** Parses the Call 2 (isPriorAuthRequired) JSON response from the eligibility and benefits clearinghouse and extracts the taskId to use for callback correlation. - **[Parse Conversation Response Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_parse_conversation_response.htm)** Parses the JSON response from the Parse Conversation Inquiries prompt template from a contact center conversation transcript into a conversation summary, a resolution status, extracted inquiries, and an inquiry count. - **[Reschedule Recurring Home Visits Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_reschedule_recurring_home_visits.htm)** Reschedule all the home visits based on the recurrence pattern and scheduling policy provided. - **[Schedule Group Visits Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_group_visits.htm)** Create visiting records for patient home visits by bundling them into a group and scheduling either a single start-of-care visit or a series of recurring visits associated with the bundled records. - **[Schedule Home Visit Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_home_visit.htm)** Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care. - **[Schedule Home Visits Manually Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_home_visits_manually.htm)** Create start of care or recurring home visits and assign care resources that are manually selected by the scheduler to the visits. - **[Schedule Recurring Home Visit Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_recurring_home_visit.htm)** Create a set of recurring home healthcare visits and assign service resources to them based on the specified scheduling policy. - **[Update Appointment Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_update_appointment.htm)** Update an existing appointment. - **[Serialize Identity Verification Context Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_serialize_identity_verification_context.htm)** Returns a JSON array of identity verification field descriptors that an Agentforce agent uses to collect caller answers. - **[Validate Identity Verification Answers Action](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_validate_identity_verification_answers.htm)** Validates caller-provided answers against the active identity verification session and returns whether verification succeeded. # Health 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)**. # 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. Ensure that the Health Cloud managed package is installed in your org as the package contains fields on standard objects used by the health insurance data model. The health insurance data model includes standard objects and record types. You need the Health Cloud Platform permission set license to create, edit, and delete records in the data model. ![Health insurance data model entity-relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/health_insurance_claims_datamodel.png) - **[CarePreauth](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carepreauth.htm)** Represents the details of preauthorizations for care under a member’s plan. - **[CarePreauthItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carepreauthitem.htm)** Represents the details of items included in a preauthorization for care under a member’s plan. - **[CoverageBenefit for Health Insurance](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_hi_objects_coveragebenefit.htm)** Represents the benefits provided to a covered member by a purchaser’s plan. - **[CoverageBenefitItem for Health Insurance](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_hi_objects_coveragebenefititem.htm)** Represents a service covered by the insurance plan. - **[Member](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_member.htm)** A member is a person who is the primary subscriber, a dependent, or anyone else who is covered under the insurance plan. - **[MemberPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_memberplan.htm)** Represents details about the insurance coverage for a member or subscriber. - **[Payer](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_payer.htm)** A payer is a health insurance company that helps cover the cost of member care. payer is represented by records on the Account object. - **[PlanBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_planbenefit.htm)** Represents the standard benefits available under a plan that the purchaser offers to their members. - **[PlanBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_planbenefititem.htm)** Represents the details of a benefit available under a purchaser’s plan that is offered to their members. - **[Purchaser](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_purchaser.htm)** A purchaser is the organization (an employer) that is providing medical insurance plans for their members (employees). - **[Purchaser Group](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[PurchaserPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplan.htm)** Represents the payer plan that a purchaser makes available to its members and members’ dependents. - **[PurchaserPlanAssn](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplanassn.htm)** Represents a junction object that associates the purchaser to the plans they offer to members. - **[Purchaser Payer Association](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_purchaser_payer_association.htm)** An association that records the purchasers who purchase plans from payers. This association is represented by records on the AccountAccountRelation 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. ## 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. This field is a relationship field. - **Relationship Name**: Account - **Refers To**: Account ### Classification - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the classification of the healthcare provider. 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 ### DoesParticipateInRsrchStudy - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare provider participates in research studies (true) or not (false). This field is available in API version 63.0 and later when Site Management is enabled. - **Default value**: false ### DoesUseElecDataCapture - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the healthcare provider uses Electronic Data Capture (EDC) system (true) or not (false). This field is available in API version 62.0 and later when Site Management is enabled. - **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. ### 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. ### 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. ### 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 ### 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 ### 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 ### 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 Director - Medical Doctor - Pharmacist - Pharmacy - Research Study Coordinator - Research Study Director - Research Study Feasibility Manager - Research Study Investigator - Research Study Nurse - Research Study Operations Manager - Research Study Sub-Investigator - Site Management Organization Coordinator ### 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 ### 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 ### 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. ## 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. # HealthcareProvider for Pharmacy Benefits Verification Represents business-level details about the healthcare organization or the practitioner. Multiple features use this object. See [HealthcareProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareprovider.htm "Represents business-level details about the healthcare organization or the practitioner."). # HealthcareProviderNpi Represents identifiers from the National Provider Identifier that are assigned to every facility and licensed practitioner in the 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthCloudExt Namespace The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. The HealthCloudExt namespace includes these classes and interfaces. - **[HealthCloudExt Namespace for Intelligent Appointment Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext_appointment_management.htm)** The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. - **[AppointmentBase Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBase.htm#apex_class_healthcloudext_AppointmentBase)** An abstract base class that represents the care provider or the practitioner information. - **[AppointmentBookingInterop Interface](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_AppointmentBookingInterop.htm#apex_interface_healthcloudext_AppointmentBookingInterop)** Contains default Apex implementation for healthcare appointment availability and booking. - **[AppointmentBookingInteropFhirAdapter Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter.htm#apex_class_healthcloudext_AppointmentBookingInteropFhirAdapter)** Represents the global class that implements the AppointmentBookingInterop interface. - **[AppointmentProvider Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_AppointmentProvider.htm#apex_class_healthcloudext_AppointmentProvider)** Represents additional information about the care provider and an appointment. - **[BookAppointmentRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentRequest.htm#apex_class_healthcloudext_BookAppointmentRequest)** Contains set of options to book a healthcare appointment. - **[BookAppointmentResponse Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BookAppointmentResponse.htm#apex_class_healthcloudext_BookAppointmentResponse)** Represents the appointment booking details from the external scheduling system. - **[CancelAppointmentRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentRequest.htm#apex_class_healthcloudext_CancelAppointmentRequest)** Contains set of options to cancel the booked appointment. - **[CancelAppointmentResponse Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_CancelAppointmentResponse.htm#apex_class_healthcloudext_CancelAppointmentResponse)** Represents the appointment cancellation details from the external scheduling system. - **[FindSlotsRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_FindSlotsRequest.htm#apex_class_healthcloudext_FindSlotsRequest)** Contains set of options to find available time slots for providers who match the patient’s needs. This class extends the AppointmentBase class and inherits its properties. - **[GetSlotStatusRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_GetSlotStatusRequest.htm#apex_class_healthcloudext_GetSlotStatusRequest)** Contains set of options to retrieve the slot status. - **[HomeHealth](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_HomeHealth.htm)** Contains Apex implementation for Manual Scheduling for healthcare appointments. - **[Slot Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_class_healthcloudext_Slot)** Represents the time period slot details for the appointment. - **[BookingStatus Enum](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_enum_healthcloudext_BookingStatus.htm)** Represents a possible status of a healthcare appointment. - **[HealthCloudExt Namespace for Benefit Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext_benefit_verification.htm)** The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. - **[HealthCloudExt Namespace for Unified Health Scoring](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext_unified_healthscore.htm)** The HealthCloudExt namespace provides an interface and methods for Health Cloud to store health score information in the action logs. - **[HealthCloudExt Namespace for Intelligent Content Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_reference_healthcloudext_intelligent_content_management.htm)** The HealthCloudExt namespace provides an interface and classes for Health Cloud to manage Intelligent Content. # HealthCloudExt Namespace for Benefit Verification The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. Integrate benefit verification into the end-to-end patient access workflow to help caregivers and patients reduce the time and effort it takes to find out what coverage is available under each patient's health benefits. The HealthCloudExt namespace includes these classes and interface. - **[BenefitsItem Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItem.htm#apex_class_healthcloudext_BenefitsItem)** Specific service covered by the insurance plan. - **[BenefitsItemLimit Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsItemLimit.htm#apex_class_healthcloudext_BenefitsItemLimit)** Services not covered, or expenditures required for coverage. - **[BenefitsVerificationRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_class_healthcloudext_BenefitsVerificationRequest)** Request for verification of benefits. - **[BenefitsVerificationResponse Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_class_healthcloudext_BenefitsVerificationResponse)** Response for verification of benefits. - **[IBenefitsVerificationInterOp Interface](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IBenefitsVerificationInterOp.htm#apex_interface_healthcloudext_IBenefitsVerificationInterOp)** Contains default Apex implementation for verification of benefits. #### See Also - [Health Cloud Administration Guide: Connect to a Benefit Verification Service](https://help.salesforce.com/articleView?id=ind.admin_benefit_verification_setup.htm&type=5&language=en_US) - [Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_benefits_verification_data_model.htm "The benefits verification data model supports providers, payers, and life sciences organizations in determining benefits coverage for services and products provided.") # HealthCloudExt Namespace for Intelligent Appointment Management The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system. The HealthCloudExt namespace includes these classes and interface. # HealthCloudExt Namespace for Intelligent Content Management The HealthCloudExt namespace provides an interface and classes for Health Cloud to manage Intelligent Content. The HealthCloudExt namespace includes these classes and interface. - **[SuggestedResponseAssessmentService Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_SuggestedResponseAssessmentService.htm)** Represents the suggestion for assessment question from previous responses and Einstein AI. # HealthCloudExt Namespace for Unified Health Scoring The HealthCloudExt namespace provides an interface and methods for Health Cloud to store health score information in the action logs. The HealthCloudExt namespace includes these classes and interface. - **[IUnifiedHealthScore Interface](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IUnifiedHealthScore.htm#apex_interface_healthcloudext_IUnifiedHealthScore)** Stores additional information in the action logs. # 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 | - **[HealthConditionDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_healthconditiondetail.htm)** 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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthPlanFacilityNetwork Represents the association between an insurance product or plan and a designated healthcare facility network. This entity is fundamental in healthcare management, allowing insurers and providers to accurately determine which facilities are in-network for a given patient's plan, facilitating eligibility checks and service coordination. 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 ### EffectiveFromDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the product becomes covered under the Healthcare Facility Network. ### EffectiveToDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the product is no longer covered under the Healthcare Facility Network. ### HealthcareFacilityNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Healthcare Facility Network record associated with this product network coverage. - **Referenced Objects**: - HealthcareFacilityNetwork ### 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 health plan facility network. ### 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 ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Product2 record that defines the insurance plan associated with this product network coverage. - **Referenced Objects**: - 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. [HealthPlanFacilityNetworkChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFacilityNetworkFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFacilityNetworkHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFacilityNetworkOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFacilityNetworkShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthPlanFormularyItem Represents which drugs, medical devices, or services are covered under specific insurance products within defined time periods. Each record establishes a relationship between Product2 insurance plans and FormularyItem records. 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 ### EffectiveFromDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the formulary item becomes covered under the product. ### EffectiveToDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date when the formulary item is no longer covered under the product. ### FormularyItemId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Formulary Item record associated with the Product Formulary Item Coverage. - **Referenced Objects**: - FormularyItem ### 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. ### MedicationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Medication record associated with the Product Formulary Item Coverage. - **Referenced Objects**: - Medication ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the medication or formulary item covered associated with the Product Formulary Item Coverage. ### 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 ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The Product2 record that defines the insurance plan associated with this Product Formulary Item Coverage. - **Referenced Objects**: - 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. [HealthPlanFormularyItemChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFormularyItemFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFormularyItemHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFormularyItemOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthPlanFormularyItemShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthRiskEvalDetail Represents additional details of a health risk evaluation, including the basis and reason for the evaluation. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The reference record related to the health risk evaluation record. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: CareObservation, DiagnosticSummary, HealthCondition ### DetailType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the health risk evaluation detail. - **Default value**: ReasonReference - **Possible values**: - Basis - ReasonReference—Reason ### HealthRiskEvaluationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The health risk evaluation associated with the risk evaluation detail. This field is a relationship field. - **Relationship Name**: HealthRiskEvaluation - **Relationship Type**: Master-detail - **Refers To**: HealthRiskEvaluation (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. ## 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. [HealthRiskEvalDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthRiskEvalDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthRiskEvalOutcome Represents the outcome of a risk evaluation, such as the probability of disease occurrence. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AdditionalInformation - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The additional information that explains the rationale for the risk prediction. ### HealthRiskEvaluationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The health risk evaluation associated with the risk evaluation outcome. This field is a relationship field. - **Relationship Name**: HealthRiskEvaluation - **Relationship Type**: Master-detail - **Refers To**: HealthRiskEvaluation (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. ### MaximumRiskProbabilityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum probability of the evaluation outcome. ### MinimumRiskProbabilityValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum probability of the evaluation outcome. ### RiskCodeSetValueId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set or code set bundle that represents the value that determines the severity of the risk, such as high, medium, or low. This field is a polymorphic relationship field. - **Relationship Name**: RiskCodeSetValue - **Refers To**: CodeSet, CodeSetBundle ### RiskEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time after which the subject is no longer at risk of the outcome. ### RiskNumericValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The value that quantifies the severity of the health risk. ### RiskOutcomeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code set bundle that represents the possible outcome of a risk evaluation. This field is a polymorphic relationship field. - **Relationship Name**: RiskOutcomeCode - **Refers To**: CodeSet, CodeSetBundle ### RiskRangeMaximumValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end of the range until which the subject is at risk of the evaluation outcome. ### RiskRangeMinimumValue - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The starting point of the range at which the subject is at risk of the evaluation outcome. ### RiskRangeUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for the risk range. This field is a relationship field. - **Relationship Name**: RiskRangeUom - **Refers To**: UnitOfMeasure ### RiskStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time from when the subject is at risk of the outcome. ### RiskValueType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of the health risk evaluation outcome value. - **Default value**: Probable - **Possible values**: - Probable - Qualitative - Relative ## 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. [HealthRiskEvalOutcomeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthRiskEvalOutcomeHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthRiskEvaluation Represents the evaluation of health risks. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter associated with the health risk evaluation. This field is a relationship field. - **Relationship Name**: ClinicalEncounter - **Refers To**: ClinicalEncounter ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the evaluation ended. ### EvaluatorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account, healthcare provider, facility, or registered device associated with the health risk evaluation. This field is a polymorphic relationship field. - **Relationship Name**: Evaluator - **Refers To**: Account, CareRegisteredDevice, Contact, HealthcarePractitionerFacility, HealthcareProvider ### 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. ### MethodCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set or code set bundle that represents the method used to evaluate the risk. This field is a polymorphic relationship field. - **Relationship Name**: MethodCode - **Refers To**: CodeSet, CodeSetBundle ### 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 ### PrimaryHealthConditionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition that was assessed during the health risk evaluation. This field is a relationship field. - **Relationship Name**: PrimaryHealthCondition - **Refers To**: HealthCondition ### ReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assessment or the disease investigation associated with the health risk evaluation. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceRecord - **Refers To**: Assessment, DiseaseInvestigation ### RiskMitigationInfo - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The evaluator's advice to reduce or manage the identified risks. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the evaluation started. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the health risk evaluation. - **Default value**: registered - **Possible values**: - amended—Amended - appended - cancelled - cannotBeObtained - corrected - enteredInError - final - preliminary - registered - specimenInProcess - unknown ### SubjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The account associated with the health risk evaluation. This field is a polymorphic relationship field. - **Relationship Name**: Subject - **Refers To**: Account ### TypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code set or code set bundle that represents the type of health risk evaluation. This field is a polymorphic relationship field. - **Relationship Name**: TypeCode - **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. [HealthRiskEvaluationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthRiskEvaluationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthRiskEvaluationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthRiskEvaluationShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthScore Represents a subject’s score for a specific score category. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules ## Fields ### Age - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Age of the patient at the time of computation. ### AgeBand - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Patient’s age calculated into age bands. ### AssessmentYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the year the risk score is applicable to. ### CareProgramEnrolleeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Care Program Enrollee for which this score is computed. This field is a relationship field. - **Relationship Name**: CareProgramEnrollee - **Refers To**: CareProgramEnrollee ### ConditionCategoryCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the number of applicable condition categories. ### ConditionCategoryList - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A comma separated list of condition categories that apply to the specified condition codes. ### CurrentScore - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The patient’s current score for the score category. ### CurrentScoreDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date when the current score was derived. ### Gender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Gender of the patient at the time of computation. ### HierCondCategoryCodeList - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The final HCC Codes that are applicable to the patient after applying the overriding logic. ### IsSubjectDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: CMS disability status of the patient at the time of computation. - **Default value**: false ### IsSubjectInstitutionalized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the patient is in an institution. - **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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the HealthScore record. ### PreviousScore - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: The previous score of the subject for the specified category. This field is automatically updated when with the previous value of the CurrentScore field when the score is updated. ### PreviousScoreDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the previous score was calculated. This field is automatically updated with the previous value of the CurrentScoreDate field when the score is updated. ### ScoreAndDate - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: For internal use. ### ScoreCategoryId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort - **Description**: The score category that the score belongs to. - **Refers To**: ScoreCategory ### ScoreChangePercent - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: The degree of change between the current score and the previous score. This field is a calculated field. ### ScoredAccountId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The account that is the subject of the score. - **Refers To**: Account ### ScoredContactId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The contact that is the subject of the score. This field is a relationship field. - **Refers To**: Contact ### ScoredLeadId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: The lead that is the subject of the score. This field is a relationship field. - **Refers To**: Lead ### SubjectId - **Type**: Polymorphic Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The subject of the score. - **Refers To**: Account, Contact, Lead ## Usage We recommend automating scores for this object using Data Cloud or another data processing solution. However, if you choose to manually enter data for records, just use the CurrentScore, CurrentScoreDate, ScoreCategoryId, and SubjectId fields. The other fields are automatically updated as required when you create or update a 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. [HealthScoreChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthScoreFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthScoreHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthScoreShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HealthScoreActionLog Represents the log of actions triggered from the Dynamic Actions for Unified Health Scoring component in the Unified Health Scoring feature. This object is available in API version 55.0 and later. Records in this object are automatically created when actions are triggered by your users. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ActionDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the action was triggered by an end user. ### ActionDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the triggered action, as defined by the admin. ### ActionIconUrl - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL of triggered action’s icon, as defined by the admin. ### ActionLabel - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The label of the triggered action, as defined by the admin. ### ActionName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of the triggered action, as defined by the admin. ### ActionStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status of the triggered action. The default value is ‘triggered’. To update the status to another value, set up a custom trigger or process. - **Possible values**: - Aborted - Completed - Failed - In Progress - Triggered ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date and time the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the log record. ### PerformedById - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who triggered the action. - **Refers To**: User ### Score - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The score of the subject who the action was triggered for. This field isn’t populated in logs by default. Customize the action logging capability of Unified Health Scoring to use this field. ### ScoreCategoryId - **Type**: Lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The score category of a score of the subject who the action was triggered for. This field isn’t populated in logs by default. Customize the action logging capability of Unified Health Scoring to use this field. - **Refers To**: ScoreCategory ### SubjectId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort - **Description**: The subject who the action was triggered for. - **Refers To**: Account, Contact, Lead ### TargetAccountId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: If the subject is an account, the account record of the subject. - **Refers To**: Account ### TargetContactId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: If the subject is an contact, the contact record of the subject. - **Refers To**: Contact ### TargetLeadId - **Type**: Lookup - **Properties**: Filter, Group, Nillable, Sort - **Description**: If the subject is an lead, the lead record of the subject. - **Refers To**: Lead ## 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. [HealthScoreActionLogFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HealthScoreActionLogHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HierCondHlthCodeMapping Represents how Hierarchical Condition Category (HCC) codes map to condition codes for a specific year. 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 ### ConditionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The health condition code that’s mapped to a Hierarchical Condition Category (HCC) code. This field is a polymorphic relationship field. - **Relationship Name**: ConditionCode - **Relationship Type**: Lookup - **Refers To**: CodeSet, CodeSetBundle ### EffectiveEndYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year till when the mapping is valid. ### EffectiveStartYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year from when the mapping is valid. ### HchcKey - **Type**: string - **Properties**: Filter, Group, idLookup, Nillable, Sort - **Description**: For internal use only. This field is a calculated field. ### HierarchicalCondCategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The HCC code that a health condition code is mapped to. This field is a relationship field. - **Relationship Name**: HierarchicalCondCategoryCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the specified health condition and HCC code mapping is active. - **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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PublishedYear - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The year when the specified mapping was published. ## 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. [HierCondHlthCodeMappingHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HierCondHlthCodeMappingOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [HierCondHlthCodeMappingShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # HierCondHlthRskAdjFctr Stores the risk adjustment factor for patients and members based on the set of Hierarchical Condition Category (HCC) codes that apply to them and the status of their benefits eligibility. 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 ### CmnyFullBnftDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### CmnyPartialBenefitDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CmnyPartialBnftDualDsbl - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### Community - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home. ### CommunityFullBnftDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CommunityNonDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of their age. ### CommunityNonDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of a disability. ### Condition - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the condition for which the HCC code is defined. ### ConditionCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the broader category that the specified condition belongs to. For instance, Respiratory Ailment. ### HierCondCategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record ID of the HCC code. This field is a relationship field. - **Relationship Name**: HierCondCategoryCode - **Relationship Type**: Lookup - **Refers To**: CodeSet ### Institutional - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at a healthcare facility. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the risk adjustment factors defined in the record are active. - **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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OverriddenCodes - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The list of HCC codes overridden by the specified HCC code. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PublishedYear - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The year when the specified risk adjustment factors were published. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # hlthcrbilling Namespace The hlthcrbilling namespace provides classes used to capture billing information for products in Salesforce Health Cloud. Use the classes in this namespace to manage detailed billing data for healthcare-related product line items This includes capturing product IDs, price book entries, and specific pricing attributes required for accurate billing within the Health Cloud ecosystem These classes allow for the organization of billing details for one or more products being ordered, integrating essential data points such as the associated account, work type, order date, and shipping address. The following are the classes in the hlthcrbilling namespace. - **[ProductBillingDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_class_hlthcrbilling_ProductBillingDetails)** Contains the billing details for one or more products being ordered, including the account, price book, work type, order date, and shipping address. - **[ProductDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_class_hlthcrbilling_ProductDetails)** Represents a single product line item, including the product ID, price book entry, quantity, unit price, and applicable pricing attributes. ## ProductBillingDetails Class Contains the billing details for one or more products being ordered, including the account, price book, work type, order date, and shipping address. ### Namespace [hlthcrbilling](#apex_namespace_hlcrbilling "The hlthcrbilling namespace provides classes used to capture billing information for products in Salesforce Health Cloud.") - **[ProductBillingDetails Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails)** The following are properties for ProductBillingDetails. ### ProductBillingDetails Properties The following are properties for ProductBillingDetails. The following are properties for ProductBillingDetails. - **[accountId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_accountId)** The ID of the Account for which the products are being billed. - **[orderDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_orderDate)** The date the order is placed. - **[priceBookId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_priceBookId)** The ID of the Pricebook2 record used to price the products in the order. - **[productDetails](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_productDetails)** The list of products to be billed. Each item describes a single line in the order. - **[shippingAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_shippingAddress)** The shipping address to which the ordered products are delivered. - **[workTypeId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductBillingDetails_workTypeId)** The ID of the Work Type record associated with the order. #### accountId The ID of the Account for which the products are being billed. ##### Signature public String accountId {get; set;} ##### Property Value Type: String #### orderDate The date the order is placed. ##### Signature public Date orderDate {get; set;} ##### Property Value Type: Date #### priceBookId The ID of the Pricebook2 record used to price the products in the order. ##### Signature public String priceBookId {get; set;} ##### Property Value Type: String #### productDetails The list of products to be billed. Each item describes a single line in the order. ##### Signature public List productDetails {get; set;} ##### Property Value Type: List #### shippingAddress The shipping address to which the ordered products are delivered. ##### Signature public healthcloudext.GroupVisitAddress shippingAddress {get; set;} ##### Property Value Type: healthcloudext.GroupVisitAddress #### workTypeId The ID of the Work Type record associated with the order. ##### Signature public String workTypeId {get; set;} ##### Property Value Type: String ## ProductDetails Class Represents a single product line item, including the product ID, price book entry, quantity, unit price, and applicable pricing attributes. ### Namespace [hlthcrbilling](#apex_namespace_hlcrbilling "The hlthcrbilling namespace provides classes used to capture billing information for products in Salesforce Health Cloud.") - **[ProductDetails Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails)** The following are properties for ProductDetails. ### ProductDetails Properties The following are properties for ProductDetails. The following are properties for ProductDetails. - **[priceBookEntryId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails_priceBookEntryId)** The ID of the PricebookEntry record that defines the price for this product in the active price book. - **[pricingAttributeList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails_pricingAttributeList)** The list of pricing attributes that apply to this product line item. - **[productId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails_productId)** The ID of the Product2 record being billed. - **[quantity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails_quantity)** The quantity of the product being ordered. - **[unitPrice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_hlcrbilling.htm#apex_hlthcrbilling_ProductDetails_unitPrice)** The unit price of the product. #### priceBookEntryId The ID of the PricebookEntry record that defines the price for this product in the active price book. ##### Signature public String priceBookEntryId {get; set;} ##### Property Value Type: String #### pricingAttributeList The list of pricing attributes that apply to this product line item. ##### Signature public List pricingAttributeList {get; set;} ##### Property Value Type: List #### productId The ID of the Product2 record being billed. ##### Signature public String productId {get; set;} ##### Property Value Type: String #### quantity The quantity of the product being ordered. ##### Signature public Decimal quantity {get; set;} ##### Property Value Type: Decimal #### unitPrice The unit price of the product. ##### Signature public Decimal unitPrice {get; set;} ##### Property Value Type: Decimal # Home Health The Home Health data model helps you store data for your organization’s home healthcare services. You can store the preferences patients have for their services, the skills your resources possess, the details of each home visit, and so on. The Home Health data model is primarily built over the Salesforce Field Service data model and uses many of its objects.
Available in: Enterprise and Unlimited editions of Health Cloud with the Home Health Add-On
![An entity relationship diagram for Home Health.](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_home_health_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/home-health.html "HTML (New Window)"). To learn more about the Field Service objects used in Home Health, see [Field Service Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.field_service_dev.meta/field_service_dev/fsl_dev_soap_objects.htm). - **[AccountServicePreference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_accountservicepreference.htm)** Represents the preferences an account has for the services they receive. In Home Health, this object represents the preferences that a patient has for the health workers assigned to their visits. This object is available in API version 58.0 and later. - **[CareServiceVisit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careservicevisit.htm)** Associates a service request or a referral request (ClinicalServiceRequest) with a visit (ServiceAppointment) that’s part of that service or referral. This object is available in API version 58.0 and later. - **[CareServiceVisitPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careservicevisitplan.htm)** Associates a service request with the series of visits that are planned as part of that visit. The series of visits is represented using MaintenancePlan. This object is available in API version 58.0 and later. - **[ClinicalServiceRequest for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_api_home_health_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. - **[ClinicalServiceRequestDetail for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_api_home_health_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. - **[CoverageBenefit for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_api_home_health_coveragebenefit.htm)** Represents the benefits provided to a covered member by a purchaser’s plan. - **[CoverageBenefitItem for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_hh_objects_coveragebenefititem.htm)** Represents a service covered by the insurance plan. - **[MedicationStatement for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_api_home_health_medicationstatement.htm)** Represents a record of medication that the patient is currently taking or has taken in the past. - **[OrderSource](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_ordersource.htm)** Represents the source details of an order. This object captures the point of origin for an order and the subsequent action, ensuring full traceability for audit purposes and operational visibility across any organizational process. This object is available in API version 67.0 and later. - **[PartyAppointmentRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_partyappointmentrequest.htm)** Represents an appointment request raised by a patient for their home healthcare services. This object is available in API version 61.0 and later. - **[PartySchedulePreference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_partyschedulepreference.htm)** Represents the schedule preference that a patient has for their home healthcare visit. This object is available in API version 61.0 and later. - **[PlanBenefit for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_hh_objects_planbenefit.htm)** Represents the standard benefits available under a plan that the purchaser offers to their members. - **[PlanBenefitItem for Home Health](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_hh_objects_planbenefititem.htm)** Represents the details of a benefit available under a purchaser’s plan that is offered to their members. - **[ScheduleBroadcast](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_schedulebroadcast.htm)** Represents a broadcast of appointments that's sent to resources of specific service territories. This object is available in API version 60.0 and later. - **[ScheduleBroadcastAppointment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_schedulebroadcastappointment.htm)** Represents appointments that schedulers broadcast to resources using a schedule broadcast. This object is available in API version 60.0 and later. - **[ScheduleBroadcastTerritory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_schedulebroadcastterritory.htm)** Represent service territories to which a schedule broadcast is sent. This object is available in API version 60.0 and later. - **[ScheduleBrdcstApptResource](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_schedulebrdcstapptresource.htm)** Represents a junction between a Schedule Broadcast Appointment and a Service Resource. This object represents the resources to whom a schedule broadcast is sent. This object is available in API version 60.0 and later. - **[SkillType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_skilltype.htm)** Represents the broader type or category that a skill belongs to. This object is available in API version 58.0 and later. #### See Also - [Health Cloud Administrators Guide: Home Health Data Model and Permissions](https://help.salesforce.com/s/articleView?id=ind.hc_admin_home_health_data_model_and_permissions.htm&type=5&language=en_US) - [Health Cloud Administrators Guide: Set up Home Health](https://help.salesforce.com/s/articleView?id=ind.hc_admin_home_health.htm&type=5&language=en_US) - [Salesforce Help: Use Home Health](https://help.salesforce.com/s/articleView?id=ind.hc_home_health.htm&type=5&language=en_US) # HomeHealth Contains Apex implementation for Manual Scheduling for healthcare appointments. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[GroupVisitAddress Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_group_visit_address.htm#apex_healthcloudext_group_visit_address)** Represents the details of the group visit address. - **[HomeVisitDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_Home_Visit_Details.htm#apex_healthcloudext_Home_Visit_Details)** Represents the details of the home visit requests. Once the scheduler approves the visit requests submitted by the patient or the quote requests submitted by the care coordinator, use this Apex class to retrieve the home visit details. - **[HomeVisitPatientBenefitDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_home_visit_patient_benefit_details)** Represents the home visit details for storing benefit related data. This class is used in the Additional Benefits flow in Budget screen and Agent benefit review flow in Agentforce. - **[HomeVisitPatientQuoteDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_home_visit_patient_quote_details)** Represents the home visit details for storing quote related data. This class is used in the Additional Quotes flow in Budget screen and Agent Quote review flow in Agentforce. - **[ResourceDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_HomeHealth_ResourceDetails.htm#apex_healthcloudext_HomeHealth_ResourceDetails)** Represents the home visit details for manual scheduling of appointments. Once the scheduler has selected the recommended resources along with the time slot, it will schedule the appointment using this Apex class. - **[PricingAttribute Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_PricingAttribute.htm#apex_class_healthcloudext_PricingAttribute)** Represents the attribute key, attribute value, and a boolean indicating if the attribute is a picklist type for a product. - **[ProductPricingAttributeDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_ProductPricingAttributeDetails.htm#apex_class_healthcloudext_ProductPricingAttributeDetails)** Represents details about a product's pricing attributes and their associated quantities. - **[RecurringVisitSchedulingInput Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_class_healthcloudext_RecurringVisitSchedulingInput)** Contains the input for scheduling recurring home visits, including the default address, work type configurations, recurrence series, resource assignment setting, and time zone. - **[VisitAddress Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitAddress.htm#apex_class_healthcloudext_VisitAddress)** Represents an address for recurring home visits. - **[VisitRecurrenceDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_class_healthcloudext_VisitRecurrenceDetails)** Represents one recurring series for home visits. Each series defines a recurrence pattern and can override request-level defaults. - **[VisitTimeSlot Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitTimeSlot.htm#apex_class_healthcloudext_VisitTimeSlot)** Represents a time slot within a day for recurring home visits. - **[VisitWorkType Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitWorkType.htm#apex_class_healthcloudext_VisitWorkType)** Represents a work type configuration for recurring home visits. # HomeVisitDetails Class Represents the details of the home visit requests. Once the scheduler approves the visit requests submitted by the patient or the quote requests submitted by the care coordinator, use this Apex class to retrieve the home visit details. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[resourceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_Home_Visit_Details.htm#apex_healthcloudext_HomeHealth_homevisitdetails_resourceid)** The ID of the selected service resource. - **[source](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_Home_Visit_Details.htm#apex_healthcloudext_HomeHealth_homevisitdetails_source)** The source of the home visit service resource. ## resourceId The ID of the selected service resource. ### Signature public String resourceId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## source The source of the home visit service resource. ### Signature public String source {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # HomeVisitPatientBenefitDetails Class Represents the home visit details for storing benefit related data. This class is used in the Additional Benefits flow in Budget screen and Agent benefit review flow in Agentforce. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[benefitId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_benefitId)** The ID of patient benefit. - **[benefitEndDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_benefitEndDate)** The date on which the benefit ends. - **[benefitName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_benefitName)** The name of the benefit. - **[benefitStartDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_benefitStartDate)** The date on which the benefit starts. - **[catalogId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_catalogId)** The ID of the product catalog. - **[catalogName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_catalogName)** The name of the product catalog. - **[categoryId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_categoryId)** The ID of the product category. - **[categoryName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_categoryName)** The name of the product category. - **[coverageBenefitId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_coverageBenefitId)** The ID of the coverage benefit. - **[coverageBenefitItemId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_coverageBenefitItemId)** The ID of the coverage Benefit Item. - **[coverageBenefitItemLimitId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_coverageBenefitItemLimitId)** The ID of the coverage benefit item limit. - **[isExistingBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_isExistingBenefit)** Indicates if the benefit ID is present in the system. - **[memberPlanId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_memberPlanId)** The ID of the member plan. - **[memberPlanName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_memberPlanName)** The name of the member plan. - **[productId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_productId)** The ID of the product. - **[productName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloudext_HomeVisitPatientBenefitDetails_productName)** The name of the product. - **[unitCount](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_unitCount)** The count of the benefit item. - **[unitPrice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.htm#apex_healthcloud_HomeVisitPatientBenefitDetails_unitPrice)** The price of the benefit. ## benefitId The ID of patient benefit. ### Signature global String benefitId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## benefitEndDate The date on which the benefit ends. ### Signature global String benefitEndDate {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## benefitName The name of the benefit. ### Signature global String benefitName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## benefitStartDate The date on which the benefit starts. ### Signature global String benefitStartDate {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## catalogId The ID of the product catalog. ### Signature global String catalogId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## catalogName The name of the product catalog. ### Signature global String catalogName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## categoryId The ID of the product category. ### Signature global String categoryId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## categoryName The name of the product category. ### Signature global String categoryName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## coverageBenefitId The ID of the coverage benefit. ### Signature global String coverageBenefitId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## coverageBenefitItemId The ID of the coverage Benefit Item. ### Signature global String coverageBenefitItemId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## coverageBenefitItemLimitId The ID of the coverage benefit item limit. ### Signature global String coverageBenefitItemLimitId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## isExistingBenefit Indicates if the benefit ID is present in the system. ### Signature global Boolean isExistingBenefit {get; set;} ### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ## memberPlanId The ID of the member plan. ### Signature global String memberPlanId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## memberPlanName The name of the member plan. ### Signature global String memberPlanName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## productId The ID of the product. ### Signature global String productId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## productName The name of the product. ### Signature global String productName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## unitCount The count of the benefit item. ### Signature global Decimal unitCount {get; set;} ### Property Value Type: [Decimal](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_decimal.htm) ## unitPrice The price of the benefit. ### Signature global Decimal unitPrice {get; set;} ### Property Value Type: [Decimal](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_decimal.htm) # HomeVisitPatientQuoteDetails Class Represents the home visit details for storing quote related data. This class is used in the Additional Quotes flow in Budget screen and Agent Quote review flow in Agentforce. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[createdDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_createdDate)** The quote created date. - **[careResourceTerritoryId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_careResourceTerritoryId)** The ID of the service territory. - **[isTravelInventoryIncluded](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_isTravelInventoryIncluded)** Indicates if the product is travel inventory record type. - **[locationId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_locationId)** The ID of the location. - **[operatingHoursId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_operatingHoursId)** The ID of the operating hour. - **[opportunityId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_opportunityId)** The ID of the opportunity. - **[priceBookId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_priceBookId)** The ID of the price book. - **[productNames](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_productNames)** The list of product names in the quote. - **[productIdList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_productIdList)** The list of product IDs in the quote. - **[quoteEndDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteEndDate)** The quote end date. - **[quoteEndTime](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteEndTime)** The quote end time. - **[quoteId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteId)** The ID of the patient's quote details. - **[quoteName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteName)** The name of the quote. - **[quotePrice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quotePrice)** The price of the quote. - **[quoteStartDate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteStartDate)** The quote start date. - **[quoteStartTime](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_quoteStartTime)** The quote start time. - **[schedulingPreference](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_schedulingPreference)** The selected time slot of the operating hour. - **[sourceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_sourceType)** The source reference type, for example, Opportunity. - **[unitCount](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_unitCount)** The count of the visit. - **[unitPrice](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_unitPrice)** The price of the benefit. - **[visitRecurrencePattern](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_visitRecurrencePattern)** The scheduling pattern for the recurring visit. - **[visitType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_quote_details.htm#apex_healthcloudext_HomeVisitPatientQuoteDetails_visitType)** The Start Of Care or Recurring visit type. ## createdDate The quote created date. ### Signature global Date createdDate {get; set;} ### Property Value Type: [Date](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_date.htm) ## careResourceTerritoryId The ID of the service territory. ### Signature global String careResourceTerritoryId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## isTravelInventoryIncluded Indicates if the product is travel inventory record type. ### Signature global Boolean isTravelInventoryIncluded {get; set;} ### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ## locationId The ID of the location. ### Signature global String locationId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## operatingHoursId The ID of the operating hour. ### Signature global String operatingHoursId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## opportunityId The ID of the opportunity. ### Signature global String opportunityId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## priceBookId The ID of the price book. ### Signature global String priceBookId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## productNames The list of product names in the quote. ### Signature global List productNames {get; set;} ### Property Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) ## productIdList The list of product IDs in the quote. ### Signature global List productIdList {get; set;} ### Property Value Type: [List](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_list.htm) ## quoteEndDate The quote end date. ### Signature global String quoteEndDate {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## quoteEndTime The quote end time. ### Signature global Time quoteEndTime {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_time.htm) ## quoteId The ID of the patient's quote details. ### Signature global String quoteId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## quoteName The name of the quote. ### Signature global String quoteName {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## quotePrice The price of the quote. ### Signature global Decimal quotePrice {get; set;} ### Property Value Type: [Decimal](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_decimal.htm) ## quoteStartDate The quote start date. ### Signature global String quoteStartDate {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## quoteStartTime The quote start time. ### Signature global Time quoteStartTime {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_time.htm) ## schedulingPreference The selected time slot of the operating hour. ### Signature global String schedulingPreference {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## sourceType The source reference type, for example, Opportunity. ### Signature global String sourceType {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## unitCount The count of the visit. ### Signature global Decimal unitCount {get; set;} ### Property Value Type: [Decimal](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_decimal.htm) ## unitPrice The price of the benefit. ### Signature global Decimal unitPrice {get; set;} ### Property Value Type: [Decimal](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_decimal.htm) ## visitRecurrencePattern The scheduling pattern for the recurring visit. ### Signature global String visitRecurrencePattern {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## visitType The Start Of Care or Recurring visit type. ### Signature global String visitType {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # HousingAssessment\_\_c Represents the settings for assessing the living situation of individuals. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the account object. ### AssessmentDate\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date when the housing assessment took place. ### CanPrepareFoodSafely\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the person can prepare food. ### CanQuarantine\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the person can quarantine effectively. ### Dwelling\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicated the type of residence for the person. - **Possible values**: - Apartment - Board and Care or Assisted Living Facility - Hotel or Motel - House - Long-Term Care Facility - Multi-Family Dwelling - Nursing Home - Recreational Vehicle or Mobile Home - Skilled Nursing Facility ### HasPrivateBathroom\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the person has access to a private bathroom. ### IsHomeless\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the person has a place to live in. ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The name of the housing assessment. ### QuarantineEndDate\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date of the quarantine period. ### QuarantineLocation\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the location where the person must quarantine. ### QuarantineStartDate\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date of the quarantine period. # HPI Score Sync Input Input representation of the score synchronization request. ## Root XML tag ## JSON example { "categoryName" : "HPI" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | categoryName | String | The name of the score category for which the score synchronization is triggered. | Required | 55.0 | | debugMode | Boolean | For internal use only. | Optional | 55.0 | | timestamp | String | For internal use only. | Optional | 55.0 | # HPI Score Sync Output Output representation of the score synchronization request. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | message | String | Specifies the status of the triggered synchronization or any errors the process might have run into. | Small, 55.0 | 55.0 | # HPI Score Sync State Output Output representation of the score synchronization status request.
Property Name Type Description Filter Group and Version Available Version
bulkJobId String The ID of the bulk job that contains the score synchronization requests. Small, 55.0 55.0
errors String[] The message associated with the synchronization status request, in case of failure. Small, 55.0 55.0
status String The status of the score synchronization request for the specified score category.
Possible values are:
  • Idle—Either no process is running or no requests for the specified category are pending.
  • Not Started—The synchronization process request is accepted, but hasn’t started yet.
  • In Progress—The synchronization request is in progress with the messaging queue.
  • Bulk Job Submitted—The scores are fetched from Data Cloud and the score records are submitted to the bulk job to be inserted into the HealthScore object.
  • Failed—Failure during the synchronization process.
Small, 55.0 55.0
# 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​. | #### See Also - [PersonName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_PersonName.htm "Represents detailed information about a person’s name. This object is available in API version 51.0 and later.") # IBenefitsVerificationInterOp Interface Contains default Apex implementation for verification of benefits. ## Namespace [HealthCloudExt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[IBenefitsVerificationInterOp Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IBenefitsVerificationInterOp.htm#apex_healthcloudext_IBenefitsVerificationInterOp_methods)** - **[IBenefitsVerificationInterOp Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IBenefitsVerificationInterOp.htm#apex_interface_healthcloudext_IBenefitsVerificationInterOp_Example)** ## IBenefitsVerificationInterOp Methods The following are methods for IBenefitsVerificationInterOp. - **[verifyBenefits(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IBenefitsVerificationInterOp.htm#apex_healthcloudext_IBenefitsVerificationInterOp_verifyBenefits)** Verifies the benefits. ### verifyBenefits(var1) Verifies the benefits. #### Signature public List verifyBenefits(List var1) #### Parameters var1 Type: List<[healthcloudext.BenefitsVerificationRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationRequest.htm#apex_class_healthcloudext_BenefitsVerificationRequest "Request for verification of benefits.")\> #### Return Value Type: List<[healthcloudext.BenefitsVerificationResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_BenefitsVerificationResponse.htm#apex_class_healthcloudext_BenefitsVerificationResponse "Response for verification of benefits.")\> ## IBenefitsVerificationInterOp Example Implementation This is an example implementation of the healthcloudext.IBenefitsVerificationInterOp interface. global class BenefitsVerificationInterImpl implements healthcloudext.IBenefitsVerificationInterOp { /\* @Method Name: verifyBenefits @Param: List of BenefitsVerificationRequests @Desc: Method which will do external callout to get the benefits verification information and transform this information in the form of the BenefitsVerificationResponse \*/ public List verifyBenefits(List request) { List responses = new List(); // Customer code to perform external callout to retrieve benefits verification information and transform response return responses; } } # Icon Represents the mapping of custom icons to objects. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.262.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location Icon components have the suffix .icon and are stored in the icons folder. ## Version Icon components are available in API version 49.0 and later. ## Special Access Rules To use this metadata type, your Salesforce org must have the Health Cloud or Financial Services Cloud license. ## Fields ### image - **Field Type**: string - **Description**: Required. The image file that is mapped to the object. Use the [ContentAsset](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_contentasset.htm "HTML (New Window)") metadata type to hold the icon image referenced in the image field. ### key - **Field Type**: string - **Description**: Required. A field value in the object. For example, with the PersonLifeEventobject, possible values for key can be birthday, marriage, childbirth, and so on. ### usageType - **Field Type**: IconUsageType (enumeration of type string) - **Description**: Required. The object that is mapped to the image. - **Possible values**: - PersonLifeEvent - InsurancePolicy - BusinessMilestone - AssetMilestone - FinancialAccountMilestone ## Declarative Metadata Sample Definition The following is an example of an Icon component. PersonLifeEvent Birth image The following is an example package.xml that references the previous definition. icons Icon 49.0 # id The unique identifier of the matched record in the system. ## Signature public String id {get; set;} ## Property Value Type: String # id The unique identifier of the saved record. ## Signature public String id {get; set;} ## Property Value Type: String # id\_verification Namespace The id\_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity. For example, the call center agent can ask the person to confirm their social security number, birth date, insurance details, or driver’s license number. The person contacting the call center could be a patient, a parent or guardian if the patient’s a minor, the authorized representative of a patient, or a provider. No matter who the caller is, if they want sensitive information, an agent must verify the caller’s identity first. If the inquiry concerns information in the public domain (for example, the location of a hospital), then verification isn’t required. The following are the classes in the id\_verification namespace. - **[FieldValue Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue)** Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification. - **[IdentityVerificationExt Interface](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_id_verification_IdentityVerificationExt.htm#apex_interface_id_verification_IdentityVerificationExt)** The IdentityVerificationExt interface enables you to verify a caller’s identity. - **[ProcessDefinition Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_class_id_verification_ProcessDefinition)** Contains the verification process definition, including the list of process details. - **[ProcessDetail Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_class_id_verification_ProcessDetail)** Contains the verification process details. - **[SearchFilter Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_class_id_verification_SearchFilter)** Contains data filters that is applied in object-based search. - **[SearchFilters Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_class_id_verification_SearchFilters)** Contains a list of data filters to be applied for object-based search. - **[SearchRequest Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_class_id_verification_SearchRequest)** Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields. - **[SearchResult Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_class_id_verification_SearchResult)** Contains the contract of search results in tabular format for either the object-based or text-based search. - **[SearchResultHeader Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_class_id_verification_SearchResultHeader)** Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result. - **[SearchResultRow Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_class_id_verification_SearchResultRow)** Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result. - **[SelectedSearchResult Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_class_id_verification_SelectedSearchResult)** Contains the details of the record that has been selected for verification. - **[SelectedVerifiedResult Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedVerifiedResult.htm#apex_class_id_verification_SelectedVerifiedResult)** Contains information about the verified object that is used for the secondary search. - **[VerificationContext Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationContext.htm#apex_class_id_verification_VerificationContext)** Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result. - **[VerificationProcessField Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationProcessField.htm#apex_class_id_verification_VerificationProcessField)** Contains details of the fields used for both search and the verification process. - **[VerificationProcessFieldList Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationProcessFieldList.htm#apex_class_id_verification_VerificationProcessFieldList)** Contains information about the list of fields used for both search and the verification process. - **[VerifiedDetails Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerifiedDetails.htm#apex_class_id_verification_VerifiedDetails)** Contains details about the verified object that is used for secondary search, including the process that’s used to verify the search object. - **[VerifiedResult Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerifiedResult.htm#apex_class_id_verification_VerifiedResult)** Contains information about the verification result that includes the required verifiers and optional verifiers and the verification status. - **[Verifier Class](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_Verifier.htm#apex_class_id_verification_Verifier)** Contains a list of input representations for verifier fields, including the optional and required fields. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_Identifier.htm "Represents identifier information for multiple objects. This object is available in API version 51.0 and later.") # Identity Verification Verify the caller's identity. ## Resource /connect/identity-verification/verification ## Example URI Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org, and replace {vXX.X} with the API version, including the leading v. https://{yourInstance.salesforce.com}/services/data/{vXX.X} /connect/identity-verification/verification ## Available Version 54.0 ## Requires Chatter No ## HTTP Methods POST ## Root XML tag ## JSON example { "processDefinition":{ "layoutType":"Tab", "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" } \] } }, "selectedSearchResult":{ "objectName":"Account", "selectedRecordId":"001RM00000141414", "selectedRecordObject":{ "selectedRecordObjectList":\[\] } } } ## Properties
Name Type Description Required or Optional Available Version
processDefinition Process Definition Input Represents the identity verification process definition. Required 54.0
selectedSearchResult Selected Search Result Input Represents the details of the object and fields to appear in the search result. Required 54.0
verifiedResult Verified Result Input Represents the verified result.

Note: Reserved for future use.

 Optional 54.0
## Response Body for POST [Verification Context Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_verification_context_output.htm "Represents the Verification Context resource output.") ## JSON Example { "isSuccess" : true, "message" : "Fetched verification information successfully for User Id : 001RM00000141414.", "processDefinition" : { "layoutType" : "Tab", "processDetail" : \[ { "dataSourceType" : "Salesforce", "optionalVerifierCount" : 1, "searchObjectName" : "Account", "searchResultUniqueIdField" : "Id", "searchSequenceNo" : 1, "searchType" : "Text-Based", "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" } \] } } \] }, "selectedSearchResult" : { "objectName" : "Account", "selectedRecordId" : "001RM00000141414", "selectedRecordObject" : \[ { "developerName" : "SampleAccountName", "value" : "Joe Tester" }, { "developerName" : "SampleAccountNumber", "value" : "10014" }, { "developerName" : "SamplePhone", "value" : "6500000014" }, { "developerName" : "SamplePostalCode", "value" : "94566" }, { "developerName" : "SampleAccount", "value" : "Joe Tester" }, { "developerName" : "AccountNumberSample", "value" : "10014" }, { "developerName" : "SamplePhoneNumber", "value" : "6500000014" } \] }, "verifiedResult" : { "optionalVerifiers" : \[ { "developerName" : "SampleAccountName", "verificationState" : "" }, { "developerName" : "SampleAccountNumber", "verificationState" : "" }, { "developerName" : "SamplePhone", "verificationState" : "" }, { "developerName" : "SamplePostalCode", "verificationState" : "" } \], "requiredVerifiers" : \[ \] } } # Identity Verification Use these resources to verify the caller's identity. For example, the call center agent can ask the person to confirm their social security number, birth date, insurance details, or driver’s license number. The person contacting the call center could be a patient, a parent or guardian if the patient’s a minor, the authorized representative of a patient, or a provider. No matter who the caller is, if they want sensitive information, an agent must verify the caller’s identity first. If the inquiry concerns information in the public domain (for example, the location of a hospital), then verification isn’t required. Available resources are: | Resource | Description | | --- | --- | | [/connect/identity-verification/build-context/${processDefinitionName}](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_build_verification_context.htm "Build the context required to perform identity verification.") | Build the context required to perform identity verification. | | [/connect/identity-verification/verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_identity_verification.htm "Verify the caller's identity.") | Verify the caller's identity. | | [/connect/identity-verification/search](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_search_identity_record.htm "Search the Salesforce record to verify a caller’s identity.") | Search the Salesforce record to verify a caller’s identity. | - **[Build Identity Verification Context](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_build_verification_context.htm)** Build the context required to perform identity verification. - **[Identity Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_identity_verification.htm)** Verify the caller's identity. - **[Identity Verification Search](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_search_identity_record.htm)** Search the Salesforce record to verify a caller’s identity. # Identity Verification Search Search the Salesforce record to verify a caller’s identity. ## Resource /connect/identity-verification/search ## Example URI https://yourInstance.salesforce.com/services/data/vXX.X/connect/identity-verification/search ## Available Version 54.0 ## Requires Chatter No ## HTTP Methods POST ## 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 | ## Response Body for POST [Search Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_search_output.htm "Output representation of the search response.") ## JSON Example { "isSuccess" : true, "message" : "Search is a success", "searchResult" : \[ { "searchFields" : \[ { "developerName" : "SamplePhone", "value" : "6500000014" }, { "developerName" : "AccountNumberSample", "value" : "10014" }, { "developerName" : "SamplePhoneNumber", "value" : "6500000014" }, { "developerName" : "SampleAccount", "value" : "Joe Tester" }, { "developerName" : "SampleAccountName", "value" : "Joe Tester" }, { "developerName" : "SampleAccountNumber", "value" : "10014" }, { "developerName" : "SamplePostalCode", "value" : "94566" }, { "developerName" : "Id", "value" : "001RM00000141414" } \] } \], "searchResultHeader" : \[ { "dataType" : "Phone", "developerName" : "SamplePhone", "displayLabel" : "Phone" }, { "dataType" : "Text", "developerName" : "AccountNumberSample", "displayLabel" : "Account Number" }, { "dataType" : "Phone", "developerName" : "SamplePhoneNumber", "displayLabel" : "Phone" }, { "dataType" : "Name", "developerName" : "SampleAccount", "displayLabel" : "Account Name" }, { "dataType" : "Name", "developerName" : "SampleAccountName", "displayLabel" : "Account Name" }, { "dataType" : "Text", "developerName" : "SampleAccountNumber", "displayLabel" : "Account Number" }, { "dataType" : "Text", "developerName" : "SamplePostalCode", "displayLabel" : "Billing Zip/Postal Code" }, { "dataType" : "Lookup", "developerName" : "Id", "displayLabel" : "Account ID" } \] } # IdentityVerificationExt Interface The IdentityVerificationExt interface enables you to verify a caller’s identity. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") ## Usage The id\_verification.IdentityVerificationExt interface is called by the Verify Customer Identity flow. To implement this interface, you must first declare a class with the implements keyword as follows: public class IdentityVerificationExtImpl implements id\_verification.IdentityVerificationExt{} Next, your class must also provide implementation for the following methods: public id\_verification.SearchResult search(id\_verification.SearchRequest searchRequest){ //Your code here } public id\_verification.VerificationContext getVerifiers(id\_verification.VerificationContext verificationContext){ //Your code here } public id\_verification.ProcessDetail getProcessDetail(id\_verification.ProcessDetail processDetail){ //Your code here } The method you implemented must be declared as global or public. - **[IdentityVerificationExt Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_id_verification_IdentityVerificationExt.htm#apex_id_verification_IdentityVerificationExt_methods)** - **[IdentityVerificationExt Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_id_verification_IdentityVerificationExt.htm#apex_interface_id_verification_IdentityVerificationExt_Example)** ## IdentityVerificationExt Methods The following are methods for IdentityVerificationExt. - **[getVerifiers(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_id_verification_IdentityVerificationExt.htm#apex_id_verification_IdentityVerificationExt_getVerifiers)** Returns the verification data that contains the columns to be verified. - **[search(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_id_verification_IdentityVerificationExt.htm#apex_id_verification_IdentityVerificationExt_search)** Returns the search result that includes the verification data. ### getVerifiers(var1) Returns the verification data that contains the columns to be verified. #### Signature public id\_verification.VerificationContext getVerifiers(id\_verification.VerificationContext var1) #### Parameters var1 Type: [id\_verification.VerificationContext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationContext.htm#apex_class_id_verification_VerificationContext "Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result.") Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result. #### Return Value Type: [id\_verification.VerificationContext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationContext.htm#apex_class_id_verification_VerificationContext "Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result.") ### search(var1) Returns the search result that includes the verification data. #### Signature public id\_verification.SearchResult search(id\_verification.SearchRequest var1) #### Parameters var1 Type: [id\_verification.SearchRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields. #### Return Value Type: [id\_verification.SearchRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") ## IdentityVerificationExt Example Implementation This example shows an implementation of the id\_verification.IdentityVerificationExt interface. The MockIdentityVerificationExt implements the id\_verification.IdentityVerificationExt interface and MockIdentityVerificationExtHelper contains the logic for each method. public class MockIdentityVerificationExt implements id\_verification.IdentityVerificationExt { public id\_verification.SearchResult search(id\_verification.SearchRequest searchRequest) { id\_verification.SearchResult searchResult = MockIdentityVerificationExtHelper.getDefaultSearchResult( searchRequest.searchTerm, searchRequest.searchFilters); return searchResult; } public id\_verification.VerificationContext getVerifiers(id\_verification.VerificationContext verificationContext) { id\_verification.VerificationContext context = MockIdentityVerificationExtHelper.getVerificationContext(); return context; } public id\_verification.ProcessDetail getProcessDetail(id\_verification.ProcessDetail processDetail) { return MockIdentityVerificationExtHelper.getAccountProcessDetail(null, null); } } public class MockIdentityVerificationExtHelper { // Mock records for search, in an ideal implementation these values will come from an API call private static List mockDb = new List { //MockAccountName, MockAccountNumber, MockPhone, MockPostalCode new String\[\] {'James Smith', '263872', '4156546635', '94117'}, new String\[\] {'Michelle Smith', '123872', '3237654456', '56400'}, new String\[\] {'Robert Smith', '329478', '6548987709', '56410'}, new String\[\] {'David Smith', '428476', '6099176652', '08701'}, new String\[\] {'Mary Smith', '238476', '6155123342', '08790'}, new String\[\] {'Maria Garcia', '349872', '4156754040', '94108'}, new String\[\] {'Lee Hartman', '949857', '6457833434', '94110'} }; public static id\_verification.SearchResult getDefaultSearchResult(String searchTerm, List < id\_verification.FieldValue > searchFilters) { id\_verification.SearchResult searchResult = new id\_verification.SearchResult(); searchResult.searchResultHeaders = getSearchResultHeaders(); searchResult.searchResultRows = getSearchResultRows(searchTerm, searchFilters); return searchResult; } private static List getSearchResultHeaders() { List searchResultHeaders = new List (); id\_verification.SearchResultHeader nameHeader = new id\_verification.SearchResultHeader(); nameHeader.developerName = 'MockName'; nameHeader.displayLabel = 'Name'; nameHeader.dataType = 'Name'; searchResultHeaders.add(nameHeader); id\_verification.SearchResultHeader accountNoHeader = new id\_verification.SearchResultHeader(); accountNoHeader.developerName = 'MockAccountNo'; accountNoHeader.displayLabel = 'Account #'; accountNoHeader.dataType = 'Text'; searchResultHeaders.add(accountNoHeader); return searchResultHeaders; } private static List getSearchResultRows(String searchTerm, List < id\_verification.FieldValue > searchFilters) { List searchResultRows = new List (); for (String\[\] row : mockDb) { id\_verification.SearchResultRow resultRow = new id\_verification.SearchResultRow(); List fieldValues = new List (); Boolean found = false; if (!String.isBlank(searchTerm)) { // Text Based Search else block can hold logic for object based search found = textBasedSearch(searchTerm, row); } if (found) { id\_verification.FieldValue fieldValue = new id\_verification.FieldValue(); fieldValue.developerName = 'MockAccountName'; fieldValue.value = row\[0\]; fieldValues.add(fieldValue); fieldValue = new id\_verification.FieldValue(); fieldValue.developerName = 'MockAccountNumber'; fieldValue.value = row\[1\]; fieldValues.add(fieldValue); fieldValue = new id\_verification.FieldValue(); fieldValue.developerName = 'MockPhone'; fieldValue.value = row\[2\]; fieldValues.add(fieldValue); fieldValue = new id\_verification.FieldValue(); fieldValue.developerName = 'MockPostalCode'; fieldValue.value = row\[3\]; fieldValues.add(fieldValue); resultRow.searchResultFieldValues = fieldValues; searchResultRows.add(resultRow); } } return searchResultRows; } private static Boolean textBasedSearch(String searchTerm, String\[\] row) { Boolean found = false; List terms = searchTerm.split(' '); String allTxt = ''; for (String col : row) { allTxt = allTxt + ' ' + col; } for (String term : terms) { if (allTxt.toLowercase().contains(term.toLowercase())) { found = true; } else { found = false; break; } } return found; } public static id\_verification.VerificationContext getVerificationContext() { id\_verification.VerificationContext context = new id\_verification.VerificationContext(); context.selectedSearchResult = new id\_verification.SelectedSearchResult(); context.verifiedResult = new id\_verification.VerifiedResult(); context.message = 'Success!'; context.isSuccess = true; context.processDefinition = new id\_verification.ProcessDefinition(); context.processDefinition.layoutType = 'Tab'; context.processDefinition.processDetail = new List (); context.processDefinition.processDetail.add(getAccountProcessDetail(context.selectedSearchResult, context.verifiedResult)); return context; } /\* This method will return static/mock values for the context, these values can also be pulled from the setup entities for Identity Verification \*/ public static id\_verification.ProcessDetail getAccountProcessDetail( id\_verification.SelectedSearchResult selectedSearchResult, id\_verification.VerifiedResult verifiedResult) { Integer numberOfOptionalVerifiers = 1; id\_verification.ProcessDetail accountProcessDetail = new id\_verification.ProcessDetail(); accountProcessDetail.developerName = 'External\_Process\_Detail'; accountProcessDetail.label = 'External Process Detail'; accountProcessDetail.dataSourceType = 'External'; accountProcessDetail.searchObjectName = 'Account'; accountProcessDetail.searchSequenceNo = 1; accountProcessDetail.searchType = 'Object-Based'; accountProcessDetail.searchResultUniqueIdField = 'MockAccountNo'; accountProcessDetail.searchResultFilter = ''; accountProcessDetail.searchResultSortOrder = ''; accountProcessDetail.optionalVerifierCount = 2; //This should be the ID of the apex class implementing the interface accountProcessDetail.apexClassName = '01pRM0000002iUX'; accountProcessDetail.verificationProcessFieldList = new id\_verification.VerificationProcessFieldList(); accountProcessDetail.verificationProcessFieldList.verificationProcessFields = getAccountProcessFields(selectedSearchResult, verifiedResult, numberOfOptionalVerifiers); return accountProcessDetail; } // This method does not populate all fields, this is just an example. public static List < id\_verification.VerificationProcessField > getAccountProcessFields(id\_verification.SelectedSearchResult selectedSearchResult, id\_verification.VerifiedResult verifiedResult, Integer numberOfOptionalVerifiers) { List < id\_verification.VerificationProcessField > processFields = new List < id\_verification.VerificationProcessField >(); List < id\_verification.FieldValue > selectedRecordFieldValues = new List < id\_verification.FieldValue >(); List < id\_verification.Verifier > requiredVerifiers = new List (); List < id\_verification.Verifier > optionalVerifiers = new List (); List < id\_verification.FieldValue > selectedPlaceholderOptionalFieldValues = new List < id\_verification.FieldValue >(); List < id\_verification.VerificationProcessField > optionalVerifierProcessFields = setOptionalVerifierProcessFields(selectedPlaceholderOptionalFieldValues); id\_verification.VerificationProcessField nameRequiredField = new id\_verification.VerificationProcessField(); nameRequiredField.dataSourceType = 'External'; nameRequiredField.dataType = 'Name'; nameRequiredField.developerName = 'MockAccountName'; nameRequiredField.fieldName = 'Name'; nameRequiredField.fieldType = 'requiredVerifier'; nameRequiredField.label = 'AccountName'; processFields.add(nameRequiredField); id\_verification.FieldValue nameRequiredSelectedRecord = new id\_verification.FieldValue(); nameRequiredSelectedRecord.developerName = nameRequiredField.developerName; nameRequiredSelectedRecord.value = 'Monica Green'; selectedRecordFieldValues.add(nameRequiredSelectedRecord); requiredVerifiers.add(new id\_verification.Verifier(nameRequiredField.developerName, 'unset')); id\_verification.VerificationProcessField accountNumberRequiredField = new id\_verification.VerificationProcessField(); accountNumberRequiredField.dataSourceType = 'External'; accountNumberRequiredField.dataType = 'Text'; accountNumberRequiredField.developerName = 'MockAccountNumber'; accountNumberRequiredField.fieldName = 'AccountNumber'; accountNumberRequiredField.fieldType = 'requiredVerifier'; accountNumberRequiredField.label = 'AccountNumber'; processFields.add(accountNumberRequiredField); id\_verification.FieldValue accountNumberRequiredSelectedRecord = new id\_verification.FieldValue(); accountNumberRequiredSelectedRecord.developerName = accountNumberRequiredField.developerName; accountNumberRequiredSelectedRecord.value = '923384'; selectedRecordFieldValues.add(accountNumberRequiredSelectedRecord); requiredVerifiers.add(new id\_verification.Verifier(accountNumberRequiredField.developerName, 'unset')); selectedSearchResult.selectedRecordObject = selectedRecordFieldValues; for (Integer i =0; i< optionalVerifierProcessFields.size(); i++) { processFields.add(optionalVerifierProcessFields.get(i)); selectedRecordFieldValues.add(selectedPlaceholderOptionalFieldValues.get(i)); optionalVerifiers.add(new id\_verification.Verifier(optionalVerifierProcessFields.get(i).developerName, 'unset')); } verifiedResult.requiredVerifiers = requiredVerifiers; verifiedResult.optionalVerifiers = optionalVerifiers; return processFields; } public static List < id\_verification.VerificationProcessField > setOptionalVerifierProcessFields(List < id\_verification.FieldValue > selectedPlaceholderValues) { List < id\_verification.VerificationProcessField > optionalVerifierProcessFields = new List < id\_verification.VerificationProcessField >(); id\_verification.VerificationProcessField postalCodeOptionalField = new id\_verification.VerificationProcessField(); postalCodeOptionalField.dataSourceType = 'External'; postalCodeOptionalField.dataType = 'Text'; postalCodeOptionalField.developerName = 'MockPostalCode'; postalCodeOptionalField.fieldName = 'BillingPostalCode'; postalCodeOptionalField.fieldType = 'optionalVerifier'; postalCodeOptionalField.label = 'Zip Code'; optionalVerifierProcessFields.add(postalCodeOptionalField); selectedPlaceholderValues.add(new id\_verification.FieldValue(postalCodeOptionalField.developerName, '94117')); id\_verification.VerificationProcessField birthdateOptionalField = new id\_verification.VerificationProcessField(); birthdateOptionalField.dataSourceType = 'External'; birthdateOptionalField.dataType = 'Text'; birthdateOptionalField.developerName = 'MockBirthdate'; birthdateOptionalField.fieldName = 'Birthdate'; birthdateOptionalField.fieldType = 'optionalVerifier'; birthdateOptionalField.label = 'Date of Birth'; optionalVerifierProcessFields.add(birthdateOptionalField); selectedPlaceholderValues.add(new id\_verification.FieldValue(birthdateOptionalField.developerName, '05/18/1986')); return optionalVerifierProcessFields; } } The following example tests the implementation: @isTest private class MockIdentityVerificationExtTest { static testMethod void getSearchResults() { MockIdentityVerificationExt mock = new MockIdentityVerificationExt(); id\_verification.SearchRequest searchRequest= new id\_verification.SearchRequest('Smith',null,null); mock.search(searchRequest); } static testMethod void getVerificationContext() { MockIdentityVerificationExt mock = new MockIdentityVerificationExt(); //To keep it simple here, we are passing null in the paramater & returning a default mock context mock.getVerifiers(null); } } # IdentityVerificationProcDef Represents the definition of the identity verification process. This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 IdentityVerificationProcDef 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 IdentityVerificationProcDef. - **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**: ndicates 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 IdentityVerificationProcDef throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The IdentityVerificationProcDef’s metadata. ### 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. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer. - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. ### SearchLayoutType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: The display layout of the search component ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note As of API version 54.0, Tab isn't supported. - **Possible values**: - Stack - Tab # IdentityVerificationProcDtl Used to configure the search function as well as the minimum number of verifiers for the identity verification process. Available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### DataSourceType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Specifies whether source of data for identity verification is external or within Salesforce. - **Possible values**: - External - Salesforce ### 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 IdentityVerificationProcDtl 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. ### IdentityVerificationProcDefId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The label of the relevant Identity Verification Process Definition record This field is a relationship field. - **Relationship Name**: IdentityVerificationProcDef - **Relationship Type**: Lookup - **Refers To**: IdentityVerificationProcDef ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is active. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the IdentityVerificationProcDtl. - **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) ### LinkedIdVerfProcessDetId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: The identity verification process detail record to be used for secondary verification. This field is a relationship field. - **Relationship Name**: LinkedIdVerfProcessDet - **Relationship Type**: Lookup - **Refers To**: IdentityVerificationProcDtl ### 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 IdentityVerificationProcDtl throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The IdentityVerificationProcDtl’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. ### ObjectName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The name of the object on which the search is performed and data is verified. ### OptionalVerifiersMinVerfCount - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The minimum number of additional verifiers that must be checked. ### SearchFilter - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Conditions to filter the search results. For example, if you want to perform the search only on Person Account records, enter isPersonAccount = true ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note Use the AND operator to enter multiple conditions. The OR operator isn’t currently supported. . ### SearchRecordUniqueIdField - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The field storing the unique identifier of records displayed in the search results. ### SearchResultSortBy - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The values that are used to sort the search results. For example, if you want to sort the results by policy date, enter PolicyDate\_\_c Desc. ### SearchSequenceNumber - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The sequence in which the search is performed and the search result is displayed. ### SearchType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: The type of search being performed. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note Text-based search enables users to enter search keywords in the search field. In object-based search, users search for data using available fields. - **Possible values**: - Object-Based - Text-Based # IdentityVerificationProcFld Used to configure the questions or criteria for verifying the identity of a caller. This object is available in API version 54.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### DataSourceType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Specifies whether source of data for identity verification is external or within Salesforce. - **Possible values**: - External - Salesforce ### 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. ### FieldName - **Type**: string - **Properties**: Filter, Group, Sort - **Description**: The label of the field that contains the verification data based on the selected field type. ### FieldType - **Type**: picklist - **Properties**: Filter, Group, Restricted picklist, Sort - **Description**: Specifies the type of the field that contains the verification data. - **Possible values**: - additionalResultField—Additional Result Field - optionalVerifier—Optional Verifier - requiredVerifier—Required Verifier - resultField—Result Field - searchField—Search Field - searchFilter—Search Filter ### FieldValueFormula - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Stores the formula that's applied to the field value. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note This field isn’t supported as of API version 54.0 ### FullName - **Type**: string - **Properties**: Create, Group, Nillable - **Description**: The full name of the associated IdentityVerificationProcFld 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. ### IdentityVerificationProcDtlId - **Type**: reference - **Properties**: Filter, Group, Sort - **Description**: The label of the relevant Identity Verification Process Detail record. This field is a relationship field. - **Relationship Name**: IdentityVerificationProcDtl - **Relationship Type**: Lookup - **Refers To**: IdentityVerificationProcDtl ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the record is active. - **Default value**: false ### Language - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: The language of the IdentityVerificationProcFld. - **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 IdentityVerificationProcFld throughout the Salesforce user interface. ### Metadata - **Type**: complexvalue - **Properties**: Create, Nillable, Update - **Description**: The IdentityVerificationProcFld’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. ### SequenceNumber - **Type**: int - **Properties**: Filter, Group, Sort - **Description**: The sequence number of the field. # ​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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # IndividualApplication Represents an application form submitted by an individual. Available with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the applicant’s account. ### AmountPaid - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount paid by the applicant. ### ApplicationCaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of a case that relates to this application. ### ApplicationCategory - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Categorizes the ways an application can be processed. - **Possible values**: - Basic - Special ### ApplicationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the application. - **Possible values**: - New - Renewal ### AppliedDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date on which the application was received from the applicant. ### ApprovedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the application was approved. ### BusinessTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of individual business activity for this application. ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The service category of the application. - **Possible values**: - Emergency Service - License - Permit ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text description provided by the applicant. ### IsOwnerEditable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether the owner ID of this record can be changed. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when a user most recently viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed. ### LicensePermitNameId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The emergency service authorization that will be granted if this application is approved. ### LicenseTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update, Nillable - **Description**: The type of emergency service that the applicant will provide. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The auto-generated unique ID for this application. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user that owns this record. ### PaymentDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time at which payment was received from the applicant. ### RequirementsCompleteDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the applicant fulfilled all the requirements for approval. ### SavedApplicationRefId - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Reference Id of the saved application. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The submission and approval status of the application. - **Possible values**: - Closed - In Distribution - In Review - Submitted ### WasReturned - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether a submitted application was sent back to the applicant due to errors. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [IndividualApplicationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 the object. [IndividualApplicationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [IndividualOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [IndividualApplicationShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.") Share is available for the object. # IndustriesSettings Represents settings for Health Cloud.This type extends the Metadata metadata type and inherits its fullName field. 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. ## File Suffix and Directory Location IndustriesSettings are stored in a single file named Industries.settings in the settings directory. ## Version Industries settings are available in API version 47.0 and later. ## Special Access Rules Users need the Health Cloud permissions to access the settings available in editions with Health Cloud. ## Fields for Health 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 true true false true true true true true The following is an example package.xml that references the previous definition. Industries Settings 47.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 | # Insurance Product Comparison (POST) Retrieves detailed information for multiple insurance products to facilitate a side-by-side comparison. ## Resource /connect/health/digital-health-insurance/products/comparisons ## Available Version 67.0 ## HTTP Methods POST ## Request Body for POST [Insurance Product Comparison Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_insurance_product_comparison_input.htm "The request payload containing the insurance products to compare.") ## Response Body for POST [Insurance Product Comparison Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_insurance_product_comparison_output.htm "The response body for the insurance product comparison request.") # Insurance Product Comparison Input The request payload containing the insurance products to compare. ## JSON example { "productIds": \[ "01txx0000006i2mAAA", "01txx0000006i2bAAA", "01txx0000006i2VAAQ", "01txx0000006i2aAAA" \] } ## Properties | Property Name | Type | Description | | --- | --- | --- | | product​Ids | String\[\] | List of Salesforce IDs for the insurance products to compare. | # Insurance Product Comparison Output The response body for the insurance product comparison request. ## Properties | Property Name | Type | Description | | --- | --- | --- | | is​Success | Boolean | Indicates whether the comparison request was successful (true) or not (false). | | message | String | Error message returned if the request is unsuccessful. | | plans | List | List of insurance plans being compared. | ## Insurance Plan Representation This representation details the specifics of an individual insurance plan. | Property Name | Type | Description | | --- | --- | --- | | contri​bution​Cost​Attributes | List | List of cost-related attributes such as copays and deductibles. | | coverages | List | Various benefits and services covered under this plan. | | member​Product​Code | String | Product code associated with the plan member. | | memberProductId | String | Salesforce ID of the member product. | | name | String | Display name of the insurance plan. | | product​Code | String | Unique code for the insurance product. | | product​Id | String | Salesforce ID of the insurance product. | ## Cost Attribute Representation Represents a specific cost component of a plan, such as a premium or copay. | Property Name | Type | Description | | --- | --- | --- | | name | String | Name of the cost attribute (for example, CoPay). | | value | String | Monetary value or percentage associated with the attribute. | ## Insurance Coverage Representation Details a specific medical service or benefit covered by the plan. | Property Name | Type | Description | | --- | --- | --- | | name | String | Name of the covered service (for example, Preventive Care and Wellness). | | product​Code | String | Code for the specific coverage product. | | product​Id | String | Salesforce ID of the coverage product. | # InsurancePolicy Represents a type of insurance policy. Available with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AttributesSelectedValues\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Values of root product attributes set at the InsurancePolicy level. ### AuditTerm - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The frequency of the audit. For example, monthly, semi-monthly, quarterly, semi-annually, or annually. - **Possible values**: - Annually - Monthly - Quarterly - Semi Annual(twice a year) - Semi-Monthly(twice a month) ### CancellationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the insurance policy was canceled. ### CancellationReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The reason for canceling the insurance policy. ### CancellationReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category that the cancellation reason belongs to. - **Possible values**: - Canceled at Request of the Finance Company - Canceled by Underwriter or Plan Administrator - Corporate Officer NonElection - Court Release - Coverage Placed Elsewhere - Duplicate Coverage - Failure to Comply with Terms and Conditions (ex. Audit Failure) - Failure to Pay Deductible - Insured's Request - Misrepresentation of Information on Application - Non-Payment - Not Taken - Other - Revocation of Voluntary Market Acceptance - Rewritten - Substantial Change in Risk - Underwriting Reasons ### CashSurrenderValue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The cash surrender value of the insurance policy. ### ChangeSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A further categorization of the change type. For example, childbirth, marriage. - **Possible values**: - Child Birth - Marriage ### ChangeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the change in the policy. For example, life event, house renovation. - **Possible values**: - House Renovation - Life-Event ### ContractLineItemId\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of a line item in the contract for the policy. This is a relationship field. - **Relationship Name**: ContractLineItemId\_\_r - **Relationship Type**: Lookup - **Refers To**: ContractLineItem\_\_c ### DateRenewed - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the policy was last renewed. ### Discount - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The discount that was given on the policy. ### EffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date from which the policy is in effect. ### ExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the policy expires. ### FinalRenewalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The final date on which the policyholder can renew the insurance policy. ### FnolChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel through which the loss for the claim associated with this policy was reported. This field is deprecated in API version 48.0 and will be removed in API version 52 (the Summer ’21 release). - **Possible values**: - Chatbot - Mobile - Phone - Web ### GrossWrittenPremium - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total expected premium amount for the insurance policy over the policy period. ### HasAnyAutoCoverage - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the insurance policy has an Any Auto coverage, which extends the coverage to hired and other non-owned vehicles. - **Default value**: False ### IsActive - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether the policy is active. - **Default value**: False ### IsLoanEligibile - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a loan can be requested against the insurance policy. - **Default value**: False ### IsRenewedPolicy - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the policy is a renewed policy. - **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**: The insurance policy number. Label is **Policy Number**. ### NameInsuredId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the primary insured. This is a relationship field. - **Relationship Name**: NameInsured - **Relationship Type**: Lookup - **Refers To**: Account ### OriginalEffectiveDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the original policy went into effect. This field is available from API version 51.0 and later. ### OriginalExpirationDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Expiration date of the original policy. This field is available from API version 51.0 and later. ### OriginalPolicyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the original insurance policy. This field is available from API version 51.0 and later. This is a relationship field. - **Relationship Name**: OriginalPolicy - **Relationship Type**: Lookup - **Refers To**: InsurancePolicy ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PaidToDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date up to which the policy is paid for. This field is available from API version 51.0 and later. ### ParentPolicyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the parent policy that covers this policy. For example, a parent policy can cover an auto policy and home policy. This is a relationship field. - **Relationship Name**: ParentPolicy - **Relationship Type**: Lookup - **Refers To**: InsurancePolicy ### PaymentDueDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the next payment of the premium is due. ### PlanTier - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The class that the insurance policy belongs to. For example, silver, gold, or platinum. - **Possible values**: - Gold - Platinum - Silver ### PlanType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the insurance policy plan. For example, single life, joint last-to-die, or joint first-to-die (primarily applicable for term insurance). - **Possible values**: - Joint First-to-Die - Joint Last-to-Die - Single Life ### PolicyDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the insurance policy. ### PolicyName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the insurance policy. ### PolicyTerm - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The time period for which the policy provides coverage. This field is available from API version 51.0 and later. - **Default value**: Annual - **Possible values**: - Annual - Custom - Daily - Monthly - Semi-Annual ### PolicyType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of the insurance policy. For example, home, auto, annuity, or life. - **Possible values**: - Annuity - Auto - Commercial Auto - Commercial Property - Home - Life - Workers' Compensation ### PremiumAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The premium paid by the policy owner for the current billing period. ### PremiumCalculationMethod - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The premium calculation method for a payment period. This field is available from API version 51.0 and later. - **Default value**: Daily - **Possible values**: - Daily - Modal ### PremiumFrequency - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The frequency of the premium payment or billing. For example, monthly, semi-monthly, quarterly, semi-annually, or annually. - **Default value**: Annually - **Possible values**: - Annually - Monthly - Quarterly - Semi Annual(twice a year) - Semi-Monthly(twice a month) ### PremiumPaymentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The type of premium payment, such as Advance or Arrears. This field is available from API version 51.0 and later. - **Default value**: Advance - **Possible values**: - Advance - Arrears ### PreviousPremium - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The premium of the policy before it was renewed. ### PreviousRenewalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the insurance policy was renewed in the last renewal cycle. ### PriorPolicyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the insurance policy before it was renewed. This is a relationship field. - **Relationship Name**: PriorPolicy - **Relationship Type**: Lookup - **Refers To**: InsurancePolicy ### ProducerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the agency or the agent who sold the policy. This is a relationship field. - **Relationship Name**: Producer - **Relationship Type**: Lookup - **Refers To**: Producer ### ProductCode\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: The code of the product that this policy belongs to. This is a calculated field. - **Formula**: Product.ProductCode ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The product that this policy belongs to. For example, if the customer buys a silver auto policy, this field looks up to the silver auto product in the Product object. This is a relationship field. - **Relationship Name**: Product - **Relationship Type**: Lookup - **Refers To**: Product2 ### RenewalChannel - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The channel through which the insurance policy was renewed. - **Possible values**: - Chatbot - Mobile - Phone - Web ### RenewalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the policy is expected to be renewed. The actual renewal date may be different. ### SaleDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the policy was sold. ### ServicingOffice - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address of the office that issued the policy and that services the policy. This is a compound field of type Address and combines these fields: ServicingOfficeCity, ServicingOfficeCountry, ServicingOfficeGeocodeAccuracy, ServicingOfficeLatitude, ServicingOfficeLongitude, ServicingOfficePostalCode, ServicingOfficeState, and ServicingOfficeStreet. ### SourceOpportunityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the opportunity from which the policy was created. This is a relationship field. - **Relationship Name**: SourceOpportunity - **Relationship Type**: Lookup - **Refers To**: Opportunity ### SourceQuoteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the quote from which the policy was created. This is a relationship field. - **Relationship Name**: SourceQuote - **Relationship Type**: Lookup - **Refers To**: Quote ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source system this record was obtained from. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique ID of this record in the source system. ### StandardFeeAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected fee for the policy over the policy period. This field is available from API version 51.0 and later. ### StandardPremiumAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected premium for the policy over the policy period. This field is available from API version 51.0 and later. ### StandardTaxAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected tax on the policy over the policy period. This field is available from API version 51.0 and later. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the insurance policy. - **Default value**: Initial - **Possible values**: - Agreement Premature endings - Applied - Canceled - Customer Rejected - Draft - Final - Full Life Ending - Hypothetical - In Force - In Force with temporary coverage - In Force-change pending - Initial - Insurer Rejected - Lapsed - Negotiation End - Not Taken Up - Offered - Quote Abandoned - Quoted - Replaced by customer application - Replaced by insurer counter offer - Suspended - Terminated - Under negotiation ### Substatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The carrier system's substatus code for the insurance policy. - **Default value**: Draft - **Possible values**: - Draft - Final - Negotiation End - Not Taken Up - Quote Abandoned ### TaxesSurcharges - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The taxes and surcharges levied on the premium for the insurance policy. ### TermFeeAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected fee for the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later. ### TermPremiumAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected premium for the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later. ### TermTaxAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The expected tax on the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later. ### TotalCommissionAmount - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total commission amount for the policy. ### TotalStandardAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: The sum of the expected premium, fee, and tax for the policy over the policy period. This field is available from API version 51.0 and later. This is a calculated field. ### TotalSumInsured - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total insured amount. This field is available from API version 51.0 and later. ### UnderwritingEntityId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Legal entity that underwrote the insurance policy. This is a relationship field. - **Relationship Name**: UnderwritingEntity - **Relationship Type**: Lookup - **Refers To**: LegalEntity ### UniversalPolicyNumber - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A number that uniquely identifies the policy across different source systems. ## 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. [InsurancePolicyChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Integrated Care Management Integrated Care Management provides a data model to store clinical data related to a patient or member’s care plans. This data model is both USCDI and FHIR R4-aligned, which helps with your system’s interoperability. With the objects in this data model, you can define a PGI library for your organization’s care plans, define care plan templates, and store care plans for patients or members. You can also store other information like episodes of care. To use this data model, go to Setup and enable the **FHIR R4-Aligned Data Model** setting on the FHIR R4 Support Settings page and the **Enhanced Care Plans** setting on the Integrated Care Management Settings page. ![A diagram of the Integrated Care Management data model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_integrated_care_management_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/integrated-care-management.html "HTML (New Window)"). - **[ActionPlanTemplateAssignment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_actionplantemplateassignment.htm)** 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. - **[AsmtQstnRespRecommendation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_asmtqstnresprecommendation.htm)** Maps an assessment question’s response to the recommendation it has to provide for a care plan. Recommendations can be problems, goals, interventions, or other assessments. This object is available in API version 57.0 and later. - **[CareEpisode](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careepisode.htm)** Records details of the interaction between a patient and a healthcare provider for the period during which the patient receives healthcare services from the provide. This object is based on the [EpisodeOfCare](https://www.hl7.org/fhir/episodeofcare.html#EpisodeOfCare) FHIR resource. This object is available in API version 57.0 and later. - **[CareEpisodeDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careepisodedetail.htm)** Represents additional information associated with a CareEpisode record. This information may be the referral requests that an episode of care started from or the diagnoses that the episode of care is meant to address. This object is available in API version 57.0 and later. - **[CareGap](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caregap.htm)** Represents gaps in patient care through a specified period. This object is available in API version 59.0 and later. - **[CareGapCriteriaResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caregapcriteriaresult.htm)** Represents the result of an evaluated clinical measure criteria. This object is available in API version 59.0 and later. - **[CarePlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplan.htm)** Represents a care plan that is created to help improve a patient or member’s health. This object is based on the [CarePlan](https://www.hl7.org/fhir/careplan.html#CarePlan) FHIR resource. This object is available in API version 56.0 and later. - **[CarePlanActivity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplanactivity.htm)** Represents an activity that’s part of a care plan. This object is a child of CarePlan. This object is available in API version 56.0 and later. - **[CarePlanActivityDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplanactivitydetail.htm)** Represents additional information associated with a CarePlanActivity record. This information may be outcomes of the activity, the performers who contributed to it, or the reasons why the activity was necessary.. This object is a child of CarePlanActivity. This object is available in API version 57.0 and later. - **[CarePlanDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplandetail.htm)** Represents additional information associated with a care plan record. These details may be things addressed by the care plan, contributors in the care plan, supporting information, and so on. This object is available in API version 57.0 and later. - **[CarePlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplantemplate.htm)** Represents a template use to instantiate a care plan. This object is available in API version 56.0 and later. - **[CarePlanTemplateGoal](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplantemplategoal.htm)** Represents goals in Care Plan Templates that don’t have problems as their parents. These goals are added directly under the care plan in the template . This object determines the position of goals in the hierarchy of care plan templates. The specific details of goals are referenced from GoalDefinitions records in the PGI library. This object is available in API version 57.0 and later. - **[CarePlanTemplateProblem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_careplantemplateproblem.htm)** Represents problems in Care Plan Templates. These problems may or may not have goals as their direct children. This object determines the position of problems in the hierarchy of care plan templates. The specific details of problems are referenced from ProblemDefinition records in the PGI library. This object is available in API version 57.0 and later. - **[CareTask](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caretask.htm)** Represents additional information about a healthcare-related task such as process status, beneficiary, and related tasks. This object is available in API version 61.0 and later. - **[CareTaskDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caretaskdetail.htm)** Represents extra details about a healthcare-related task such as the detail type, detail record, detail code, and detail value. This object is available in API version 61.0 and later. - **[ClinicalMeasure](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_clinicalmeasure.htm)** Represents a structured and computable definition of a health-related measure for identifying care gaps. This object is available in API version 59.0 and later. - **[ClinicalMeasureCriteria](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_clinicalmeasurecriteria.htm)** Represents a computable criteria of a health-related measure. This object is available in API version 59.0 and later. - **[ClinicalMeasureCriteriaGrp](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_clinicalmeasurecriteriagrp.htm)** Represents a group of computable criteria for a health-related measure. This object is available in API version 59.0 and later. - **[GoalAssignment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_goalassignment.htm)** Represents the goals that are part of a care plan. - **[GoalAssignmentDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_goalassignmentdetail.htm)** Represents additional information associated with a GoalAssignment record. This information may be the outcome of a goal or something addressed by it. This object is available in API version 57.0 and later. - **[GoalDefinition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_goaldefinition.htm)** 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. - **[MemberPlanCarePlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_memberplancareplan.htm)** Represents a junction between member plans and care plans. It defines the problems, goals, and interventions in a care plan based on the patient's health plan coverage. This object is available in API version 66.0 and later. - **[MemberPlanMedicationStmt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_memberplanmedicationstmt.htm)** Represents a junction between member plans and medication statements. It associates the medications that a patient is currently taking or has taken in the past with their health plan coverage. This object is available in API version 66.0 and later. - **[ProblemDefinition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_problemdefinition.htm)** The definition of a care plan problem in the reusable PGI library that’s a part of Integrated Care Management. When instantiated, ProblemDefinition records create HealthCondition records that serve as problems in care plans. This object is available in API version 57.0 and later. - **[ProblemGoalDefinition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_icm_problemgoaldefinition.htm)** A junction object that associated a goal definition to its parent problem definition. These junction records assist in establishing the problem-goal hierarchy in care plans instantiated from the PGI library. A problem definition can have multiple goal definitions as its children, and a goal definition can have multiple problem definitions as its parents. This object is available in API version 57.0 and later. - **[PurchaserPlanCareProgram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplancareprogram.htm)** Represents a junction between puchaser plans and care programs. It defines the care programs that are available under a purchaser plan such as employer-sponsored programs for managing chronic conditions. This object is available in API version 66.0 and later. # Intelligent Appointment Management Health Cloud integrates with a customer’s appointment management system to provide a patient appointment booking experience in Salesforce for call center agents and care coordinators. The Health Cloud data model for appointments enables you to work with multiple source systems operating on different electronic health record platforms. ![Appointment Management Data Model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/appointment_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/intelligent-appointment-management.html "HTML (New Window)"). - **[Practitioner Availability at Facilities](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_data_model.htm)** To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system. - **[AppointmentReason](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_appointmentreason.htm)** Represents a patient’s reason for making an appointment. Used for self-scheduling in Intelligent Appointment Management. This object is available in API version 53.0 and later. - **[ApptReasonEngmtChannelType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_apptreasonengmtchanneltype.htm)** Represents an available engagement channel for a given AppointmentReason. Possible engagement channels could be video, phone, or in person. Possible appointment reasons could be annual physical, fever, or physical therapy. This object is available in API version 56.0 and later. - **[AssetType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_assettype.htm)** Represents a type of asset, such as a type of item, physical space, or service offering. This object is available in API version 62.0 and later. - **[CarePractnFacilityAppt](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_sforce_api_objects_carepractnfacilityappt.htm)** Represents a junction object between a HealthcarePractitionerFacility (practitioner at a facility) and a ServiceAppointment (appointment). This object is available in API version 52.0 and later. - **[ClinicalEncounter for Intelligent Appointment Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_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. - **[ServiceAppointmentAsset](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_serviceappointmentasset.htm)** Represents a junction between Service Appointment and Asset. This junction object enables admins to associate a patient appointment to an asset such as a piece of medical equipment. This object is available in API version 62.0 and later. - **[WorkTypeAssetType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypeassettype.htm)** Represents a junction between Work Type and Asset Type. This junction object enables admins to associate a visit type such as PRP Hair Restoration to an asset type such as Room. This object is available in API version 62.0 and later. - **[WorkTypeCareSpecialty](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypecarespecialty.htm)** Represents a relationship between a care specialty and a visit type (Work Type). This object is available in API version 52.0 and later. - **[WorkTypeCodeSetBundle](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_worktypecodesetbundle.htm)** Represents a relationship between visit type (Work Type) and code set bundles that represent the service and appointment details for the visit type. This object is available in API version 52.0 and later. # Intelligent Appointment Management Operations The available operations for Intelligent Appointment Management include finding available appointment time slots, determining the status of an appointment slot, creating an appointment, getting a scheduled appointment, and canceling an appointment. These APIs calls out to an external system, while the [Appointment Management APIs](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/hc_appointment_management_intro.htm) call into the system. The URL for each operation is formed from two parts: Protocol + Domain This is defined in a Named Credential for appointment management. - Create a named credential in Setup. - The name of the credential must be Appointment\_Management. - Associate the named credential with Intelligent Appointment Management in Setup under Intelligent Appointment Management Configuration. Path For each operation this defines the URI path following the value obtained from the Named Credential. Each operation uses the default URI paths shown below. The default URI path for each operation can be overridden in Setup under **Intelligent Appointment Management URL Configuration**. If you override default URI paths with custom URIs, make corresponding changes in a custom Apex class that connects with your electronic health record (EHR) system’s middleware. Consistency between custom URI paths and custom Apex ensures that data from each endpoint is parsed as expected. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note The comments in these JSON samples are for documentation purposes only and aren’t meant to be valid JSON. - **[Find Available Time Slots for an Appointment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_operation_find_slots.htm)** When a call center agent wants to schedule an appointment, the first step is to find the available time slots for providers who match the patient’s needs. The call center agent gathers selection criteria and then initiates a search to obtain the available slots for providers who match the criteria. - **[Get Slot Status](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_operation_get_slot_status.htm)** - **[Create Appointment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_operation_create_appointment.htm)** When the patient selects an available slot, the call center agent books the appointment, which triggers a Get Slot Status REST call to the EHR system. - **[Cancel Appointment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/healthcare_appointment_booking_operation_cancel_appointment.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 and the Health Cloud Platform permission set licenses and the Health Cloud Permission Set License permission set. Available in API version 47.0 and later. - **[ReceivedDocument](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_receiveddocument.htm)** 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. - **[ReceivedDocumentType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_receiveddocumenttype.htm)** Represents a junction object between Received Document and Document Type. This object is available in API version 58.0 and later. - **[OcrDocumentScanResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_ocrdocumentscanresult.htm)** Represents the contents of a document after optical character recognition (OCR) processing. This object is available in API version 50.0 and later. - **[DocumentChecklistItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_documentchecklistitem.htm)** Represents a checklist item for a documentation file upload. This object is available in API version 47.0 and later. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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). #### See Also - [User Personas for Intelligent Sales](https://help.salesforce.com/s/articleView?id=ind.admin_intelligent_sales.htm&type=5&language=en_US "User Personas for Intelligent Sales - HTML (New Window)") - [The Intelligent Sales Data Model](https://help.salesforce.com/s/articleView?id=ind.admin_intelligent_sales_data_model.htm&type=5&language=en_US "The Intelligent Sales Data Model - HTML (New Window)") # InteropTopic Represents the interoperability topic for which notifications are sent to subscribers. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ApprovalDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the interoperability topic was approved. ### CopyrightInformation - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The copyright information of the interoperability topic. ### CopyrightLabel - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The copyright label of the interoperability topic. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The description of the interoperability topic. ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last date when the interoperability topic is effective. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The first date from when the interoperability topic is effective. ### GlobalUniqueIdentifier - **Type**: textarea - **Properties**: Create, idLookup, Update - **Description**: The global unique identifier of the interoperability topic definition. ### IsExperimental - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the interoperability topic is experimental. - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic record was last referenced. ### LastReviewedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the interoperability topic was last reviewed. ### LastRevisedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date when the interoperability topic was last revised. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The date when the interoperability topic was last revised. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns the interoperability topic record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PublisherId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The publisher of the interoperability topic. This field is a relationship field. - **Relationship Name**: Publisher - **Refers To**: Account ### Purpose - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The purpose of the interoperability topic. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the interoperability topic. - **Possible values**: - ACTIVE—Active - DRAFT—Draft - RETIRED—Retired - UNKNOWN—Unknown ### SubscriberIdentifierType - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of identifier assigned to the subscriber. ### Title - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The title of the interoperability topic. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the interoperability topic. - **Possible values**: - HEALTHCLOUD—Health Cloud ### Version - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The version of the interoperability topic. ## 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. [InteropTopicChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicDetail Represents the details of an interoperability topic. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The detail record added to the interoperability topic. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: CodeSet, CodeSetBundle, ContactPointEmail, ContactPointPhone, InteropTopic ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of detail added to the interoperability topic. - **Possible values**: - CONTACT—Contact - DERIVED\_FROM—Derived From - JURISDICTION—Jurisdiction ### InteropTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic for which the details are added. This field is a relationship field. - **Relationship Name**: InteropTopic - **Relationship Type**: Master-detail - **Refers To**: InteropTopic (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic detail record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic detail record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic 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. [InteropTopicDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicFilter Represents the properties by which an interoperability topic's notification can be filtered. This object is available in API version 64.0 and later. ## 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 of the interoperability topic filter. ### InteropTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic for which the filters are defined. This field is a relationship field. - **Relationship Name**: InteropTopic - **Relationship Type**: Master-detail - **Refers To**: InteropTopic (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic filter record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic filter record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic filter. ### OperatorType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the type of operator that applies to the filter. ### QueryOperatorType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the type of query operator that applies to the filter. ### Resource - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The resource for which the notification is sent. ### ResourceField - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The resource field that's used as a paramater in the filter. ### ResourceFieldUrl - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The URL of the resource field that's used as a paramater in the filter. ## 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. [InteropTopicFilterChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicFilterFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicFilterHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicNtfcnResource Represents the notification resource for an interoperability topic. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### IncludedRelaRsrcFieldSpec - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Any additional related resource fields specification that may be included in the notification. ### IncludedResourceFieldSpec - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The resource fields specification that should be included in the notification. ### InteropTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic for which the notification resource is specified. This field is a relationship field. - **Relationship Name**: InteropTopic - **Relationship Type**: Master-detail - **Refers To**: InteropTopic (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic notification resource record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic notification resource record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic notification resource. ### Resource - **Type**: textarea - **Properties**: Create, Update - **Description**: The resource for which the notification is sent. ## 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. [InteropTopicNtfcnResourceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicNtfcnResourceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicNtfcnResourceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicSubcrFilter Represents the subscriber's criteria for filtering the interoperability topic subscription event. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InteropTopicFilterId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated interoperability topic filter. This field is a relationship field. - **Relationship Name**: InteropTopicFilter - **Refers To**: InteropTopicFilter ### InteropTopicSubscriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic subscription to which the filter is applied. This field is a relationship field. - **Relationship Name**: InteropTopicSubscription - **Relationship Type**: Master-detail - **Refers To**: InteropTopicSubscription (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription filter record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription filter record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic subscription filter record. ### OperatorType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of operator that applies to the filter. - **Possible values**: - APPROXIMATELY—Approximately - ENDS\_BEFORE—Ends Before - EQUALS—Equals - GREATER\_OR\_EQUALS—Greater or Equals - GREATER\_THAN—Greater Than - LESS\_OR\_EQUALS—Less or Equals - LESS\_THAN—Less Than - NOT\_EQUALS—Not Equals - STARTS\_AFTER—Starts After ### QueryOperatorType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of query operator that applies to the filter. - **Possible values**: - ABOVE—Above - BELOW—Below - CODE\_TEXT—Code Text - CONTAINS—Contains - EXACT—Exact - IDENTIFIER—Identifier - IN—In - ITERATE—Iterate - MISSING—Missing - NOT—Not - NOT\_IN—Not In - OF\_TYPE—Of Type - TEXT—Text - TEXT\_ADVANCED—Text Advanced - TYPE—Type ### Value - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The value of the filter. ## 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. [InteropTopicSubcrFilterChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubcrFilterFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubcrFilterHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicSubcrParameter Represents the parameters added to an interoperability topic subscription. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### InteropTopicSubscriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic subscription for which the parameters are added. This field is a relationship field. - **Relationship Name**: InteropTopicSubscription - **Relationship Type**: Master-detail - **Refers To**: InteropTopicSubscription (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription parameter record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription parameter record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic subscription parameter record. ### ParameterName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the parameter added to the interoperability topic subscription. ### ParameterValue - **Type**: textarea - **Properties**: Create, Update - **Description**: The value of the parameter added to the interoperability topic subscription. ## 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. [InteropTopicSubcrParameterChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubcrParameterFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubcrParameterHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicSubscription Represents a subscription to an interoperability topic. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ChannelIdentifier - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The identifier of the channel to which notifications are sent, such as an URL or email. ### ChannelTypeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code representing the type of channel used to send notifications for the interoperability topic subscription. This field is a relationship field. - **Relationship Name**: ChannelTypeCode - **Refers To**: CodeSet ### CheckInInterval - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum interval, in seconds, before a check-in notification is sent to keep the subscription active when no new events occur. ### EffectiveEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The last date when the interoperability topic subscription is effective. ### EffectiveStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The first date when the interoperability topic subscription is effective. ### InteropTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The interoperability topic that's being subscribed to. This field is a relationship field. - **Relationship Name**: InteropTopic - **Refers To**: InteropTopic ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription record was last viewed. ### MaximumEventCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum number of events that can be bundled in a notification. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the interoperability topic subscription. ### NotificationTimeout - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The maximum amount of time, in seconds, to deliver a notifcation for the subscription. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns the interoperability topic subscription record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PayloadContentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of content included in the notification payload. - **Possible values**: - EMPTY—Empty - FULL\_RESOURCE—Full Resource - ID\_ONLY—ID Only ### PayloadFormatType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the format in which the notification payload for the subscription is sent. ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the interoperability topic subscription. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the interoperability topic subscription. - **Possible values**: - ACTIVE—Active - ENTERED\_IN\_ERROR—Entered in Error - ERROR—Error - OFF—Off - REQUESTED—Requested ### SubscribedById - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The subscriber to the interoperability topic. This field is a polymorphic relationship field. - **Relationship Name**: SubscribedBy - **Refers To**: Account, HealthcareProvider ### SubscriberIdentifier - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The unique identifier of the subscriber. ### SubscriberSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique identifier of the subscriber 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. [InteropTopicSubscriptionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubscriptionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubscriptionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubscriptionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicSubscriptionDtl Represents the details of an interoperability topic subscription. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The detail record added to the interoperability topic subscription. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: ContactPointEmail, ContactPointPhone ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of detail added to the interoperability topic subscription. - **Possible values**: - Contact ### InteropTopicSubscriptionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic subscription for which the details are added. This field is a relationship field. - **Relationship Name**: InteropTopicSubscription - **Relationship Type**: Master-detail - **Refers To**: InteropTopicSubscription (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription detail record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic subscription detail record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic subscription 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. [InteropTopicSubscriptionDtlChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubscriptionDtlFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicSubscriptionDtlHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # InteropTopicTriggerCriteria Represents the criteria that trigger a notification for an interoperability topic. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AreBothRsrcStsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if both the previous and current resource statuses are required to trigger a notification. - **Default value**: false ### CreateOperationResultType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the result type when the operation type is Create. - **Possible values**: - Test Fails - Test Passes ### CriteriaExpression - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The trigger critera expressed in a machine-readable format. ### CurrentResourceStatus - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the resource after the triggering update is made. ### DeleteOperationResultType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the result when the operation type is Delete. - **Possible values**: - Test Fails - Test Passes ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the interoperability topic trigger criteria. ### EventCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the event that triggers the notification. This field is a polymorphic relationship field. - **Relationship Name**: EventCode - **Refers To**: CodeSet, CodeSetBundle ### InteropTopicId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The interoperability topic for which the trigger criteria is defined. This field is a relationship field. - **Relationship Name**: InteropTopic - **Relationship Type**: Master-detail - **Refers To**: InteropTopic (the master object) ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic trigger criteria record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the interoperability topic trigger criteria record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the interoperability topic trigger criteria. ### OperationType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the type of operation that triggers the subscription notification. ### PreviousResourceStatus - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status of the resource before the triggering update is made. ### Resource - **Type**: textarea - **Properties**: Create, Update - **Description**: The resource for which the notification is sent. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of trigger that activates the interoperability topic. - **Possible values**: - EventTrigger—Event Trigger - ResourceTrigger—Resource Trigger ## 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. [InteropTopicTriggerCriteriaChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicTriggerCriteriaFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [InteropTopicTriggerCriteriaHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # isExistingParentReferenced Indicates whether the attribute refers to an already existing parent record in the system. ## Signature public Boolean isExistingParentReferenced {get; set;} ## Property Value Type: Boolean # isExistingRecord Indicates whether the node corresponds to an existing record in the system. ## Signature public Boolean isExistingRecord {get; set;} ## Property Value Type: Boolean # isManualReviewRequired Indicates whether the processed document requires manual review by a user. ## Signature public Boolean isManualReviewRequired {get; set;} ## Property Value Type: Boolean # isSuccess Indicates whether the post-save process completed successfully. ## Signature public Boolean isSuccess {get; set;} ## Property Value Type: Boolean # isSuccess Indicates whether the post-transform process completed successfully. ## Signature public Boolean isSuccess {get; set;} ## Property Value Type: Boolean # IUnifiedHealthScore Interface Stores additional information in the action logs. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") ## Usage Actions triggered from the Dynamic Actions for Unified Health Scoring component are logged in the Health Score Action Log object. You can customize the information logged in this object using the IUnifiedHealthScore Apex interface in a custom Apex class. - **[IUnifiedHealthScore Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IUnifiedHealthScore.htm#apex_healthcloudext_IUnifiedHealthScore_methods)** - **[IUnifiedHealthScore Example Implementation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IUnifiedHealthScore.htm#apex_interface_healthcloudext_IUnifiedHealthScore_Example)** ## IUnifiedHealthScore Methods The following are methods for IUnifiedHealthScore. - **[saveActionDetail(var1)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_interface_healthcloudext_IUnifiedHealthScore.htm#apex_healthcloudext_IUnifiedHealthScore_saveActionDetail)** Stores health score information in the Health Score Action Log object. The action history logged in Health Score Action Log doesn’t include score information by default. ### saveActionDetail(var1) Stores health score information in the Health Score Action Log object. The action history logged in Health Score Action Log doesn’t include score information by default. #### Signature public Boolean saveActionDetail(Map var1) #### Parameters var1 Type: Map<[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm),[String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm)\> A map of key-value pairs for the attributes, including subject ID, action status, action date, action label, action name, action description, action icon URL, and performed by ID. #### Return Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ## IUnifiedHealthScore Example Implementation This example shows an implementation of the healthcloudext.IUnifiedHealthScore interface. Using this sample code, your action logs now also mention the specified score category and its score value at the time the action was triggered. global class ApexClassForCustomLogs implements healthcloudext.IUnifiedHealthScore{//IMPORTANT: replace CustomActionLog with the name the Apex class public Boolean saveActionDetail(Map request){ try { String aSubject = request.get('subjectId'); List aHealthScore = \[select CurrentScore from HealthScore where SubjectId=:aSubject and ScoreCategoryId='0gzRN00000001drYAA'\]; //IMPORTANT: Replace 0gzRN00000001drYAA with the Id of your score category. List acctList = new List(); HealthScoreActionLog aHealthScoreActionLog = new HealthScoreActionLog( ActionDescription=request.get('actionDescription'), ActionIconUrl=request.get('actionIconUrl'), ActionLabel=request.get('actionLabel'), ActionName=request.get('actionName'), ActionStatus=request.get('actionStatus'), PerformedById=request.get('performedById'), SubjectId=request.get('subjectId'), ActionDate=datetime.now(), Score=aHealthScore\[0\].CurrentScore, ScoreCategoryId='0gzRN00000001drYAA'//IMPORTANT: Replace 0gzRN00000001drYAA with the Id of your score category. ); acctList.add(aHealthScoreActionLog); Database.SaveResult\[\] srList = Database.insert(acctList, false); for (Database.SaveResult sr : srList) { if (sr.isSuccess()) { // Operation was successful, so get the ID of the record that was processed System.debug('Successfully inserted account. HealthScoreActionLog ID: ' + sr.getId()); } else { // Operation failed, so get all errors for(Database.Error err : sr.getErrors()) { System.debug('The following error has occurred.'); System.debug(err.getStatusCode() + ': ' + err.getMessage()); System.debug('Account fields that affected this error: ' + err.getFields()); } } } //insert aHealthScoreActionLog; return true; }catch(DmlException e) { System.debug('An unexpected error has occurred: ' + e.getMessage()); return false; } } } ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note Ensure that you replace the category ID in this sample code with the ID of the category that you want to log score information for. You can find the IDs of your score categories by either inspecting a category page’s URL, or you can run this query in the Developer Console Query Editor: Select Id,CategoryName from ScoreCategory # Lead Custom Fields Custom fields extend the standard Lead object for use in Emergency Response Management. ## Fields ### AppointmentDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Date of the appointment. ### AppointmentId - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier of the appointment. ### StatusGroup\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Categorizes a person’s stage within the testing and monitoring process. - **Possible values**: - Monitored - Positive - Ready for intake - Unknown - Unmonitored # Location The Location FHIR resource maps to the Healthcare​Facility and Location objects in Salesforce​. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_location.png) #### See Also - [HealthcareFacility](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # LogProperties\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DebugLevel\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### LoggerImplementation\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ### LoggingEnabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Whether logging is enabled (true) or not (false). ### UILoggingLevel\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_annotation.htm)** The Annotation FHIR resource maps to the AuthorNote​ object in Salesforce. - **[Attachment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_Coding.htm)** The Coding FHIR resource maps to the CodeSet object in Salesforce. - **[CommunicationRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_ContactPoint.htm)** The ContactPoint FHIR resource maps to the Contact​Point​Phone​ object in Salesforce. - **[CRDMetricData](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_crdmetricdata.htm)** The CRDMetricData FHIR resource maps to the ServiceInformationRequest, ServiceInfoRequestDetail, ServiceInfoResponseCoverage, SvcInfoRespCoverageDetail,ServiceInfoResponseAction ServiceInfoRespSuggestion, ServiceInfoRespOvrideOptobjects. - **[Device](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_dosage.htm)** The Dosage FHIR resource maps to the Patient​Medication​Dosage​ object in Salesforce. - **[DTRMetricData](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_dtrmetricdata.htm)** The DTRMetricData FHIR resource maps to the ServiceInformationRequest, ServiceInfoRequestDetail, ServiceInfoRequestOperation, andServiceInfoResponseCoverageobjects. - **[DTRQuestionnaireResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_dtrquestionnaireresponse.htm)** The DTRQuestionnaireResponse FHIR resource maps to the Assessment and AssessmentReason object. - **[DTRStdQuestionnaire](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_dtrstdquestionnaire.htm)** The DTRStdQuestionnaire FHIR resource maps to the AssessmentDefinition, AssessmentQuestion, AssessmentQuestionResponse, and AssessmentQuestionVersion objects. - **[Encounter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_Identifier.htm)** The Identifier FHIR resource maps to the Identifier object in Salesforce. - **[​Immunization](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_informationorigin.htm)** The CRDMetricData FHIR resource maps to the AssessmentQuestionResponse object. - **[Location](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_organization.htm)** The Organization FHIR resource maps primarily to the Account object in Salesforce​. - **[PASClaim](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_pasclaim.htm)** The PASClaim FHIR resource maps to the CareDiagnosis, CareRequest, CareRequestDrug, CareRequestItem, CareRequestReviewer, and Identifier obejcts. - **[PASClaimResponse](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_pasclaimresponse.htm)** The PASClaimResponse FHIR resource maps to the CareProcessingError, AuthorNote, TrackedCommunication, andTrackedCommunicationDetailobjects. - **[PASMetricData](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_pasmetricdata.htm)** The PASMetricData FHIR resource maps to the CareRequestExchangeInfo object. - **[Patient](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_ServiceRequest.htm)** The service​Request FH​IR resource maps to the Clinical​Service​Request and Clinical​Service​Request​Detail objects in Salesforce​. - **[Subscription](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_subscription.htm)** The Subscription FHIR resource maps to the InteropTopicSubscription, InteropTopicSubscriptionDtl, InteropTopicSubcrParameter, and InteropTopicSubcrFilterobjects in Salesforce. - **[SubscriptionTopic](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/map_fhir_subscriptiontopic.htm)** The SubscriptionTopic FHIR resource maps to the InteropTopic, InteropTopicDetail, InteropTopicTriggerCriteria, InteropTopicFilterand InteropTopicNtfcnResourceobjects in Salesforce. - **[Timing](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Health Records (Managed Package)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_ehr.htm "Salesforce Health Cloud provides custom objects to store the data contained in the standard electronic health record (EHR) fields.") # Matched Template Representation Represents the specific parameters of a single matched Document AI template. ## Properties | Property Name | Type | Description | | --- | --- | --- | | id | String | The ID or developer name of the matched template. Returns a Salesforce record ID for custom templates or a developer name for standard templates. | | developerName | String | The unique developer name of the matched template. | # MatchingRecord Represents a potential existing record identified during Document AI matching or duplicate detection. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[MatchingRecord Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_match_properties.htm)** The following are properties for matchingRecord. # MatchingRecord Properties The following are properties for matchingRecord. - **[id](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_match_id.htm)** The unique identifier of the matched record in the system. # matchingRecords The list of potential matching records for this identified attribute during duplicate detection or matching. ## Signature public List matchingRecords {get; set;} ## Property Value Type: List # matchingRecords The list of potential matching records identified during duplicate detection or matching. ## Signature public List matchingRecords {get; set;} ## Property Value Type: List # matchingRuleConfigurations A list of duplicate detection rules associated with the entity\[cite: 18\]. ## Signature public List matchingRuleConfigurations {get; set;} ## Property Value Type: List # matchingRuleIdOrName The unique identifier or developer name of the matching rule to be used for duplicate detection. ## Signature public String matchingRuleIdOrName {get; set;} ## Property Value Type: String # Med Statement Input Payload Input representation of the request to create a patient’s medication statement. ## Root XML tag ## JSON example { "medicationStatement":{ "identifier":\[ { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "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", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" }, { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "type":{ "text":"Passport number1", "coding":\[ { "display":"Passport number", "code":"PPN", "isActive":true, "use":"Identifier" } \] }, "value":"ABCD5678B", "use":"Official", "periodStart":"1998-05-26T15:40:30.000Z", "periodEnd":"2021-08-09T15:40:30.000Z", "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" } \], "basedOn":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" } \], "partOf":\[ { "referenceResource":"MedicationStatement", "salesforceId":"0juRM00000000PzYAI", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM00000000Jz4AI", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" } \], "status":"active", "statusReason":\[ { "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" } \] } }, { "codeableConcept":{ "text":"Burn of Ear status reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"1234785607", "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" } \] } } \], "category":"Inpatient", "medication":{ "medicationReference":{ "referenceResource":"Medication", "referenceId":"", "salesforceId":"0itRM0000004CUkYAM", "relationship":"" } }, "context":{ "referenceResource":"Encounter", "referenceId":"", "salesforceId":"0kGRM0000004CWZ2A2", "relationship":"" }, "effectiveStartDateTime":"2012-07-26T15:40:30.000Z", "effectiveEndDateTime":"2012-07-27T15:40:30.000Z", "dateAsserted":"2012-07-26T15:40:30.000Z", "informationSource":{ "referenceResource":"Patient", "referenceId":"", "relationship":"", "salesforceId":"001RM000005EBfKYAW" }, "derivedFrom":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"ServiceRequest", "referenceId":"", "salesforceId":"0jyRM000000000aYAA", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationStatement", "referenceId":"", "salesforceId":"0juRM00000000TSYAY", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "reasonCode":\[ { "salesforceId":"0iPRM0000004CuR2AU" }, { "codeableConcept":{ "text":"Burn of Ear sdfstatus reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"12345dsn607", "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" } \] } } \], "reasonReference":\[ { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"Observation", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z", "dosage":\[ { "sequence":"10.0", "text":"commentsText", "additionalInstruction":"Additioanl Instructions", "patientInstruction":"Patient Instructions", "asNeeded":"true", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"61234567002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route", "coding":\[ { "display":"Burn of ear route", "code":"12344456700", "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":"12345637777", "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":"MGTttest", "description":"MG description", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" }, { "sequence":"100.0", "text":"commentsText2", "additionalInstruction":"Additioanl Instructions2", "patientInstruction":"Patient Instructions2", "asNeeded":"false", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345674002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345670032", "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 Method2", "coding":\[ { "display":"Burn of ear Method2", "code":"1234567777577", "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":"100", "dosageQuantityDenominator":"200", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTest23", "description":"MG description2", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"200", "dosageRateDenominator":"300", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTest24", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | medicationStatement | [FHIR Medication Statement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_fhir_medication_statemen.htm "Input representation for the Medication Statement FHIR object.") | Represents a record of a patient’s medication statement. | Required | 54.0 | # 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 | # Medicare Product List (POST) Gets Medicare products filtered and ranked by medication and provider associations. ## Resource /connect/health/digital-health-insurance/medicare/product-list ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "pageSize": 10, "offset": 0, "categoryId": "0ZGxx0000004C92GAE", "priceBookId": "01sxx0000005rZ3AAI", "medicationIds": \[ "2FIxx0000004CFUGA2" \], "providerIds": \[ "0cmxx0000000001AAA" \] } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | category​Id | String | CPQ catalog ID used to retrieve products. If not specified, products are retrieved from all catalogs. | Optional | | medication​Ids | String\[\] | List of FormularyItem or Medication IDs used to filter products by covered medications. | Optional | | offset | Integer | Zero-based offset for pagination. The default is 0. The first page starts at offset 0. | Optional | | page​Size | Integer | Number of products to return per page. The default is 20. The maximum is 100. | Optional | | price​Book​Id | String | Price book ID used to retrieve pricing information for products. | Optional | | provider​Ids | String\[\] | List of HealthcareProvider IDs used to filter products by network providers. | Optional | ## Response Body for POST [Medicare Product List Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_medicare_product_list_result.htm "The response representation containing ranked Medicare products that match the request filters.") # Medicare Product List Input The request payload containing medication and provider filters for the Medicare product list. ## JSON example { "pageSize": 10, "offset": 0, "categoryId": "0ZGxx0000004C92GAE", "priceBookId": "01sxx0000005rZ3AAI", "medicationIds": \[ "2FIxx0000004CFUGA2" \], "providerIds": \[ "0cmxx0000000001AAA" \] } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | category​Id | String | CPQ catalog ID used to retrieve products. If not specified, products are retrieved from all catalogs. | Optional | | medication​Ids | String\[\] | List of FormularyItem or Medication IDs used to filter products by covered medications. | Optional | | offset | Integer | Zero-based offset for pagination. The default is 0. The first page starts at offset 0. | Optional | | page​Size | Integer | Number of products to return per page. The default is 20. The maximum is 100. | Optional | | price​Book​Id | String | Price book ID used to retrieve pricing information for products. | Optional | | provider​Ids | String\[\] | List of HealthcareProvider IDs used to filter products by network providers. | Optional | # Medicare Product List Result The response representation containing ranked Medicare products that match the request filters. ## Properties | Property Name | Type | Description | | --- | --- | --- | | is​Success | Boolean | Indicates whether the request succeeded (true) or failed (false). | | message | String | Error or status message returned when isSuccess is false. | | offset | Integer | Zero-based offset of the first product on this page. | | page​Size | Integer | Number of products returned on this page. | | products | List | List of Medicare products sorted by match score, with the highest score first. | | total | Integer | Total number of products that match the request across all pages. | ## Medicare Product Medicare product enriched with medications and providers. | Property Name | Type | Description | | --- | --- | --- | | contri​bution​Cost​Attributes | List | Dynamic contribution cost attributes, such as premium cost, deductibles, and employer contribution. | | description | String | Product description. | | id | String | Product2 ID. | | match​Score | Integer | Ranking score based on matched medications and providers. Providers are weighted 2x. | | matched​Medication​Count | Integer | Count of input medications covered by this product. | | matched​Provider​Count | Integer | Count of input providers in this product's network. | | medication​Coverage​Details | List | Medication coverage details for all requested medications when a medicationIds filter is provided. Shows whether each medication is covered by this product. | | name | String | Product name. | | prices | List | Pricing information for this product. | | product​Code | String | Product code. | | providers | List | Associated healthcare providers that match the input criteria. | ## Attribute Name Value Attribute name and value for contribution cost or another product attribute. | Property Name | Type | Description | | --- | --- | --- | | name | String | Attribute name, such as Premium Cost, Deductibles, or Employer Contribution. | | value | String | Attribute value. | ## Medication Coverage Detail Medication coverage detail that indicates whether a requested medication is covered by the product. | Property Name | Type | Description | | --- | --- | --- | | formulary​Item​Id | String | FormularyItem ID requested by the user. | | id | String | PlanMedications record ID. Null if the medication isn't covered. | | is​Covered | Boolean | Indicates whether the medication is covered by this product (true) or not covered (false). | | medication​Id | String | Medication ID. Null if the medication isn't covered. | | name | String | Formulary item name. Null if the medication isn't covered. | ## Medicare Product Price Detail Pricing details for a Medicare product. | Property Name | Type | Description | | --- | --- | --- | | currency​Iso​Code | String | Currency ISO code for the price. | | is​Default | Boolean | Indicates whether this is the default price. | | is​Derived | Boolean | Indicates whether this price was derived. | | is​Selected | Boolean | Indicates whether this price is currently selected. | | price | Double | List price of the product. | | price​Book​Entry​Id | String | Price book entry ID. | | price​Book​Id | String | Price book ID. | | pricing​Model | MedicareProductPricingModelDetail | Pricing model details. | ## Medicare Product Pricing Model Detail Pricing model details. | Property Name | Type | Description | | --- | --- | --- | | id | String | Pricing model ID (ProductSellingModel ID). | | name | String | Pricing model name, such as One Time or Monthly. | | pricing​Model​Type | String | Pricing model type, such as OneTime, TermDefined, or Evergreen. | ## Healthcare Provider Detail Healthcare provider detail associated with a product. | Property Name | Type | Description | | --- | --- | --- | | healthcare​Provider​Id | String | HealthcareProvider ID. | | id | String | PlanHlthCareFacilityNtwrk record ID. | | name | String | Healthcare provider name. | | network​Id | String | Healthcare facility network ID. | | provider​Type | String | Provider type or specialty. | # 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 | - **[MedicinalIngredient](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_medicinalingredient.htm)** 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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_Medication.htm "Represents detailed information about different medications. This object is available in API version 51.0 and later.") # Medication for Pharmacy Benefits Verification Represents detailed information about different medications. Multiple features use this object. See [Medication](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_Medication.htm "Represents detailed information about different medications. This object is available in API version 51.0 and later."). # Medication Management The Medication Management data model provides objects to enable providers, care coordinators, and clinicians to perform a medication reconciliation and medication therapy review of their patients’ medication regimen. The data model provides objects for managing information on medication reconciliations, medication recommendations, and comprehensive and targeted medication reviews conducted for patients. ![Diagram showing the relationship between objects in the Medication Management data model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/healthcloud_medicationmgmt_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/medication-management.html "HTML (New Window)"). - **[ActionPlanTemplateAssignment for Medication Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_mm_objects_actionplantemplateassignment.htm)** Represents the association of an action plan template with its related care plan template, goal, or problem definition. - **[CarePlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careplan.htm)** Stores information about a care plan associated with a medication therapy review. Care plans are used to assign tasks to patients as part of medication therapy reviews. This object is available in API version 56.0 and later. - **[CarePlanActivity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careplanactivity.htm)** Represents a planned action that’s part of a care plan. For example, knowledge campaigns, physiotherapy appointments, medication regimens, etc. This object is a child object of CarePlan. This object is available in API version 56.0 and later. - **[CarePlanTemplate](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careplantemplate.htm)** Stores information about care plan template that’s used to define to-do lists for patients during medication therapy reviews. This object is available in API version 56.0 and later. - **[MedicationReconciliation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medicationreconciliation.htm)** Stores information about a medication reconciliation conducted for a patient This object is available in API version 54.0 and later. - **[MedicationTherapyReview](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medicationtherapyreview.htm)** Stores information about a medication therapy review conducted for a patient. This object is available in API version 56.0 and later. - **[MedicationTherapyStmtReview](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medicationtherapystmtreview.htm)** Represents a junction object between the Medication Therapy Review and Medication Statement objects. This object is available in API version 56.0 and later. - **[MedReconRecommendation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medreconrecommendation.htm)** Stores information about a medication recommendation and associates a recommendation to a medication reconciliation. This object is available in API version 54.0 and later. - **[MedReconStmtRecommendation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medreconstmtrecommendation.htm)** Associates a medication recommendation to a medication statement and medication reconciliation. This object is available in API version 54.0 and later. - **[MedTherapyStmtReviewIssue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_medtherapystmtreviewissue.htm)** Represents a junction object between the Medication Therapy Statement Review and Clinical Detected Issue objects. This object is available in API version 56.0 and later. # Medication Statement Output Output representation of the medication statement create request. ## JSON example { "code": "200", "errorCode": "", "errorMessage": "", "medicationStatementId": "0juRM00000000dDYAQ", "status": "Success" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | The code of the medication statement create request. | Big, 54.0 | 54.0 | | errorCode | String | The error code in case of failure. | Big, 54.0 | 54.0 | | errorMessage | String | The error message in case of failure. | Big, 54.0 | 54.0 | | medicationStatementId | String | The ID of the medication statement that is generated after the request is successful. | Big, 54.0 | 54.0 | | status | String | Indicates the status of the medication statement creation. | Big, 54.0 | 54.0 | # Medication Statement Update Output Output representation of medication statement update request. ## JSON example { "code": "201", "errorCode": "", "errorMessage": "", "medicationStatementId": "0juRM00000000dDYAQ", "status": "Success" } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | code | String | The code of the medication statement update request. | Big, 55.0 | 55.0 | | errorCode | String | The code in case of failure. | Big, 55.0 | 55.0 | | errorMessage | String | The error message in case of failure. | Big, 55.0 | 55.0 | | medicationStatementId | String | The ID of the medication statement that is updated. | Big, 55.0 | 55.0 | | status | String | Indicates the status of the medicated statement update request. | Big, 55.0 | 55.0 | # Medication Statements Use these resources to create a medication statement or update an existing medication statement for a patient. Medication statement represents a record of medication that the patient is currently taking or has taken in the past. Available resources are: | Resource | Description | | --- | --- | | [/connect/health/clinical/patients/${patientId}/medication-statement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_medication_statement.htm "Create medication statements for a patient.") | Create a medication statement for a patient. | | [/connect/health/clinical/patients/${patientId}/medication-statement/${medicationStatementId}](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_med_statement_update.htm "Update existing medication statements for a patient.") | Update an existing medication statement for a patient. | - **[Medication Statements (POST)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_medication_statement.htm)** Create medication statements for a patient. - **[Medication Statements (PUT)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_med_statement_update.htm)** Update existing medication statements for a patient. # Medication Statements (POST) Create medication statements for a patient. ## Resource /connect/health/clinical/patients/${patientId}/medication-statement ## Example Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org, and replace {XX.X} with the API version. https://{yourInstance.salesforce.com}/services/data/v{XX.X}/connect/ health/clinical/patients/001RM000005Il81YAC/medication-statement ## Available Version 54.0 ## Requires Chatter No ## HTTP Methods POST ## Root XML tag ## JSON example { "medicationStatement":{ "identifier":\[ { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "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", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" }, { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "type":{ "text":"Passport number1", "coding":\[ { "display":"Passport number", "code":"PPN", "isActive":true, "use":"Identifier" } \] }, "value":"ABCD5678B", "use":"Official", "periodStart":"1998-05-26T15:40:30.000Z", "periodEnd":"2021-08-09T15:40:30.000Z", "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" } \], "basedOn":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" } \], "partOf":\[ { "referenceResource":"MedicationStatement", "salesforceId":"0juRM00000000PzYAI", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM00000000Jz4AI", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" } \], "status":"active", "statusReason":\[ { "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" } \] } }, { "codeableConcept":{ "text":"Burn of Ear status reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"1234785607", "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" } \] } } \], "category":"Inpatient", "medication":{ "medicationReference":{ "referenceResource":"Medication", "referenceId":"", "salesforceId":"0itRM0000004CUkYAM", "relationship":"" } }, "context":{ "referenceResource":"Encounter", "referenceId":"", "salesforceId":"0kGRM0000004CWZ2A2", "relationship":"" }, "effectiveStartDateTime":"2012-07-26T15:40:30.000Z", "effectiveEndDateTime":"2012-07-27T15:40:30.000Z", "dateAsserted":"2012-07-26T15:40:30.000Z", "informationSource":{ "referenceResource":"Patient", "referenceId":"", "relationship":"", "salesforceId":"001RM000005EBfKYAW" }, "derivedFrom":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"ServiceRequest", "referenceId":"", "salesforceId":"0jyRM000000000aYAA", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationStatement", "referenceId":"", "salesforceId":"0juRM00000000TSYAY", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "reasonCode":\[ { "salesforceId":"0iPRM0000004CuR2AU" }, { "codeableConcept":{ "text":"Burn of Ear sdfstatus reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"12345dsn607", "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" } \] } } \], "reasonReference":\[ { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"Observation", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z", "dosage":\[ { "sequence":"10.0", "text":"commentsText", "additionalInstruction":"Additioanl Instructions", "patientInstruction":"Patient Instructions", "asNeeded":"true", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"61234567002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route", "coding":\[ { "display":"Burn of ear route", "code":"12344456700", "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":"12345637777", "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":"MGTttest", "description":"MG description", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" }, { "sequence":"100.0", "text":"commentsText2", "additionalInstruction":"Additioanl Instructions2", "patientInstruction":"Patient Instructions2", "asNeeded":"false", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345674002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345670032", "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 Method2", "coding":\[ { "display":"Burn of ear Method2", "code":"1234567777577", "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":"100", "dosageQuantityDenominator":"200", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTest23", "description":"MG description2", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"200", "dosageRateDenominator":"300", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTest24", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | medicationStatement | [FHIR Medication Statement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_fhir_medication_statemen.htm "Input representation for the Medication Statement FHIR object.") | Represents a record of a patient’s medication statement. | Required | 54.0 | ## Response Body for POST [Medication Statement Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_med_statement_output.htm "Output representation of the medication statement create request.") # Medication Statements (PUT) Update existing medication statements for a patient. ## Resource /connect/health/clinical/patients/${patientId}/medication-statement/${medicationStatementId} ## Example Replace {yourInstance.salesforce.com} with the My Domain host of your Salesforce org. https://{yourInstance.salesforce.com}/services/data/v55.0/connect/ health/clinical/patients/001RM000005PF3BYAW/medication-statement/0juRM00000000dDYAQ ## Available Version 55.0 ## Requires Chatter No ## HTTP Methods PUT ## Root XML tag ## JSON example { "medicationStatement":{ "identifier":\[ { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "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", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" }, { "assigner":{ "referenceResource":"Organization", "salesforceId":"001RM000005EBfKYAW" }, "type":{ "text":"Passport number1", "coding":\[ { "display":"Passport number", "code":"PPN", "isActive":true, "use":"Identifier" } \] }, "value":"ABCD5678B", "use":"Official", "periodStart":"1998-05-26T15:40:30.000Z", "periodEnd":"2021-08-09T15:40:30.000Z", "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z" } \], "basedOn":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" } \], "partOf":\[ { "referenceResource":"MedicationStatement", "salesforceId":"0juRM00000000PzYAI", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM00000000Jz4AI", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" } \], "status":"active", "statusReason":\[ { "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" } \] } }, { "codeableConcept":{ "text":"Burn of Ear status reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"1234785607", "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" } \] } } \], "category":"Inpatient", "medication":{ "medicationReference":{ "referenceResource":"Medication", "referenceId":"", "salesforceId":"0itRM0000004CUkYAM", "relationship":"" } }, "context":{ "referenceResource":"Encounter", "referenceId":"", "salesforceId":"0kGRM0000004CWZ2A2", "relationship":"" }, "effectiveStartDateTime":"2012-07-26T15:40:30.000Z", "effectiveEndDateTime":"2012-07-27T15:40:30.000Z", "dateAsserted":"2012-07-26T15:40:30.000Z", "informationSource":{ "referenceResource":"Patient", "referenceId":"", "relationship":"", "salesforceId":"001RM000005EBfKYAW" }, "derivedFrom":\[ { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"MedicationRequest", "referenceId":"", "salesforceId":"0kmRM0000004CHMYA2", "relationship":"" }, { "referenceResource":"Procedure", "referenceId":"", "salesforceId":"0jQRM0000004CNU2A2", "relationship":"" }, { "referenceResource":"ServiceRequest", "referenceId":"", "salesforceId":"0jyRM000000000aYAA", "relationship":"" }, { "referenceResource":"MedicationDispense", "referenceId":"", "salesforceId":"0NBRM0000004CGx4AM", "relationship":"" }, { "referenceResource":"MedicationStatement", "referenceId":"", "salesforceId":"0juRM00000000TSYAY", "relationship":"" }, { "referenceResource":"Observation", "referenceId":"", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "reasonCode":\[ { "salesforceId":"0iPRM0000004CuR2AU" }, { "codeableConcept":{ "text":"Burn of Ear sdfstatus reason", "coding":\[ { "display":"Burn of status reasonn ear", "code":"12345dsn607", "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" } \] } } \], "reasonReference":\[ { "referenceResource":"Condition", "salesforceId":"0j4RM0000004CJXYA2", "relationship":"" }, { "referenceResource":"Observation", "salesforceId":"0hIRM0000004CsM2AU", "relationship":"" }, { "referenceResource":"DiagnosticReport", "salesforceId":"0lQRM000000000k2AA", "relationship":"" } \], "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z", "dosage":\[ { "sequence":"10.0", "text":"commentsText", "additionalInstruction":"Additioanl Instructions", "patientInstruction":"Patient Instructions", "asNeeded":"true", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"61234567002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route", "coding":\[ { "display":"Burn of ear route", "code":"12344456700", "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":"12345637777", "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":"MGTttest", "description":"MG description", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"2", "dosageRateDenominator":"3", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTeste2", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" }, { "sequence":"100.0", "text":"commentsText2", "additionalInstruction":"Additioanl Instructions2", "patientInstruction":"Patient Instructions2", "asNeeded":"false", "site":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345674002", "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" } \] } }, "route":{ "codeableConcept":{ "text":"Burn of Ear route2", "coding":\[ { "display":"Burn of ear route2", "code":"12345670032", "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 Method2", "coding":\[ { "display":"Burn of ear Method2", "code":"1234567777577", "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":"100", "dosageQuantityDenominator":"200", "dosageUnit":{ "unitOfMeasure":{ "unitCode":"MGTest23", "description":"MG description2", "type":"Custom" } } }, "rate":{ "dosageRateType":"Frequency Ratio", "dosageRateNumerator":"200", "dosageRateDenominator":"300", "dosageRateUnit":{ "unitOfMeasure":{ "unitCode":"MGTest24", "description":"MG description2", "type":"Custom" } } } }, "sourceSystem":"http://sfdc.co", "sourceSystemId":"567890", "sourceSystemModified":"2012-07-26T15:40:30.000Z" } \] } } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | medicationStatement | [FHIR Medication Statement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_fhir_medication_statemen.htm "Input representation for the Medication Statement FHIR object.") | Represents a record of a patient’s medication statement. | Required | 54.0 | ## Response Body for PUT [Medication Statement Update Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_med_statement_update_output.htm "Output representation of medication statement update request.") # MedicationAdministration Represents an instance of medication administered to a patient. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() - **[MedicationAdministrationDtl](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_objects_medicationadministrationdtl.htm)** Represents the details of an instance of medication administered to a patient. This object is available in API version 64.0 and later. ## Fields ### ClinicalEncounterId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical encounter associated with the medication administration. This field is a relationship field. - **Relationship Name**: ClinicalEncounter - **Refers To**: ClinicalEncounter ### DeviceCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The device code set bundle associated with the medication administration, representing the device used during the administration. This field is a relationship field. - **Relationship Name**: DeviceCode - **Refers To**: CodeSetBundle ### EndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time when the administration occurred (or didn't occur). ### IsSubPotent - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the full dose wasn’t administered (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. ### MedicationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The medication associated with the medication administration. This field is a relationship field. - **Relationship Name**: Medication - **Refers To**: Medication ### MedicationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication request associated with the medication administration. This field is a relationship field. - **Relationship Name**: MedicationRequest - **Refers To**: MedicationRequest ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the medication administration. ### 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 ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient associated with the medication administration. This field is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### RecordedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the occurrence of the medication administration was first captured. ### StartDate - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date and time when the administration occurred (or didn't occur). ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the medication administration. - **Default value**: InProgress - **Possible values**: - Completed - EnteredInError - InProgress - NotAdministered - OnHold - Stopped - Unknown ### StatusReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status reason code set bundle associated with the medication administration indicating why the administration wasn’t performed. This field is a relationship field. - **Relationship Name**: StatusReasonCode - **Refers To**: CodeSetBundle ### SubPotentReasonId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sub potent reason code set bundle associated with the medication administration, representing the reason why the full dose wasn’t administered. This field is a relationship field. - **Relationship Name**: SubPotentReason - **Refers To**: CodeSetBundle ### TypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type code set bundle associated with the medication administration that indicates the type of medication administration. This field is a relationship field. - **Relationship Name**: Type - **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. [MedicationAdministrationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationAdministrationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationAdministrationOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationAdministrationShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedicationAdministrationDtl Represents the details of an instance of medication administered to a patient. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DetailCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References a code set or code set bundle that adds information to a medication administration record. This field is a relationship field. - **Relationship Name**: DetailCode - **Refers To**: CodeSet ### DetailRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References a record that adds information to a medication administration record. This field is a polymorphic relationship field. - **Relationship Name**: DetailRecord - **Refers To**: Account, CareObservation, CarePlan, DiagnosticSummary, HealthCondition, HealthcareProvider, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, PatientMedicalProcedure ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the relation between the medication administration and the medication administration detail record. - **Possible values**: - BasedOn - PartOf - PerformerDetail - ReasonReference ### 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. ### MedicationAdministrationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medication administration associated with the medication administration detail. This field is a relationship field. - **Relationship Name**: MedicationAdministration - **Relationship Type**: Master-detail - **Refers To**: MedicationAdministration (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. [MedicationAdministrationDtlChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationAdministrationDtlHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedicationReconciliation Stores information about a medication reconciliation conducted for a patient 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 ### ConductedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who started the medication reconciliation for the patient. This is a relationship field. - **Relationship Name**: ConductedBy - **Relationship Type**: Lookup - **Refers To**: User ### 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 medication reconciliation. ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient for whom the medication reconciliation is performed. This is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Master-Detail - **Refers To**: Account ### ProcessEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication reconciliation process for the patient was completed. ### ProcessStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication reconciliation process for the patient was started. ### 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 of the record in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The status of the medication reconciliation. - **Possible values**: - Cancelled - Completed - InProgress ## 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. [MedicationReconciliationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationReconciliationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationReconciliationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # MedicationRequest for Pharmacy Benefits Verification Represents a request or order for the supply of medication, along with information about how it should be administered. Multiple features use this object. See [MedicationRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 | - **[MedicationStatementDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_medicationstatementdetail.htm)** Represents additional information associated with MedicationStatement records. This object is available in API version 54.0 and later. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.") # MedicationStatement for Home Health Represents a record of medication that the patient is currently taking or has taken in the past. Multiple features use this object. See [MedicationStatement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedicationTherapyReview Stores information about a medication therapy review conducted for a patient. 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 ### CareProgramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care program associated with the medication therapy review. This field is a relationship field. - **Relationship Name**: CareProgram - **Relationship Type**: Lookup - **Refers To**: CareProgram ### ConductedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The user who started the medication therapy review for the patient. This field is a relationship field. - **Relationship Name**: ConductedBy - **Relationship Type**: Lookup - **Refers To**: User ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A description of the medication therapy review conducted for the patient. ### IsPatientInLtrmCareFacility - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the patient was at a long-term healthcare facility during the medication therapy review. - **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**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medication therapy review. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The ID of the user who owns the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PatientId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The patient on whom the medication therapy review is conducted. This field is a relationship field. - **Relationship Name**: Patient - **Relationship Type**: Master-Detail - **Refers To**: Account ### ReviewDueDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication therapy review is expected to complete. ### ReviewEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication therapy review is complete. ### ReviewStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the medication therapy review is initiated. ### ReviewSubtype - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: A further classification of the medication therapy review type. ### ReviewType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The type of medication therapy review conducted for the patient. - **Possible values**: - ComprehensiveMedicationReview - TargetedMedicationReview ### 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 of the record in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The current status of the medication therapy review. - **Possible values**: - Cancelled - Completed - InProgress - NotStarted ### SurrogateDecisionMakerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The authorized representative who attends the medication therapy review and makes health-care related decisions on behalf of a cognitively impaired patient. This field is a polymorphic relationship field. - **Relationship Name**: SurrogateDecisionMaker - **Relationship Type**: Lookup - **Refers To**: Account, Contact, HealthcareProvider, User ### SurrogateLocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The address of the surrogate decision maker where the comprehensive medication review document is delivered. This field is a polymorphic relationship field. - **Relationship Name**: SurrogateLocation - **Relationship Type**: Lookup - **Refers To**: Address, Location ### SurrogateType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The relationship between the surrogate decision maker and the patient. - **Possible values**: - Healthcare Proxy - Patient's Guardian of the Estate - Patient’s Child - Patient’s Friend - Patient’s Guardian - Patient’s Parent - Patient’s Relative - Patient’s Sibling - Patient’s Spouse ## 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. [MedicationTherapyReviewFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationTherapyReviewHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationTherapyReviewShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedicationTherapyStmtReview Represents a junction object between the Medication Therapy Review and Medication Statement objects. 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 ### Comment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information about the medication therapy review related to the medication statement. ### 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. ### MedicationStatementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The medication statement associated with the medication therapy statement review. This field is a relationship field. - **Relationship Name**: MedicationStatement - **Relationship Type**: Lookup - **Refers To**: MedicationStatement ### MedicationTherapyReviewId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medication therapy review associated with the medication therapy statement review. This field is a relationship field. - **Relationship Name**: MedicationTherapyReview - **Relationship Type**: Master-Detail - **Refers To**: MedicationTherapyReview ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medication therapy statement review. ### 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 of the record in its source system. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the medication therapy statement review. - **Possible values**: - Complete - Pending ## 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. [MedicationTherapyStmtReviewFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedicationTherapyStmtReviewHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedReconRecommendation Stores information about a medication recommendation and associates a recommendation to a medication reconciliation. 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 ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A description of the medication recommendation added to the patient. ### 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. ### MedicationReconciliationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medication reconciliation with which the medication recommendation is associated. This is a relationship field. - **Relationship Name**: MedicationReconciliation - **Relationship Type**: Lookup - **Refers To**: MedicationReconciliation ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the medication recommendation. ### NoteForPatient - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Recommendation notes to provide additional information to the patient. ### NoteForProvider - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Recommendation notes to provide additional information to the provider. ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority level of the medication recommendation. - **Possible values**: - High - Within 24 Hours - Low - Within a Month - Medium - Within 2 Weeks ### RecommendationReasonSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A further categorization of the recommendation reason type. - **Possible values**: - Allergy - Alternative Drug - Drug Side Effects - Suboptimal Drug ### RecommendationReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason why the recommendation is added to the patient. - **Possible values**: - Cost or Coverage - Health Condition ### RecommendationSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A further categorization of the recommendation type. - **Possible values**: - Change in Dosage - Change in Route - Discontinuation - Non-Adherence - Omission ### RecommendationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of medication recommendation added to the patient. - **Possible values**: - Adverse Drug Event - Care Gap - Discrepancy - Drug to Drug Interaction ### 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 of the record in its source 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. [MedReconRecommendationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedReconRecommendationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedReconRecommendationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedReconStmtRecommendation Associates a medication recommendation to a medication statement and medication reconciliation. 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 ### 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. ### MedReconRecommendationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication recommendation associated with the medication reconciliation and medication statement. This is a relationship field. - **Relationship Name**: MedReconRecommendation - **Relationship Type**: Lookup - **Refers To**: MedReconRecommendation ### MedicationReconciliationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medication reconciliation with which the medication recommendation is associated. This is a relationship field. - **Relationship Name**: MedicationReconciliation - **Relationship Type**: Lookup - **Refers To**: MedicationReconciliation ### MedicationStatementId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The medication statement with which the medication recommendation is associated. This is a relationship field. - **Relationship Name**: MedicationStatement - **Relationship Type**: Lookup - **Refers To**: MedicationStatement ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the medication recommendation. ### 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 of the record in its source 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. [MedReconStmtRecommendationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedReconStmtRecommendationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedReconStmtRecommendationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MedTherapyStmtReviewIssue Represents a junction object between the Medication Therapy Statement Review and Clinical Detected Issue objects. 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 ### ClinicalDetectedIssueId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The clinical detected issue associated with the medication therapy statement review. This field is a relationship field. - **Relationship Name**: ClinicalDetectedIssue - **Relationship Type**: Lookup - **Refers To**: ClinicalDetectedIssue ### 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. ### MedicationTherapyStmtReviewId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The medication therapy statement review associated with the clinical detected issue. This field is a relationship field. - **Relationship Name**: MedicationTherapyStmtReview - **Relationship Type**: Master-Detail - **Refers To**: MedicationTherapyStmtReview ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the medication therapy statement review issue record. ### 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 of the record in its source 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. [MedTherapyStmtReviewIssueFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MedTherapyStmtReviewIssueHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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. #### See Also - [_Salesforce Help_ : Set Up Person Accounts to Represent Health Cloud Members and Patients](https://help.salesforce.com/s/articleView?id=ind.admin_person_account_overview.htm&type=5&language=en_US) - [_Salesforce Help_: Person Accounts](https://help.salesforce.com/articleView?id=account_person.htm&language=en_US) - [_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: Account - HTML (New Window)") - [_Object Reference for the Salesforce Platform_: Contact](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_contact.htm "Object Reference for the Salesforce Platform: Contact - HTML (New Window)") # MemberPlan Represents details about the insurance coverage for a member or subscriber. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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() # MemberPlan Represents details about the insurance coverage for a member or subscriber. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MemberPlan for Pharmacy Benefits Verification Represents details about the insurance coverage for a member or subscriber. Multiple features use this object. See [MemberPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_memberplan.htm "Represents details about the insurance coverage for a member or subscriber."). # MemberPlanCarePlan Represents a junction between member plans and care plans. It defines the problems, goals, and interventions in a care plan based on the patient's health plan coverage. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### CarePlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The care plan associated with the member plan. This field is a relationship field. - **Relationship Name**: CarePlan - **Refers To**: CarePlan ### 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. ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent member plan associated with the care plan. This field is a relationship field. - **Relationship Name**: MemberPlan - **Relationship Type**: Master-detail - **Refers To**: MemberPlan (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The 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. [MemberPlanCarePlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MemberPlanCarePlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MemberPlanCarePlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MemberPlanMedicationStmt Represents a junction between member plans and medication statements. It associates the medications that a patient is currently taking or has taken in the past with their health plan coverage. This object is available in API version 66.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 this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The most recent date on which a user viewed this record. ### MedicationStatementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The medication statement associated with the member plan. This field is a relationship field. - **Relationship Name**: MedicationStatement - **Refers To**: MedicationStatement ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent member plan associated with the medication statement. This field is a relationship field. - **Relationship Name**: MemberPlan - **Relationship Type**: Master-detail - **Refers To**: MemberPlan (the master object) ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The 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. [MemberPlanMedicationStmtChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MemberPlanMedicationStmtFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [MemberPlanMedicationStmtHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # MessageTemplate\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Message\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Limit: 255 characters. # Metadata Types The following list links to Health Cloud metadata types. - [CareBenefitVerifySettings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_carebenefitverifysettings.htm) Represents the configuration settings for benefit verification requests. - [CareLimitType](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_carelimittype.htm) Defines the characteristics of limits on benefit provision. - [CareProviderSearchConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_careprovidersearchconfig.htm) Represents the information about the fields that appear in care provider search results. This type extends the Metadata metadata type and inherits its fullName field. - [CareRequestConfiguration](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_carerequestconfiguration.htm) 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. - [CareSystemFieldMapping](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_caresystemfieldmapping.htm) Represents a mapping from source system fields to Salesforce objects and fields. This type extends the Metadata metadata type and inherits its fullName field. - [DocumentExtractionDef](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/meta_documentextractiondef.htm "Represents the metadata definition used to manage and execute document data extraction processes.") Represents the metadata definition used to manage and execute document data extraction processes. - [Icon](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/fsc_meta_icon.htm "Represents the mapping of custom icons to objects.") Represents the mapping of custom icons to objects. - [IdentityVerificationProcDef](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_identityverificationprocdef.htm) Represents the definition of the identity verification process. - [IdentityVerificationProcDtl](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_identityverificationprocdtl.htm) Represents the search functionality configuration and the minimum number of optional verifiers for identity verification. This type extends the Metadata metadata type and inherits its fullName field. - [IdentityVerificationProcFld](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_identityverificationprocfld.htm) Represents the search and verification fields used in identity verification. This type extends the Metadata metadata type and inherits its fullName field. - [IndustriesSettings](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/meta_industriessettings.htm "Represents settings for Health Cloud.This type extends the Metadata metadata type and inherits its fullName field.") Represents settings for Health Cloud.This type extends the Metadata metadata type and inherits its fullName field. - [ScoreCategory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/meta_scorecategory.htm "Represents the category and subcategories that form a unified health profile in the Unified Health Scoring feature.") Represents the category and subcategories that form a unified health profile in the Unified Health Scoring feature. - [TimelineObjectDefinition](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_timelineobjectdefinition.htm) Represents the container that stores the details of a timeline configuration. You can use this resource with Salesforce objects to see their records' related events in a linear time-sorted view. - [Translations](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_translations.htm) Metadata type that enables work with translations for various supported languages. The ability to translate component labels is part of the Translation Workbench. - [UIObjectRelationConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_uiobjectrelationconfig.htm) Represents the admin-created configuration of the object relation UI component. - [VirtualVisitConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_virtualvisitconfig.htm) Represents an external video provider configuration, which relays events from Salesforce to the provider. # MoiAppConfig\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AutomaticHouseholdNaming\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ### HouseholdNameFormat\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Limit: 255 characters. ### PageLayoutApiVersion\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Limit: 255 characters. # MuleSoft Direct Integrations Use the Salesforce integration apps that are out-of-the-box integration templates with pre-built transformations that can be used to integrate Health Cloud with external systems. These integration apps are available in MuleSoft Exchange. To learn more, see the [MuleSoft Direct Integrations Apps](https://developer.salesforce.com/docs/industries/health/guide/integrations.html "HTML (New Window)") guide. # Node Represents a structured entity node in Document AI processing, containing object details, extracted attributes, and potential matching record information. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[Node Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_properties.htm)** The following are properties for node. # Node Properties The following are properties for node. - **[attributes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_attributes.htm)** The list of extracted field attributes associated with this node. - **[isExistingRecord](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_isExistingRecord.htm)** Indicates whether the node corresponds to an existing record in the system. - **[matchingRecords](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_matchingRecords.htm)** The list of potential matching records identified during duplicate detection or matching. - **[nodeName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_nodeName.htm)** The title of the context node to identify this node within the extraction context. - **[objectApiName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_objectApiName.htm)** The API name of the Salesforce object represented by this node. - **[referenceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_node_referenceId.htm)** A unique reference identifier used to correlate the node within the processing request. # nodeMatchingResolutionStrategy The resolution strategy applied when matching extracted document entities at the node level. ## Signature public String nodeMatchingResolutionStrategy {get; set;} ## Property Value Type: String # nodeName The title of the context node to identify this node within the extraction context. ## Signature public String nodeName {get; set;} ## Property Value Type: String # objectApiName The API name of the entity (object) on which duplicate detection should be executed. ## Signature public String objectApiName {get; set;} ## Property Value Type: String # objectApiName The API name of the Salesforce object represented by this node. ## Signature public String objectApiName {get; set;} ## Property Value Type: String # objectApiName The API name of the entity associated with the Document AI configuration. ## Signature public String objectApiName {get; set;} ## Property Value Type: String # objectConfig Specifies the resolution strategy applied when handling record matches during processing. ## Signature public List objectConfig {get; set;} ## Property Value Type: List # ObjectConfig A configuration wrapper class for Document AI operations. This class defines the resolution strategies used when matching extracted document entities, specifically providing configuration for both node-level and field-level matching. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[ObjectConfig Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_obj_config_properties.htm)** The following are properties for objectConfig. - **[fieldMatchingResolutionStrategy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_obj_config_fieldMatchingResolutionStrategy.htm)** The resolution strategy applied when matching extracted document entities at the field level. - **[nodeMatchingResolutionStrategy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_obj_config_nodeMatchingResolutionStrategy.htm)** The resolution strategy applied when matching extracted document entities at the node level. - **[objectApiName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_obj_config_objectApiName.htm)** The API name of the entity associated with the Document AI configuration. # ObjectConfig Properties The following are properties for objectConfig. # objectName The API name of the object to which the record belongs. ## Signature public String objectName {get; set;} ## Property Value Type: String # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. #### See Also - [CareObservation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_CareObservation.htm "Represents the observed values for care metrics originating from external systems that contain biometric data. This object is available in API version 49.0 and later.") - [CareObservationComponent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_CareObservationComponent.htm "Represents information about a component of a care observation. This object is available in API version 51.0 and later.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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
# OcrDocumentScanResult Represents the contents of a document after optical character recognition (OCR) processing. 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 ### ContentVersionId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Unique identifier for the current version of the data. ### DocumentRequestId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Unique identifier for a document request. ### ExtractedValues - **Type**: textarea - **Properties**: Nillable - **Description**: Data extracted from the document. Data type StringPlusClob, maximum length 131072. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note This field is encryptable with Salesforce Platform Encryption. ### 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 record. ### OcrService - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Records the service that performed the text extraction. - **Possible values**: - AMAZON\_TEXTRACT—Amazon Textract - E.AI ### OcrStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Current phase of OCR processing. - **Possible values**: - ERROR—Error - OCR\_ENQUEUE—OCR Enqueue - SUCCESS—Success ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The user who owns the OcrDocumentScanResult record. ### PageNumber - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: The page number of the scanned document result in the original document that it’s a part of. ### Rotation - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Degrees of rotation requested. Can be 0, 90, 180, or 270. ## 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. [OcrDocumentScanResultChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # OpportunityProductCategory Represents the junction between an Opportunity and the specific Medicare product categories the beneficiary has authorized for discussion. Each record represents one Medicare Part (e.g., Part A, Part C, Part D) included in the scope. 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 ### CategoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the Product Category record representing the Medicare Part authorized for discussion, such as, Part A, Part C, Part D. - **Referenced Objects**: - ProductCategory ### 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 system-generated name of the opportunity product category. ### OpportunityId - **Type**: Master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent Opportunity Scope for this product category. - **Referenced Objects**: - Opportunity ### 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 ## 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. [OpportunityProductCategoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [OpportunityProductCategoryFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [OpportunityProductCategoryHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [OpportunityProductCategoryOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [OpportunityProductCategoryShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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
# OrderSource Represents the source details of an order. This object captures the point of origin for an order and the subsequent action, ensuring full traceability for audit purposes and operational visibility across any organizational process. 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() ## Special Access Rules Users must have the Manage Pricing and Billing permission set. ## Fields ### CareServiceVisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care service visit that’s associated with the work order. This field is a relationship field. - **Relationship Name**: CareServiceVisit - **Refers To**: CareServiceVisit ### Comment - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The comments associated with the order. ### 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 name of the record. ### OrderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The ID of the order associated with the source. This field is a relationship field. - **Relationship Name**: Order - **Relationship Type**: Master-detail - **Refers To**: Order (the master object) ### ReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The business reason for creating the order from the specified source. ### SourceReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the reference record used as the source for the order. This field is a polymorphic relationship field. - **Relationship Name**: SourceReferenceRecord - **Refers To**: WorkOrder ### WorkOrderId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the work order associated with the order. This field is a relationship field. - **Relationship Name**: WorkOrder - **Refers To**: WorkOrder ## 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. [OrderSourceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [OrderSourceShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # parentReferenceId The reference identifier of the parent node associated with this attribute. ## Signature public String parentReferenceId {get; set;} ## Property Value Type: String # Parse Conversation Response Action Parses the JSON response from the Parse Conversation Inquiries prompt template from a contact center conversation transcript into a conversation summary, a resolution status, extracted inquiries, and an inquiry count. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/parseConversationResponse 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
promptResponse String Required

The raw JSON response generated by the Parse Conversation Inquiries prompt template from a contact center conversation transcript.
## Outputs | Output | Type | Description | | --- | --- | --- | | conversationSummary | String | An overall summary of the contact center conversation. | | inquiryCount | Integer | The number of inquiries extracted from the conversation. | | isConversationResolved | Boolean | Indicates whether the entire conversation was resolved (true) or not (false). | | parsedInquiries | List | The inquiries extracted from the conversation, each with a subject, description, and resolved flag. Loop over this collection to create a case for each inquiry. | ## Example **Sample Request** { "inputs": \[ { "promptResponse": "{"conversationSummary": "Customer called about a billing question and a schedule change request.", "resolved": false, "inquiries": \[{"subject": "Billing Question", "description": "Customer disputed a charge on their last invoice.", "resolved": true}, {"subject": "Schedule Change", "description": "Customer requested to reschedule an upcoming appointment.", "resolved": false}\]}" } \] } **Sample Response** \[ { "conversationSummary": "Customer called about a billing question and a schedule change request.", "isConversationResolved": false, "parsedInquiries": \[ { "subject": "Billing Question", "description": "Customer disputed a charge on their last invoice.", "resolved": true }, { "subject": "Schedule Change", "description": "Customer requested to reschedule an upcoming appointment.", "resolved": false } \], "inquiryCount": 2 } \] # Parse Eligibility and Benefit Verification (EBV) FHIR Response Action Parses the first FHIR coverage eligibility response call and creates coverage benefit records. This action is categorized under Health Cloud and is used to process raw FHIR JSON data from a patient eligibility and benefits verification request. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/parseEbvFhirResponse 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
careBenefitVerifyRequestId ID Required

The ID of the care benefit verify request.
jsonResponse String Required

The raw JSON response from the first FHIR request call to verify patient eligibility and benefits.
memberPlanId ID Required

The ID of the member plan to link the coverage benefit to.
## Outputs | Output | Type | Description | | --- | --- | --- | | | | | | coverageBenefitId | ID | The ID of the coverage benefit record that was created. | | errorMessage | String | The error details if parsing and record creation failed. | | isCoverageActive | Boolean | Indicates whether insurance coverage is currently active (true) or not (false). | | isSuccess | Boolean | Indicates whether parsing and record creation was successful (true) or not (false). | ## Example This sample request is for the Parse Eligibility and Benefit Verification (EBV) FHIR Response action { "inputs": \[ { "memberPlanId": "0p0xx0000004C92GAE", "careBenefitVerifyRequestId": "0kdxx0000004C92GAE", "jsonResponse": "{"resourceType": "Bundle", "id": "coverage-eligibility-response-example", ...}" } \] } This sample response is for the Parse Eligibility and Benefit Verification (EBV) FHIR Response action \[ { "isSuccess": true, "errorMessage": null, "coverageBenefitId": "0jfxx0000004C92GAE", "isCoverageActive": true } \] # Parse Eligibility and Benefit Verification (EBV) Response Action Parses the Call 2 (isPriorAuthRequired) JSON response from the eligibility and benefits clearinghouse and extracts the taskId to use for callback correlation. This action is categorized under Health Cloud and is used to process the response from the second call in the eligibility and benefits verification process, specifically extracting the correlation ID for asynchronous callbacks. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/parseEbvResponse 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
httpStatusCode Integer The HTTP status code from the callout. Non-2xx codes are treated as failures. Defaults to 200 if not provided.
responseBody String Required

The raw JSON response body from the Call 2 (isPriorAuthRequired) clearinghouse callout.
## Outputs | Output | Type | Description | | --- | --- | --- | | taskId | String | The Infinitus task UUID that's extracted from the response and used for callback correlation. | ## Example Sample Request { "inputs": \[ { "responseBody": "{"taskId": "550e8400-e29b-41d4-a716-44665544xx00", "status": "processing"}", "httpStatusCode": 200 } \] } Sample Response \[ { "taskId": "550e8400-e29b-41d4-a716-44665544xx00" } \] # 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
To learn more, see [Participant Management for Life Sciences Cloud](https://developer.salesforce.com/docs/atlas.en-us.264.0.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_participant_management_data_model.htm). # PartyAppointmentRequest Represents an appointment request raised by a patient for their home healthcare services. 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 ### AdditionalNotes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The additional notes such as comments from the party or the recurrence pattern of appointments associated with the appointment request. This field is available in API version 63.0 and later. ### AppointmentRecurrencePattern - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The recurrence pattern of the appointment that's associated with the appointment request. This field is available in API version 62.0 and later. ### AppointmentReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to an existing appointment that's associated with either a Reschedule or Cancel appointment request. This field is a polymorphic relationship field. - **Relationship Name**: AppointmentReference - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment ### AppointmentType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of appointment that's associated with the appointment request. This field is available in API version 62.0 and later. - **Default value**: StartOfCare - **Possible values**: - Recurring - StartOfCare ### ClinicalServiceRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The clinical service request that's associated with the appointment request. This field is a relationship field. - **Relationship Name**: ClinicalServiceRequest - **Refers To**: ClinicalServiceRequest This field is available in API version 62.0 and later. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date of the requested appointment. ### 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 name of the record. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The operating hours of the appointment that's associated with the appointment request. This field is a relationship field. - **Relationship Name**: OperatingHours - **Refers To**: OperatingHours This field is available in API version 62.0 and later. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the patient for whom the appointment request is created. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Relationship Type**: Lookup - **Refers To**: Account ### QuoteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The quote that's associated with the appointment request. This field is a relationship field. - **Relationship Name**: Quote - **Refers To**: Quote This field is available in API version 62.0 and later. ### RecurringAppointmentCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The count of recurring appointments associated with the appointment request. This field is available in API version 63.0 and later. ### RelatedRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The related appointment request for a dependent home visit. This field is a relationship field. - **Relationship Name**: RelatedRequest - **Refers To**: PartyAppointmentRequest This field is available in API version 62.0 and later. ### RequestType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of appointment request. - **Default value**: Schedule - **Possible values**: - Cancel - Reschedule - Schedule ### RequestedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the user who raised the appointment request on behalf of another user. This field is a polymorphic relationship field. - **Relationship Name**: RequestedBy - **Relationship Type**: Lookup - **Refers To**: Account ### ServiceContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the service of the requested appointment. This field is a polymorphic relationship field. - **Relationship Name**: ServiceContext - **Relationship Type**: Lookup - **Refers To**: WorkType ### ServiceLocation - **Type**: address - **Properties**: Filter, Nillable - **Description**: Specifies the service location of the requested appointment. ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The service territory of the appointment that's associated with the appointment request. This field is a relationship field. - **Relationship Name**: ServiceTerritory - **Refers To**: ServiceTerritory This field is available in API version 62.0 and later. ### SourceReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The referral or opportunity that's the source of the appointment request. This field is a polymorphic relationship field. - **Relationship Name**: SourceReferenceRecord - **Refers To**: Opportunity This field is available in API version 62.0 and later. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date of the requested appointment. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the status of the appointment request. - **Default value**: Submitted - **Possible values**: - Approved - Rejected - Submitted ### StatusReason - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The reason for the appointment request. ### StatusReasonType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the reason type for the status of the appointment request. ### UsageType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the feature that the created record is applicable for. - **Default value**: HomeHealth - **Possible values**: - HomeHealth ## 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. [PartyAppointmentRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PartyAppointmentRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PartyAppointmentRequestShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PartyProfile Represents additional details related to a patient. This object is available in Health Cloud in API version 61.0 and later. For more information related to the fields that are not used for Health Cloud, see [Financial Services Cloud Developer Guide: PartyProfile](https://developer.salesforce.com/docs/atlas.en-us.264.0.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyprofile.htm). ## 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 patient’s account record. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### BusLicIssAuthorityName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityCtryofInc - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityCtryofRgstr - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityIncDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityIncNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityPreviousNames - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityRgstrDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityRgstrNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityTradeName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### BusinessEntityType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### CountryOfDomicile - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### CountryofBirth - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### CreditScore - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### CreditScoreProvider - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### DateOfBirth - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### EmploymentIndustry - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### EmploymentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### FirstName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### FullName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### FundSource - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Not used for Health Cloud use cases. ### Gender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### HouseholdAccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. This field is a relationship field. - **Relationship Name**: HouseholdAccount - **Relationship Type**: Lookup - **Refers To**: Account ### Industry - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### IndustryClassificationCode - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### IsAged - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient is a senior citizen. - **Default value**: false ### IsBusEntyListonStockExch - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Not used for Health Cloud use cases. - **Default value**: false ### IsDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the person has a disability. - **Default value**: false ### IsInstitutionalized - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the person receives care at a care facility. - **Default value**: false ### IsLowIncome - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient is part of a low-income household. - **Default value**: false ### IsMedicaidEligible - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient is eligible for Medicaid assistance. - **Default value**: false ### IsNetWorthHigh - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Not used for Health Cloud use cases. - **Default value**: false ### IsOffBoarded - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Not used for Health Cloud use cases. - **Default value**: false ### IsRecalculationRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient’s risk adjust value needs recalculation. - **Default value**: false ### LastName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### LastProfileReviewDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### 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. ### LeadId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. This field is a relationship field. - **Relationship Name**: Lead - **Relationship Type**: Lookup - **Refers To**: Lead ### LegalEntityIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### MiddleName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the record. ### Nationality - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### NextProfileReviewDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### OffBoardingComments - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### OffBoardingReason - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Prefix - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### PrimaryEmail - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### PrimaryIdentificationName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### PrimaryIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### PrimaryIdentifierType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### PrimaryPhone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### RelatedPartyProfileId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. This field is a relationship field. - **Relationship Name**: RelatedPartyProfile - **Relationship Type**: Lookup - **Refers To**: PartyProfile ### ResidentType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### ReviewDecision - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### Stage - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### StockExchangeName - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Not used for Health Cloud use cases. ### Suffix - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### SurnameAtBirth - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### TaxpayerIdentificationNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Not used for Health Cloud use cases. ### TaxpayerIdentificationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Not used for Health Cloud use cases. - **Possible values**: - Business - Individual # PartySchedulePreference Represents the schedule preference that a patient has for their home healthcare visit. 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 ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time until when the patient is available or unavailable for their home visit. ### 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 name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PartyId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The ID of the patient whose schedule preference is recorded. This field is a polymorphic relationship field. - **Relationship Name**: Party - **Relationship Type**: Lookup - **Refers To**: Account ### Reason - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The reason for the schedule preference. ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time from when the patient is available or unavailable for their home visit. ### Type - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The type of schedule preference. - **Default value**: Available - **Possible values**: - Available - Unavailable ## 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. [PartySchedulePreferenceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PartySchedulePreferenceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PartySchedulePreferenceShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PASClaim The PASClaim FHIR resource maps to the CareDiagnosis, CareRequest, CareRequestDrug, CareRequestItem, CareRequestReviewer, and Identifier obejcts. ## FHIR V4.0 - Utilization Management Data Model Mapping Here’s how the fields defined by FHIR for [PASClaim](https://build.fhir.org/ig/HL7/davinci-pas/StructureDefinition-profile-claim.html) map to the fields in Salesforce. Table 1. PASClaim - Salesforce | PASCLAIM element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | identifier | Identifier | Object | 0.M | The identifier information for a PAS claim is represented as Identifier records that reference the CareRequestItem and CareRequestDrug record using their Identifier​.Parent​RecordId field. | | related | CareRequest. ReferenceCareRequestCase | Lookup: Case | 0.1 | N/A | | diagnosis | CareDiagnosis | Object | 0.M | N/A | | item.requestType | CareRequestItem.RequestType | Picklist | 0.1 | N/A | | item.productOrService | CareRequestItem.ProcedureCodeSetId | Lookup: Code Set | N/A | N/A | | item.modifier | CareRequestItem.Modifier | String | 0.1 | N/A | | item.servicedPeriod | CareRequestItem.RequestedServiceStartDate | Date | 0.1 | Since Salesforce doesn’t natively support the period data type, item.servicedPeriod is flattened into a set of rquested service start date and requested service end date fields. | | item.servicedPeriod | CareRequestItem.RequestedServiceEndDate | Date​ | 0.1 | Since Salesforce doesn’t natively support the period data type, item.servicedPeriod is flattened into a set of rquested service start date and requested service end date fields. | | item.extension-itemPreAuthIssueDate | CareRequestItem.DecisionDate | Date | 0.1 | N/A | | item.location\[x\]:locationCodeableConcept | CareRequestItem.ServicingFacility | Look​up: Servicing Facility | 0.1 | While FHIR defines item.location\[x\]:locationCodeableConcept as a codeable concept, the Salesforce implementation is a lookup to the Servicing Facility object. | | Item.extension-requestedService.ServiceRequest.performer | CareRequestItem.ServicingProvider | Lookup: Healthcare Provider | 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. | | item.extension-requestedService.ServiceRequest.identifier | CareRequestItem.Identifier | Object | 0.M | N/A | | item.extension-requestedService.ServiceRequest.category | CareRequestItem.ServiceCategoryCode | String | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.status | CareRequestItem.Status | Picklist | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.priority | CareRequestItem.Priority | Picklist | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.code | CareRequestItem.ProcedureCodesetId | Lookup: Code Set | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.quantity\[x\] | CareRequestItem.Quantity | Number | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.quantity\[x\] | CareRequestItem.UnitOfMeasure | Lookup: Unit of Measure | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.occurrence\[x\] | CareRequestItem.RequestedServiceStartDate | Date | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.occurrence\[x\] | CareRequestItem.RequestedServiceEndDate | Date | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.authoredOn | CareRequestItem.DecisionDate | Date | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.reasonCode | CareRequestItem.ReasonCode | Lookup: Code Set | 0.1 | N/A | | item.extension-requestedService.ServiceRequest.note | CareRequestReviewer | Object | 0.M | N/A | | item.extension-authorizationNumber | CareRequestDrug.AuthApprovalIdentifier | String | 0.1 | N/A | | item.extension-administrationReferenceNumber | CareRequestDrug.AuthorizationReIdentifier | String | 0.1 | N/A | | item.location\[x\]:locationCodeableConcept | CareRequestDrug.ServicingFacility | Lookup: Servicing Facility | 0.1 | N/A | | Item.extension-requestedService.ServiceRequest.performer | CareRequestDrug.ServicingProvider | Lookup: Healthcare Provider | 0.1 | N/A | | MedicationRequest.Identifier | Identifier | Object | 0.M | N/A | | MedicationRequest.status | CareRequestDrug.Status | Picklist | 0.1 | N/A | | MedicationRequest.statusReason | CareRequestDrug.StatusReason | Picklist | 0.1 | N/A | | MedicationRequest.intent | CareRequestDrug.RequestType | Picklist | 0.1 | N/A | | MedicationRequest.category | CareRequestDrug.DrugAdministrationSetting | String | 0.1 | N/A | | MedicationRequest.priority | CareRequestDrug.Priority | Picklist | 0.1 | N/A | | MedicationRequest.medication\[x\] | CareRequestDrug.MedicationRefObjectId | Lookup: Medication Request | 0.1 | N/A | | MedicationRequest.authoredOn | CareRequestDrug.PrescriptionDate | Date | 0.1 | N/A | | MedicationRequest.reasonCode | CareRequestDrug.CinicalDeterminationReasonId | Lookup: Code est | 0.1 | N/A | # PASClaimResponse The PASClaimResponse FHIR resource maps to the CareProcessingError, AuthorNote, TrackedCommunication, andTrackedCommunicationDetailobjects. ## FHIR V4.0 - Utilization Management Data Model Mapping Here’s how the fields defined by FHIR for [PASClaimResponse](https://build.fhir.org/ig/HL7/davinci-pas/StructureDefinition-profile-claimresponse.html) map to the fields in Salesforce. Table 1. PASClaimResponse - Salesforce | PASCLAIMRESPONSE element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | ProcessNote | AuthorNote | Object | 0.M | N/A | | processNote.text | AuthorNote.NoteText | Text Area | 0.1 | N/A | | error | CareProcessingError | Object | 0.M | N/A | | error.code | CareProcessingError.ErrorCodeId | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | | error.followUpAction | CareProcessingError.ActionCodeId | Lookup: Code Set, Code Set Bundle | 0.1 | N/A | | CommunicationRequest | TrackedCommunication | Object | 0.M | N/A | | CommunicationRequest | TrackedCommunicationDetail | Object | 0.M | N/A | # PASMetricData The PASMetricData FHIR resource maps to the CareRequestExchangeInfo object. ## FHIR V4.0 - Utilization Management Model Mapping Here’s how the fields defined by FHIR for [PASMetricData](https://build.fhir.org/ig/HL7/davinci-pas/StructureDefinition-PASMetricData.html) map to the fields in Salesforce. Table 1. PASMetricData - Salesforce | PASMetricdata element | Salesforce Field | Type | Salesforce Cardinality | Notes | | --- | --- | --- | --- | --- | | exchange | CareRequestExchangeInfo | Object | 1.M | N/A | | exchange.type | CareRequestExchangeInfo.ExchangeType | Picklist | 1.1 | N/A | | exchange.with | CareRequestExchangeInfo.ExchangeTargetType | Picklist | 0.1 | N/A | | exchange.method | CareRequestExchangeInfo.ExchangeMode | Picklist | 1.1 | N/A | | exchange.requestTime | CareRequestExchangeInfo.RequestDateTime | DateTime | 1.1 | N/A | | exchange.responseTime | CareRequestExchangeInfo.ResponseDateTime | DateTime | 0.1 | N/A | | exchange.httpResponse | CareRequestExchangeInfo.ResponseStatusCode | Integer | 0.1 | N/A | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Foundation 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_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**. - **[CareProgram for Patient Program Outcome Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_ppom_objects_careprogram.htm)** 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. - **[CareProgramEnrollee for Patient Program Outcome Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_ppom_objects_careprogramenrollee.htm)** Represents a participant enrolled in a care program. - **[IndicatorAssignment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_indicatorassignment.htm)** 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. - **[IndicatorDefinition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_indicatordefinition.htm)** 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. - **[IndicatorPerformancePeriod](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_indicatorperformanceperiod.htm)** 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. - **[IndicatorResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_indicatorresult.htm)** 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. - **[Outcome](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_outcome.htm)** 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. - **[OutcomeActivity](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_outcomeactivity.htm)** 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. - **[PartyIndicatorResult](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_partyindicatorresult.htm)** Represents information about a party for which the indicator result is calculated. This object is available in API version 62.0 and later. - **[TimePeriod](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_timeperiod.htm)** Represents the time period that's used to calculate the indicator performance and result. This object is available in API version 59.0 and later. # Patient Segmentation The Patient Segmentation data model helps the Patient Segmentation dashboard generate insights into patient demographics and risk scores based on risk adjustment factors. - **[AgeBandHlthRskAdjFctr](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_agebandhlthrskadjfctr.htm)** Stores the risk adjustment factor for patients and members based on the age band that they’re a part of and the status of their benefits eligibility. This object is available in API version 61.0 and later. - **[CondIntrctnHlthRskAdjFctr](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_condintrctnhlthrskadjfctr.htm)** Stores the risk adjustment factor for patients and members based on the set of interacting conditions they are diagnosed with and the status of their benefits eligibility. This object is available in API version 61.0 and later. - **[HierCondHlthCodeMapping](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_hiercondhlthcodemapping.htm)** Represents how Hierarchical Condition Category (HCC) codes map to condition codes for a specific year. This object is available in API version 61.0 and later. - **[HierCondHlthRskAdjFctr](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_hiercondhlthrskadjfctr.htm)** Stores the risk adjustment factor for patients and members based on the set of Hierarchical Condition Category (HCC) codes that apply to them and the status of their benefits eligibility. This object is available in API version 61.0 and later. - **[PartyProfile](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_partyprofile.htm)** Represents additional details related to a patient. This object is available in Health Cloud in API version 61.0 and later. - **[PgmBasedHlthRskAdjFctr](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_pgmbasedhlthrskadjfctr.htm)** Stores the risk adjustment factor for patients and members based on their eligibility for certain benefits programs. For instance, Medicaid in the US. This object is available in API version 61.0 and later. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | - **[PatientImmunizationProtocol](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_patientimmunizationprotocol.htm)** 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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | - **[PatientMedicalProcedureDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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). #### See Also - [_Object Reference for the Salesforce Platform_: Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.health_cloud_object_reference.meta/health_cloud_object_reference/health_account_custom_fields.htm) - [Fields on Account](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/health_account_custom_fields.htm "Health Cloud fields extend the standard Account object to represent information about patients and providers.") # 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 | # PercentileBsdCareFeeAgreement Specifies the payment terms for contracts of Percentile Based Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BracketInformation - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The description of the percentile bracket information. ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this percentile based care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### FifthBracketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price for the procedure if the member falls into the fifth percentile bracket based on the factor considered by the payer. ### FirstBracketPrice - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The price for the procedure if the member falls into the first percentile bracket based on the factor considered by the payer. ### FourthBracketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price for the procedure if the member falls into the fourth percentile bracket based on the factor considered by the payer. ### 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 percentile based care fee agreement. ### ProcedureCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the procedure code. ### ProcedureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The industry standard code for the procedure such as CPT or HCPCS. This is a relationship field. - **Relationship Name**: ProcedureCode - **Relationship Type**: Lookup - **Refers To**: CodeSetBundle ### RelativeValueUnit - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The relative value unit for the procedure. ### SecondBracketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price for the procedure if the member falls into the second percentile bracket based on the factor considered by the payer. ### StandardPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The standard price for the procedure defined by the governing body. ### ThirdBracketPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The price for the procedure if the member falls into the third percentile bracket based on the factor considered by the payer. ## 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. [PercentileBsdCareFeeAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PercentileBsdCareFeeAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PercentileBsdCareFeeAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PersonLanguage Represents the use and preference information about a person’s language. This object is available in API version 51.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_important.png) #### Important Where possible, we have changed noninclusive terms to align with our company value of Equality. We’ve 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 ### IndividualId - **Type**: Polymorphic master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: The person who speaks the language. - **Referenced Objects**: - Person Account - Account - Contact ### Language - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the language spoken by the person. - **Possible values**: - English - Spanish ### 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**: A system-generated name for the PersonLanguage record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. Available in API version 56.0 and later. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Rank - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The preference rank for a particular language for a particular person. ### SpeakingProficiencyLevel - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the person’s speaking proficiency level. Available in API version 56.0 and later. - **Default value**: Fluent - **Possible values**: - Beginner - Intermediate - Fluent ### WritingProficiencyLevel - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Nillable, Update - **Description**: Specifies the person’s writing proficiency level. Available in API version 56.0 and later. - **Default value**: Novice - **Possible values**: - Novice - Intermediate - Advanced - Superior - Distinguished ## Usage PersonLanguage is a data type-like object that’s associated to different objects representing people. The language a person speaks is associated to that person by referencing their account, contact, or person account records using the IndividualId field on PersonLanguage. ## 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. [PersonLanguageOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonLanguageShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonLanguageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PersonName Represents detailed information about a person’s name. This object is available in API version 51.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ### EffectiveDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the name is in effect. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the name is no longer in use. ### FirstName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The first name of the person. ### FullName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The combination of the first and last names of the person. ### IsPrimary - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the name is the person’s primary name. ### LastName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The person’s last name. In case the person’s name has more than just a first name and a last name, this field stores the combination of all names except the first name. ### 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 PersonName record. ### NameUsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the usage context of the name. - **Possible values**: - Anonymous - Maiden - Nickname - Official - Old - Temp - Usual ### OwnerId - **Type**: Reference - **Properties**: Create, Defaulted on Create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Referenced Objects**: - User - Group ### ParentRecordId - **Type**: Polymorphic master-detail reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the person the name belongs to. - **Referenced Objects**: - Account - Contact ### Prefix - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The prefix of the person’s name. ### SourceSystem - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The source system from where the PersonName record was brought into Health Cloud. ### SourceSystemIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The identifier of the person name record in its source system. ### SourceSystemModified - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the person name record was last modified in its source system. ### Suffix - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The suffix of the person’s name. ## Usage PersonName is a data type-like object that’s associated to different objects representing people. The names and name-related information of a person are associated to them by referencing their account, contact, or person account records using the ParentRecordId field on PersonName. ## 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. [PersonNameFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonNameHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonNameOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonNameShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PersonNameChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. ## Additional information ◊ # PgmBasedHlthRskAdjFctr Stores the risk adjustment factor for patients and members based on their eligibility for certain benefits programs. For instance, Medicaid in the US. 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 ### CmnyFullBnftDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### CmnyPartialBenefitDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CmnyPartialBnftDualDsbl - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has partial benefits from both Medicare and Medicaid, and is enrolled in Medicare because of a disability. ### Community - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home. ### CommunityFullBnftDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, has full benefits from both Medicare and Medicaid, and is enrolled in Medicare because of their age. ### CommunityNonDualAged - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of their age. ### CommunityNonDualDisabled - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at home, is covered only by Medicare, and is enrolled in Medicare because of a disability. ### Gender - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the gender of the patient. ### Institutional - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the risk adjustment factor for a patient who lives at a healthcare facility. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the risk adjustment factors defined in the record are active. - **Default value**: false ### IsDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the patient has a disability. - **Default value**: false ### IsOriginallyDisabled - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that patient was originally disabled. - **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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The system-generated name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record in the system. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ProgramType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of program that the risk adjustment factors are defined for. ### PublishedYear - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The year when the risk adjustment factors were published. # 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 healthcare 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 Health Cloud
The pharmacy benefits verification objects are available to users with the Health Cloud Foundation 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/hc_pharmacy_benefits_verification_erd.png) To view a larger version, right-click or control-click the image and select **Open Image in New Tab**. - **[CareBenefitVerifyRequest for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_carebenefitverifyrequest.htm)** Request for verification of benefits. - **[CareProgram for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_careprogram.htm)** 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. - **[CareProgramEnrollee for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_careprogramenrollee.htm)** Represents a participant enrolled in a care program. - **[CareProgramProduct for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_careprogramproduct.htm)** Represents the affiliation between a care program and a care program product, care program provider, or both. - **[CoverageBenefit for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_coveragebenefit.htm)** Represents the benefits provided to a covered member by a purchaser’s plan. - **[CoverageBenefitItem for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_coveragebenefititem.htm)** Represents a service covered by the insurance plan. - **[CoverageBenefitItemLimit for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_coveragebenefititemlimit.htm)** Represents expenditures, limits, coverage levels, eligibility, and exclusions for a specific benefit. - **[HealthcareProvider for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_healthcareprovider.htm)** Represents business-level details about the healthcare organization or the practitioner. - **[Medication for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_medication.htm)** Represents detailed information about different medications. - **[MedicationRequest for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_medicationrequest.htm)** Represents a request or order for the supply of medication, along with information about how it should be administered. - **[MemberPlan for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_memberplan.htm)** Represents details about the insurance coverage for a member or subscriber. - **[PurchaserPlan for Pharmacy Benefits Verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_pbv_objects_purchaserplan.htm)** Represents the payer plan that a purchaser makes available to its members and members’ dependents. - **[UnitOfMeasure](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_unitofmeasure.htm)** Represents the unit of measures for care metrics and care observations. This object is available in API version 49.0 and later. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PlanBenefit for Home Health Represents the standard benefits available under a plan that the purchaser offers to their members. Multiple features use this object. See [PlanBenefit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_planbenefit.htm "Represents the standard benefits available under a plan that the purchaser offers to their members."). # PlanBenefitItem Represents the details of a benefit available under a purchaser’s plan that is offered to their members. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 for Home Health Represents the details of a benefit available under a purchaser’s plan that is offered to their members. Multiple features use this object. See [PlanBenefitItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_planbenefititem.htm "Represents the details of a benefit available under a purchaser’s plan that is offered to their members."). # PortalProfileName\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: The portal profile name. Limit: 255 characters. ### Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: # Post Save Operations (POST) Launches downstream notification alerts and validation calculations against saved objects. ## Resource /connect/document-ai-automation/actions/post-save ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "templateIdentifier": "InvoiceTemplate", "savedRecords": \[ { "id": "a1x5g000000ABC123", "objectName": "Invoice\_\_c", "referenceId": "INV\_1" } \] } ## Properties | Property​ Name | Type | Des​cription | Required | | --- | --- | --- | --- | | template​Iden​tifier | String | The identification lookup mapping template tracking string. | Required | | saved​Records | Object | The summary target collection listing successfully inserted record objects reference IDs. | Required | ## Response Body for POST [Post Save Operations](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_post_save_output.htm "The response representation containing subsequent processing workflow responses.") # Post Save Operations Input The properties context containing identities for newly initialized record objects. ## JSON example { "templateIdentifier": "InvoiceTemplate", "savedRecords": \[ { "id": "a1x5g000000ABC123", "objectName": "Invoice\_\_c", "referenceId": "INV\_1" } \] } ## Properties | Property​ Name | Type | Des​cription | Required | | --- | --- | --- | --- | | template​Iden​tifier | String | The identification lookup mapping template tracking string. | Required | | saved​Records | Object | The summary target collection listing successfully inserted record objects reference IDs. | Required | # Post Save Output The response representation containing subsequent processing workflow responses. ## Properties | Property Name | Type | Description | | --- | --- | --- | | version | String | The configuration model schema identity value. | | isSuccess | Boolean | Indicates if subsequent flow rules finished executing without error. | | data | String | Optional customized context metrics string tracking custom action processing results. | | errors | List​ | A detailed layout array itemizing follow-up flow process failures. | # Post Transform Data Processing (POST) Synchronously runs custom post-processing layout adjustments on transformed hierarchical models. ## Resource /connect/document-ai-automation/actions/post-transform ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "templateIdentifier": "a1x5g000000ABC123", "extractedData": { "version": "V1", "data": "{"Invoice":\[{"referenceId":"INV\_1","InvoiceNumber":{"value":"INV-001","confidenceScore":0.95}}\]}", "errors": null } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | templateIdentifier | String | The tracked processing identification lookup string. | Required | | extractedData | Object | Extracted data in ExtractServiceOutputModel format. | Required | ## Response Body for POST [Post Transform Data Processing](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_transform_extracted_data_output.htm "The status outcome tracking structural hierarchical objects ready for downstream staging.") # Post Transform Data Processing Input The validation request properties matching the initial structural outputs derived during mapping transformations. ## JSON example { "templateIdentifier": "a1x5g000000ABC123", "extractedData": { "version": "V1", "data": "{"Invoice":\[{"referenceId":"INV\_1","InvoiceNumber":{"value":"INV-001","confidenceScore":0.95}}\]}", "errors": null } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | templateIdentifier | String | The tracked processing identification lookup string. | Required | | extractedData | Object | Extracted data in ExtractServiceOutputModel format. | Required | # PostSaveInput Represents the input payload for the Document AI post-save process, containing version information and saved record details. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[PostSaveInput Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_input_properties.htm)** The following are properties for postSaveInput. # PostSaveInput Properties The following are properties for postSaveInput. - **[data](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_post_save_input_data.htm)** The list of records that were saved and are passed for post-save processing. # PostSaveResult Represents the output returned from the Document AI post-save process, including status and error details. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[PostSaveResult Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_result_properties.htm)** The following are properties for postSaveResult. - **[data](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_result_data.htm)** The response data returned after post-save processing. - **[isSuccess](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_result_isSuccess.htm)** Indicates whether the post-save process completed successfully. - **[version](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_result_version.htm)** The version identifier of the post-save output format. - **[errors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_ps_result_errors.htm)** The list of errors encountered during post-save processing, if any. # PostSaveResult Properties The following are properties for postSaveResult. # PostTransformInput Represents the input payload provided to the Document AI post-transform process. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[PostTransformInput Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_input_properties.htm)** The following are properties for postTransformInput. # PostTransformInput Properties The following are properties for postTransformInput. - **[version](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_input_version.htm)** The version identifier of the post-transform payload format. - **[data](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_input_data.htm)** The list of extracted document nodes to be processed during post-transformation. # PostTransformResult Represents the output returned from the Document AI post-transform process. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[PostTransformResult Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_properties.htm)** The following are properties for postTransformResult. # PostTransformResult Properties The following are properties for postTransformResult. - **[version](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_version.htm)** The version identifier of the post-transform payload format. - **[data](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_data.htm)** The list of extracted document nodes to be processed during post-transformation. - **[extractionMetadata](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_extractionMetadata.htm)** Additional contextual information generated during post-transformation. - **[isSuccess](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_isSuccess.htm)** Indicates whether the post-transform process completed successfully. - **[errors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_pt_result_errors.htm)** The list of errors encountered during post-transformation, if any. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_practitioner.png) # Practitioner Availability at Facilities To book an appointment, we need to know the availability of a given practitioner at a given facility. To get this information, Health Cloud queries the specific source EHR system, using the IDs of the practitioner and the facility as stored in that source system. ## Practitioner and Facility IDs - The source system ID comes from the Healthcare Practitioner Facility record for the practitioner+facility combination. - The source system facility ID comes from an Identifier record that looks up to the Contact record for the practitioner, with the same source system as the Healthcare Practitioner Facility record. - The source system facility ID comes from an Identifier record that looks up to the Account record for the facility, with the same source system as the Healthcare Practitioner Facility record. Booking an appointment against a facility alone, such as an X-Ray, lab work, or dialysis, is not supported. A practitioner must be defined for the facility, even if it is a placeholder. ![Practitioner+Facility Data Model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/practitioner_facility_model.png) ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note What's the difference between an ID and an Identifier? - An Identifier is a record type that represents real-world identifying information about a facility or practitioner, such as dates of validity, jurisdiction, and the issuing authority. - An ID is a machine-generated foreign key that identifies a record in a remote EHR system. ## Appointment Type and Service Type The source system requires Appointment Type and Service Type codes that are derived from the “visit type” (Work Type record) selected by the call center agent. These codes are configured via Work Type Code Set Bundle records, one per Work Type, with lookups to Code Set Bundle and Code Sets for the Service Type and Appointment Type codes in each Source System the org integrates with. ![Appointment Type and Service Type Data Model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/appointment_service_type_model.png) Appointments booked by the call center agent result in a Service Appointment record being created along with a Healthcare Practitioner Facility Appointment junction between the Service Appointment and Healthcare Practitioner Facility. The Service Appointment status field is set to Booked upon record creation. ![Appointment Data Model](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/appointment_model.png) #### See Also - [Provider Network Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_pnm_data_model.htm "Provider Network Management allows health insurance companies to bring providers into their network and helps members or patients find care that fits their needs. It provides objects for managing provider networks and contract payment agreement terms.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_practitionerrole.png) # Predecessors to Code Sets and Code Set Bundles in Health Cloud Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead.

Available in: Lightning Experience

Available in: Enterprise and Unlimited Editions with Health Cloud
The Code Set and Code Set Bundle objects improve on the old objects by adding support for terminology system information. This added support comes in the form of the Source System and Version fields. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note Objects, flows, and apps that previously used Healthcare Diagnosis and Healthcare Procedure have been or will be extended to support the use of Code Set and Code Set Bundle. Healthcare Diagnosis and Healthcare Procedure are to be gradually phased out with future releases. - [HealthCareDiagnosis](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_healthcarediagnosis.htm) Represents information related to industry-standard healthcare diagnosis codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. - [HealthCareProcedure](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/sforce_api_objects_healthcareprocedure.htm) Represents information related to industry-standard healthcare procedure codes. Before the Spring ’21 release, the Healthcare Procedure and Healthcare Diagnosis objects stored codes specifically related to procedures and diagnoses. These codes were used for prior-authorization requests and approval processes. Since the Spring’21 release, Health Cloud uses the Code Set and Code Set Bundle objects for this purpose instead. # PreventiveCareAgreement Specifies the payment terms for contracts of Preventive Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## 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**: Additional information on the bonus payout and target expectation. ### BonusMeasureDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the bonus measure type. ### BonusMeasureType - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The measure type used to define the bonus payout such as Preventive Readmission Rate and Preventive Admission Rate. ### BonusPayout - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: The bonus paid on reaching the target measure percentage. ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this preventive care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### CurrentMeasurePercent - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The current percentage of the specified measure. ### 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 preventive care fee agreement. ### TargetMeasurePercent - **Type**: percent - **Properties**: Create, Filter, Sort, Update - **Description**: The expected percentage of the specified measure. ## 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. [PreventiveCareAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PreventiveCareAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PreventiveCareAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Previous Assessment Responses Input The request representation to fetch past assessment responses for both Discovery Framework and MCG assessments. ## Properties | Property Name | Type | Description | Required | Available Version | | --- | --- | --- | --- | --- | | assessment​Statuses | String\[\] | The list of assessment statuses used to filter assessments, such as In Progress or Completed. | Yes | 66.0 | | assessment​Type | String | The type of assessment to retrieve. Valid values are DiscoveryFramework and MCG. | Yes | 66.0 | | contextId | String | The ID of the Account, Case, or Clinical Service Request context record associated with the assessment. | Yes | 66.0 | | question​Identifiers | String\[\] | The list of assessment question identifiers to retrieve. Use question developer names for internal assessments and question names for MCG assessments. | Yes | 66.0 | # Previous Assessment Responses Output The list of historical question responses retrieved for the specified assessment. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | previous​Assessment​Responses | [Question Response Output\[\]](connect_responses_question_response_output.htm "Contains the response values and assessment metadata for a single question.") | A list of previous question responses that were retrieved. | Small, 66.0 | 66.0 | # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PricingAttribute Class Represents the attribute key, attribute value, and a boolean indicating if the attribute is a picklist type for a product. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[attributeDefinitionId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_PricingAttribute.htm#apex_healthcloudext_PricingAttribute_attributeDefinitionId)** Represents the unique identifier of the Attribute Definition for the Product. - **[attributeValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_PricingAttribute.htm#apex_healthcloudext_PricingAttribute_attributeValue)** Represents the value of the attribute definition that needs to be considered for pricing, if the attribute is of type Picklist then the attribute value should be a unique identifier of the Attribute Picklist Value. - **[isAttributeDefinitionDataTypePicklist](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_PricingAttribute.htm#apex_healthcloudext_PricingAttribute_isAttributeDefinitionDataTypePicklist)** Represents if the attribute definition is of type Picklist. ## attributeDefinitionId Represents the unique identifier of the Attribute Definition for the Product. ### Signature global String attributeDefinitionId { get; set; } ### Property Value Type: String ## attributeValue Represents the value of the attribute definition that needs to be considered for pricing, if the attribute is of type Picklist then the attribute value should be a unique identifier of the Attribute Picklist Value. ### Signature global String attributeValue { get; set; } ### Property Value Type: String ## isAttributeDefinitionDataTypePicklist Represents if the attribute definition is of type Picklist. ### Signature global Boolean isAttributeDefinitionDataTypePicklist { get; set; } ### Property Value Type: Boolean # ProblemDefinition The definition of a care plan problem in the reusable PGI library that’s a part of Integrated Care Management. When instantiated, ProblemDefinition records create HealthCondition records that serve as problems in care plans. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BarrierTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The care barrier type associated with the problem. This field is a relationship field. - **Relationship Name**: BarrierType - **Relationship Type**: Lookup - **Refers to**: CareBarrierType ### Category - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category that the defined problem belongs to. - **Possible values**: - Encounter Diagnosis - Problem List Item ### CodeId - **Type**: Polymorphic lookup - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system-defined code that defines the problem. This field is a polymorphic relationship field. - **Relationship Name**: Code - **Relationship Type**: Lookup - **Refers To**: - CodeSet - CodeSetBundle ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description for the problem definition. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the problem definition is active or not. - **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. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Priority - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The priority of the defined problem. - **Possible values**: - High - Low - Normal ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Indicates the type of problem record instantiated from definition. - **Possible values**: - barrier — Barrier - careGap — Care Gap - healthCondition — Health Condition ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of problem definition. ![Note](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note.png) #### Note This field is only available if Disease Surveillance is enabled in your org. - **Possible values**: - infectiousDisease ## 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. [ProblemDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemDefinitionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ProblemDefRelationship Represents a junction between a problem definition and a related problem definition. This object is available in API version 64.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. ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent problem definition record associated with the problem definition relationship. This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Master-detail - **Refers To**: ProblemDefinition (the master object) ### RelatedProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The related problem definition record associated with the problem definition relationship. This field is a relationship field. - **Relationship Name**: RelatedProblemDefinition - **Refers To**: ProblemDefinition ## 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. [ProblemDefRelationshipChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemDefRelationshipHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ProblemGoalDefinition A junction object that associated a goal definition to its parent problem definition. These junction records assist in establishing the problem-goal hierarchy in care plans instantiated from the PGI library. A problem definition can have multiple goal definitions as its children, and a goal definition can have multiple problem definitions as its parents. This object is available in API version 57.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### GoalDefinitionId - **Type**: Lookup - **Properties**: Create, Filter, Group, Sort, Update - **Description**: References the GoalDefinition record that’s associated to a parent ProblemDefinition record. This field is a relationship field. - **Relationship Name**: GoalDefinition - **Relationship Type**: Lookup - **Refers To**: GoalDefinition ### 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 name of the record. ### OwnerId - **Type**: Polymorphic lookup - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: - Group - User ### ProblemDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: References the ProblemDefinition record that’s associated to a child GoalDefinition record. This field is a relationship field. - **Relationship Name**: ProblemDefinition - **Relationship Type**: Lookup - **Refers To**: ProblemDefinition ## 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. [ProblemGoalDefinitionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemGoalDefinitionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProblemGoalDefinitionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ​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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_procedure.png) #### See Also - [CarePerformer](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Definition Input Input representation of the verification process definition. ## Root XML tag ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | layoutType | String | Indicate whether the display layout of the search component is tab or stacked. | Optional | 54.0 | | processDetail | [Process Detail Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_process_detail_input.htm "Input representation of the verification process details.")\[\] | Represents the verification-related details. | Required | 54.0 | # Process Definition Output Represents the Identity Verification Process Definition record. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | layoutType | String | The search layout type. | Small, 54.0 | 54.0 | | processDetail | [Process Detail Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_process_detail_output.htm "Represents the Identity Verification Process Detail record.") | The API name of the Identity Verification Process Detail record. | Small, 54.0 | 54.0 | # Process Detail Input Input representation of the verification process details. ## Root XML tag ## Properties
Name Type Description Required or Optional Available Version
apexClassName String The Apex class that’s used to search and verify data in an external system.

Note: Reserved for future use.

 Optional 54.0
dataSourceType String The source type of the data.
Possible values are:
  • Salesforce
 Required 54.0
optionalVerifierCount Integer The number of optional verifiers that must be checked. Optional

Note: This field is required, if you specify optional verifiers.

 54.0
searchObjectName String The name of a Salesforce object or custom object on which the search is performed and data is verified. Required 54.0
searchResultFilter String A comma-separated list of predefined filter conditions that are used to refine the scope of the search. Optional 54.0
searchResultSortOrder String The values that are used to sort the search results. Optional 54.0
searchResultUniqueIdField String The field containing the unique identifier of a record displayed in the search results. Required 54.0
searchSequenceNo Integer The sequence in which the search is performed and the search result is displayed. Optional 54.0
searchType String The type of search being performed.
Possible values are:
  • Text-Based
 Required 54.0
verificationProcessFieldList Verification Process Field Input[] List of fields necessary to configure the questions that an administrator asks the caller before providing them the information they need. Required 54.0
# Process Detail Output Represents the Identity Verification Process Detail record.
Property Name Type Description Filter Group and Version Available Version
apexClassName String The Apex class name. Small, 54.0 54.0
dataSourceType String The data source type. Possible values are:
  • External

    In API version 54.0, an external data source type isn’t supported.

  • Salesforce
 Small, 54.0 54.0
optionalVerifierCount Integer The minimum number of optional verifiers that must be checked. Small, 54.0 54.0
searchObjectName String The API name of the object on which search is performed. Small, 54.0 54.0
searchResultFilter String The conditions used to filter search results. For example, if the search is to be performed only on person accounts, use isPerson = true. Small, 54.0 54.0
searchResultSortOrder String The values used to sort and order search results. For example, if you want to sort the results by policy date and arrange them in a descending order, use PolicyDate__c Desc Small, 54.0 54.0
searchResultUniqueIdField String The unique identifying field of the selected search result. Small, 54.0 54.0
searchSequenceNo Integer The search sequence number. Small, 54.0 54.0
searchType String Indicates whether the search is text-based or object-based.

Note: In API version 54.0, object-based search isn’t supported.

 Small, 54.0 54.0
verificationProcessFieldList Verification Process Field List Output List of verification process fields. Small, 54.0 54.0
# Process Received Document Action Create a record with the processed results of the specified received document. This action is available in API version 59.0 and later. ## Special Access Rules The Document Checklist and Intelligent Document Workspace permission set licenses are required to access the Process Received Document action. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/processReceivedDocument 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
additionalFields sObject Record containing the additional fields to create or update in the target object, which aren't present in the Intelligent Document Reader field mappings.
documentTypeId string ID of the document type record that’s used in the template with the Intelligent Document Reader field mappings to use to process the received document.
ignoreFieldValueConflict boolean Indicates whether to ignore conflicts in Optical Character Recognition (OCR) (true) or not (false). The default value is false.
objectApiName string API name of the target object to create or update a record for.
override​Confidence​Score​Threshold integer Conflict confidence score threshold value to use for the extracted value.
receivedDocumentId string Required.

ID of the received document record to process.
recordTypeId string ID of the record type of the target object to create a record for.
templateApiName string API name of the template with the Intelligent Document Reader field mappings to use to process the received document.
## Outputs | Output | Type | Description | | --- | --- | --- | | recordId | string | ID of the record created by the action. | ## Example **POST** Here’s a sample request for the Process Received Document action. { "inputs" : \[ { "receivedDocumentId" : "0ioRM00000002nPYAQ", "objectApiName" : "Demo\_\_c", "templateApiName" : "InsuranceCard", "recordTypeId" : "012RM0000005c7bYAA", "documentTypeId" : "0deRM00000000GnYAI" } \] } Here’s a sample response for the Process Received Document action. \[ { "actionName": "processReceivedDocument", "errors": null, "isSuccess": true, "outputValues": { "recordId": "a00RM000001DZ6ZYAW" } } \] # ProcessDefinition Class Contains the verification process definition, including the list of process details. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[ProcessDefinition Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_constructors)** - **[ProcessDefinition Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_properties)** ## ProcessDefinition Constructors The following are constructors for ProcessDefinition. - **[ProcessDefinition(layoutType, processDetail)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_ctor)** Creates an instance of the [ProcessDefinition](#apex_class_id_verification_ProcessDefinition "Contains the verification process definition, including the list of process details.") class with the specified parameter values. - **[ProcessDefinition()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_ctor_2)** Creates an instance of the [ProcessDefinition](#apex_class_id_verification_ProcessDefinition "Contains the verification process definition, including the list of process details.") class. ### ProcessDefinition(layoutType, processDetail) Creates an instance of the [ProcessDefinition](#apex_class_id_verification_ProcessDefinition "Contains the verification process definition, including the list of process details.") class with the specified parameter values. #### Signature public ProcessDefinition(String layoutType, List processDetail) #### Parameters layoutType Type: String Specifies the display layout of the search component is tab or stacked. processDetail Type: List<[id\_verification.ProcessDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_class_id_verification_ProcessDetail "Contains the verification process details.")\> Required. Represents the details of verification processes. ### ProcessDefinition() Creates an instance of the [ProcessDefinition](#apex_class_id_verification_ProcessDefinition "Contains the verification process definition, including the list of process details.") class. #### Signature public ProcessDefinition() ## ProcessDefinition Properties The following are properties for ProcessDefinition. - **[layoutType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_layoutType)** Specifies the display layout of the search component is tab or stacked. - **[processDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDefinition.htm#apex_id_verification_ProcessDefinition_processDetail)** Represents the details of verification processes. ### layoutType Specifies the display layout of the search component is tab or stacked. #### Signature public String layoutType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### processDetail Represents the details of verification processes. #### Signature public List processDetail {get; set;} #### Property Value Type: List<[id\_verification.ProcessDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_class_id_verification_ProcessDetail "Contains the verification process details.")\> # ProcessDetail Class Contains the verification process details. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[ProcessDetail Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_constructors)** - **[ProcessDetail Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_properties)** ## ProcessDetail Constructors The following are constructors for ProcessDetail. - **[ProcessDetail(dataSourceType, searchObjectName, searchSequenceNo, searchType, searchResultUniqueIdField, searchResultFilter, searchResultSortOrder, optionalVerifierCount, apexClassName, verificationProcessFieldList, linkedVerificationProcessDetailName, retryLimit, isRetryAllowedAfterLimit, label, developerName, displayRecordFieldName)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_ctor)** Creates an instance of the [ProcessDetail](#apex_class_id_verification_ProcessDetail "Contains the verification process details.") class with the specified parameter values. - **[ProcessDetail()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_ctor_2)** Creates an instance of the [ProcessDetail](#apex_class_id_verification_ProcessDetail "Contains the verification process details.") class. ### ProcessDetail(dataSourceType, searchObjectName, searchSequenceNo, searchType, searchResultUniqueIdField, searchResultFilter, searchResultSortOrder, optionalVerifierCount, apexClassName, verificationProcessFieldList, linkedVerificationProcessDetailName, retryLimit, isRetryAllowedAfterLimit, label, developerName, displayRecordFieldName) Creates an instance of the [ProcessDetail](#apex_class_id_verification_ProcessDetail "Contains the verification process details.") class with the specified parameter values. #### Signature public ProcessDetail(String dataSourceType, String searchObjectName, Integer searchSequenceNo, String searchType, String searchResultUniqueIdField, String searchResultFilter, String searchResultSortOrder, Integer optionalVerifierCount, String apexClassName, id\_verification.VerificationProcessFieldList verificationProcessFieldList, String linkedVerificationProcessDetailName, Integer retryLimit, Boolean isRetryAllowedAfterLimit, String label, String developerName, String displayRecordFieldName) #### Parameters dataSourceType Type: String Specifies the source type of the data. searchObjectName Type: String Specifies the API name of the object on which search is performed. searchSequenceNo Type: Integer Specifies the sequence in which the search is performed and the search result is displayed. searchType Type: String Specifies whether the search is text-based or object-based. searchResultUniqueIdField Type: String Specifies the unique idenfitying field of the selected search result. searchResultFilter Type: String Specifies the conditions used to filter search results. searchResultSortOrder Type: String Specifies the values used to sort search results. optionalVerifierCount Type: Integer Specifies the minimum number of optional verifiers that must be checked. apexClassName Type: String Specifies the apex class that’s used to search and verify data in an external system. verificationProcessFieldList Type: [id\_verification.VerificationProcessFieldList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationProcessFieldList.htm#apex_class_id_verification_VerificationProcessFieldList "Contains information about the list of fields used for both search and the verification process.") Specifies the list of verification process fields. linkedVerificationProcessDetailName Type: String Specifies the name of the process detail for secondary search. retryLimit Type: Integer Specifies the retry limit to verify process details. isRetryAllowedAfterLimit Type: Boolean Indicates whether retry is allowed after the retry limit (true) or not (false). The default value is false. label Type: String Specifies the label for the process detail. developerName Type: String Specifies the developer name for the process detail. displayRecordFieldName Type: String Specifies the name of the field that contains details about the record that's shown to the user after identity verification is successful. ### ProcessDetail() Creates an instance of the [ProcessDetail](#apex_class_id_verification_ProcessDetail "Contains the verification process details.") class. #### Signature public ProcessDetail() ## ProcessDetail Properties The following are properties for ProcessDetail. - **[apexClassName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_apexClassName)** Specifies the apex class that’s used to search and verify data in an external system. - **[dataSourceType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_dataSourceType)** Specifies the source type of the data. - **[developerName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_developerName)** Specifies the developer name for the process detail. - **[displayRecordFieldName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_displayRecordFieldName)** Specifies the name of the field that contains details about the record that's shown to the user after identity verification is successful. - **[isRetryAllowedAfterLimit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_isRetryAllowedAfterLimit)** Indicates whether retry is allowed after the retry limit (true) or not (false). The default value is false. - **[label](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_label)** Specifies the label for the process detail. - **[linkedVerificationProcessDetailName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_linkedVerificationProcessDetailName)** Specifies the name of the process detail for secondary search. - **[optionalVerifierCount](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_optionalVerifierCount)** Specifies the minimum number of optional verifiers that must be checked. - **[retryLimit](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_retryLimit)** Specifies the retry limit to verify process details. - **[searchObjectName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchObjectName)** Specifies the API name of the object on which search is performed. - **[searchResultFilter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchResultFilter)** Specifies the conditions used to filter search results. - **[searchResultSortOrder](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchResultSortOrder)** Specifies the values used to sort search results. - **[searchResultUniqueIdField](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchResultUniqueIdField)** Specifies the unique idenfitying field of the selected search result. - **[searchSequenceNo](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchSequenceNo)** Specifies the sequence in which the search is performed and the search result is displayed. - **[searchType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_searchType)** Specifies whether the search is text-based or object-based. - **[verificationProcessFieldList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_ProcessDetail.htm#apex_id_verification_ProcessDetail_verificationProcessFieldList)** Specifies the list of verification process fields. ### apexClassName Specifies the apex class that’s used to search and verify data in an external system. #### Signature public String apexClassName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### dataSourceType Specifies the source type of the data. Possible value is: - External - Internal #### Signature public String dataSourceType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### developerName Specifies the developer name for the process detail. #### Signature public String developerName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### displayRecordFieldName Specifies the name of the field that contains details about the record that's shown to the user after identity verification is successful. #### Signature public String displayRecordFieldName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### isRetryAllowedAfterLimit Indicates whether retry is allowed after the retry limit (true) or not (false). The default value is false. #### Signature public Boolean isRetryAllowedAfterLimit {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### label Specifies the label for the process detail. #### Signature public String label {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### linkedVerificationProcessDetailName Specifies the name of the process detail for secondary search. #### Signature public String linkedVerificationProcessDetailName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### optionalVerifierCount Specifies the minimum number of optional verifiers that must be checked. #### Signature public Integer optionalVerifierCount {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### retryLimit Specifies the retry limit to verify process details. #### Signature public Integer retryLimit {get; set;} #### Property Value Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_integer.htm) ### searchObjectName Specifies the API name of the object on which search is performed. #### Signature public String searchObjectName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### searchResultFilter Specifies the conditions used to filter search results. For example, if the search is to perform only in a person account, use isPerson = true. #### Signature public String searchResultFilter {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### searchResultSortOrder Specifies the values used to sort search results. For example, if you want to sort the results by policy date and arrange them in a descending order, use PolicyDate\_\_c Desc. #### Signature public String searchResultSortOrder {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### searchResultUniqueIdField Specifies the unique idenfitying field of the selected search result. #### Signature public String searchResultUniqueIdField {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### searchSequenceNo Specifies the sequence in which the search is performed and the search result is displayed. #### Signature public Integer searchSequenceNo {get; set;} #### Property Value Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_integer.htm) ### searchType Specifies whether the search is text-based or object-based. #### Signature public String searchType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### verificationProcessFieldList Specifies the list of verification process fields. #### Signature public id\_verification.VerificationProcessFieldList verificationProcessFieldList {get; set;} #### Property Value Type: [id\_verification.VerificationProcessFieldList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationProcessFieldList.htm#apex_class_id_verification_VerificationProcessFieldList "Contains information about the list of fields used for both search and the verification process.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ProductPricingAttributeDetails Class Represents details about a product's pricing attributes and their associated quantities. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[pricingAttributeList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_ProductPricingAttributeDetails.htm#apex_healthcloud_ProductPricingAttributeDetails_pricingAttributeList)** Represents the list of Pricing Attribute Apex Objects that are applicable for the Product. - **[productId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_ProductPricingAttributeDetails.htm#apex_healthcloud_ProductPricingAttributeDetails_productId)** Represents the unique identifier of the Product. - **[unitCount](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_ProductPricingAttributeDetails.htm#apex_healthcloud_ProductPricingAttributeDetails_unitCount)** Represents the count of the products for which the pricing attributes are applicable. ## pricingAttributeList Represents the list of Pricing Attribute Apex Objects that are applicable for the Product. ### Signature global List pricingAttributeList { get; set; } ### Property Value Type: List<> ## productId Represents the unique identifier of the Product. ### Signature global String productId { get; set; } ### Property Value Type: String ## unitCount Represents the count of the products for which the pricing attributes are applicable. ### Signature global Integer unitCount { get; set; } ### Property Value Type: Integer # ProductRequest Represents a device request made as part of a care program. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules 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 ### 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. ### 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 # ProductRequest Represents a device request made as part of a care program. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules 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 ### 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. ### 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 Network Management Provider Network Management allows health insurance companies to bring providers into their network and helps members or patients find care that fits their needs. It provides objects for managing provider networks and contract payment agreement terms.
Available in: Enterprise and Unlimited Editions
To use all the objects in Provider Network Management, you must have the Health Cloud Provider Network Management Add On license as well as the Health Cloud Platform license. Assign the Health Cloud Foundation permission set and the Provider Network Management permission set to your users. ## Provider Network Management ![Diagram showing the relationship between provider network contract objects](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/healthcloud_providernetworkcontractmgmt_erd.png) For more details and a larger image, visit the [Data Model Gallery](https://developer.salesforce.com/docs/platform/data-models/guide/provider-network-contract-management.html "HTML (New Window)"). - **[Access to Provider Network Management](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_provider_data_model_permissions.htm)** The provider network management standard objects are available to users with the Health Cloud Platform and Provider Network Management permission set licenses and the Health Foundation permission set. - **[ApplicationCase](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_applicationcase.htm)** This junction object stores a relationship between Case and IndividualApplication. This object is available in API version 52.0 and later with the Provider Network Management permission set license. - **[IndividualApplication](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_individualapplication_hc.htm)** Represents an application form submitted by an individual. Available with the Provider Network Management permission set license. - **[InsurancePolicy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_insurancepolicy.htm)** Represents a type of insurance policy. Available with the Provider Network Management permission set license. - **[BundledCareFeeAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_bundledcarefeeagreement.htm)** Specifies the payment terms for contracts of Bundled Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[CapitationCareFeeAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_capitationcarefeeagreement.htm)** Specifies the payment terms for contracts of Capitation Care Fee Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[CareFeeScheduleItem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carefeescheduleitem.htm)** Stores procedure level fees for a fee schedule definition. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[CaseRelatedFile](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caserelatedfile.htm)** Represents the details of a file attached to a case, such as file properties, file processing details, and other additional relevant information. This object is available in API version 62.0 and later. - **[CategorizedCareFeeAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_categorizedcarefeeagreement.htm)** Specifies the payment terms for contracts of Categorized Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[ContractPaymentAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_contractpaymentagreement.htm)** Stores information about the contract payment agreement associated with a contract. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[FeeScheduleDefinition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_feescheduledefinition.htm)** Stores fee schedule information for contracts of Standard Care Fee Agreement types. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[PercentileBsdCareFeeAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_percentilebsdcarefeeagreement.htm)** Specifies the payment terms for contracts of Percentile Based Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[ProviderNetworkContract](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_providernetworkcontract.htm)** Represents a provider and a network bound together by a contract. This object is available in API version 53.0 and later with the Provider Network Management permission set license. - **[ProviderNetworkTier](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_providernetworktier.htm)** Represents unique tiers for each provider network. This object is available in API version 53.0 and later with the Provider Network Management permission set license. - **[PreventiveCareAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_preventivecareagreement.htm)** Specifies the payment terms for contracts of Preventive Care Fee Agreement. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[SharedSavingPaymentAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_sharedsavingpaymentagreement.htm)** Specifies the payment terms for contracts of Shared Saving Payment Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. - **[StandardCareFeeAgreement](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_standardcarefeeagreement.htm)** Specifies the payment terms for contracts of Standard Care Fee Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. #### See Also - [Health Cloud Administrator Guide: Provider Network Management](https://help.salesforce.com/s/articleView?id=ind.landing_provider_network_mgmt.htm&type=5&language=en_US) # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. - **[Accreditation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_accreditation.htm)** Represents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute care hospital. - **[Award](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_award_hc.htm)** Represents a person's or organization's professional awards. - **[BoardCertification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_boardcertification.htm)** Represents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease. - **[BusinessLicense](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_businesslicense.htm)** Represents the licenses of a party role like healthcare provider or producer. - **[CareProviderAdverseAction](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprovideradverseaction.htm)** Captures adverse actions against the provider, such as malpractice lawsuits or revoked licences. This object is available in API version 47.0 and later. - **[CareProviderFacilitySpecialty](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careproviderfacilityspecialty.htm)** 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. - **[CareProviderSearchableField](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprovidersearchablefield.htm)** 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. - **[CareProviderSearchConfig](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careprovidersearchconfig.htm)** 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. - **[CareService](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careservice.htm)** 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. - **[CareSpecialty](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carespecialty.htm)** Represents a listing of provider specialty codes and descriptions. For example, 02 - Physician/General Surgery. - **[CareSpecialtyTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carespecialtytaxonomy.htm)** The junction object between CareSpecialty and CareTaxonomy. This object is available in API version 52.0 and later. - **[CareTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caretaxonomy.htm)** Represents a static list of taxonomy codes. - **[HealthcareFacilityNetwork](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcarefacilitynetwork.htm)** 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. - **[HealthcarePayerNetwork](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcarepayernetwork.htm)** Represents an insurance network group. For example, an insurance company’s exclusive provider organization (EPO) plans. - **[HealthcarePractitionerFacility](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcarepractitionerfacility.htm)** Represents the different locations in which a practitioner provides services. - **[HealthcareProvider](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareprovider.htm)** Represents business-level details about the healthcare organization or the practitioner. - **[HealthcareProviderNpi](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareprovidernpi.htm)** 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. - **[HealthcareProviderService](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareproviderservice.htm)** 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. - **[HealthcareProviderSpecialty](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareproviderspecialty.htm)** Represents specialties for a practitioner or a service provider organization. A provider can have multiple specialties such as anesthesiology and cardiovascular. - **[HealthcareProviderTaxonomy](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareprovidertaxonomy.htm)** Represents taxonomy or subspecialty codes for a practitioner or facility. A provider or facility can have multiple taxonomies. - **[HealthcareServiceDetail](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_healthcareservicedetail.htm)** 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. - **[HlthCareProvTreatedCondition](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_hlthcareprovtreatedcondition.htm)** 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. - **[PersonEducation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_personeducation.htm)** Represents information about professional education for a person in a provider role. - **[PersonEmployment](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_personemployment.htm)** Represents information about a person’s employment. - **[ProviderSearchSyncLog](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_providersearchsynclog.htm)** 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. # Provider Search Criteria Input Criteria used to search for healthcare providers. ## JSON Example { "providerSearchCriteria": { "providerName": "Jane Doe", "specialties": \[ "Pediatrics" \], "subSpecialties": \[ "Neonatology" \], "planTypes": \[ "HMO", "PPO" \], "acceptingNewPatients": true, "languagesSpoken": \[ "Spanish" \], "providerGender": "Female", "licenseJurisdictionState": "CA", "nationalProviderIdentifier": "1234567890", "providerType": "MD" } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | providerName | String | The name of the healthcare provider. | Optional | | specialties | Array of Strings | A list of the provider's medical specialties. | Optional | | subSpecialties | Array of Strings | A list of the provider's medical sub-specialties. | Optional | | planTypes | Array of Strings | The type of insurance plan accepted by the provider. | Optional | | acceptingNewPatients | Boolean | Indicates whether the provider is currently accepting new patients. | Optional | | languagesSpoken | Array of Strings | A list of languages the provider can speak. | Optional | | providerGender | String | The gender of the healthcare provider. | Optional | | licenseJurisdictionState | String | The state where the provider's license is registered. | Optional | | licenseJurisdictionCountry | String | The country where the provider's license is registered. | Optional | | licenseJurisdictionRegion | String | The region where the provider's license is registered. | Optional | | nationalProviderIdentifier | String | The provider's National Provider Identifier (NPI). | Optional | | providerType | String | The type of healthcare provider (e.g., MD, DO, NP). | Optional | | additionalSearchCriteria | Object | Any additional key-value pairs for specific search fields. | Optional | # Provider Search Result Detailed information about a single healthcare provider matching the search criteria. ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | providerId | String | A unique identifier assigned to this healthcare provider. | Optional | | providerName | String | The full name of the healthcare provider. | Optional | | facilityName | String | The name of the primary facility or clinic where the provider practices. | Optional | | specialties | Array of Strings | A list of medical specialties (e.g., Cardiology, Pediatrics) in which the provider is qualified. | Optional | | subSpecialties | Array of Strings | A list of more specific areas of focus within the provider's specialties (e.g., Interventional Cardiology, Neonatology). | Optional | | acceptedInsurancePlans | Array of Strings | A list of the types of insurance plans or networks that the provider accepts. | Optional | | acceptingNewPatients | Boolean | Indicates whether the provider is currently accepting new patients (true/false). | Optional | | languagesSpoken | Array of Strings | A list of languages the provider is fluent in. | Optional | | providerGender | String | The gender of the provider (e.g., "Male", "Female"). | Optional | | licenseName | Array of Strings | A list of professional licenses held by the provider. | Optional | | licenseStatuses | Array of Strings | The current status of each professional license held by the provider (e.g., "Active", "Inactive"). | Optional | | licenseStates | Array of Strings | A list of the states or provinces where the provider's licenses are registered. | Optional | | licenseCountries | Array of Strings | A list of the countries where the provider's licenses are registered. | Optional | | licenseRegions | Array of Strings | A list of the broader regions where the provider's licenses are registered. | Optional | | facilityAddress | Object | The primary physical address of the facility where the provider practices. See [Address Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_address_output_representation.htm "The detailed address information for a facility or resource in the response."). | Optional | | educationLevel | String | The highest level or type of formal education completed by the provider (e.g., "MD", "PhD", "DO"). | Optional | | nationalProviderIdentifier | String | The unique National Provider Identifier (NPI) assigned to the provider. | Optional | | providerType | String | The professional classification or type of the provider (e.g., "Medical Doctor", "Nurse Practitioner"). | Optional | | facilityPhone | String | The main contact phone number for the provider's primary facility. | Optional | | photoUrl | String | A direct link (URL) to a professional photograph of the provider. | Optional | | certifications | Array of Strings | A list of professional certifications held by the provider. | Optional | | sourceSystem | String | The internal system or database from which this provider's information originated, if applicable. | Optional | | additionalDetails | Object | A flexible object containing any extra key-value pair details about the provider. | Optional | # ProviderNetworkContract Represents a provider and a network bound together by a contract. This object is available in API version 53.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContractId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract that ties the network and provider together. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: Contract ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The end date of the contract between the provider and the network. ### HealthcarePayerNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The healthcare payer network associated with the contract. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcarePayerNetwork ### HealthcareProviderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The healthcare provider associated with the contract. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcareProvider ### 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 ProviderNetworkContract record. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The start date of the contract between the provider and the network. ## Usage This object is used to store Network Participation records created by the Network Participation Lightning component. The location of the network participation is derived from the provider associated with the contract. ## 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. [ProviderNetworkContractFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProviderNetworkContractHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProviderNetworkContractChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ProviderNetworkTier Represents unique tiers for each provider network. This object is available in API version 53.0 and later with the Provider Network Management permission set license. ## 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**: Represents the description of the provider network tier. ### IsActive - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the provider network tier is active. - **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**: Represents the name of the provider network tier. ### ProviderNetworkId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents the parent provider network whose tier is specified by the record. This is a relationship field. - **Relationship Type**: Lookup - **Refers To**: HealthcarePayerNetwork ## 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. [ProviderNetworkTierFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProviderNetworkTierHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ProviderNetworkTierChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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() # 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() ## Fields ### Affiliation - **Type**: picklist - **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 purchaser plan is effective. ### EffectiveTo - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date on which this purchaser plan ceases to be effective. ### IsVerifiable - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a benefits verification can be performed on this plan. ### LineOfBusiness - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category of insurance policy that the purchaser plan belongs to. For example, whether the plan is a group health insurance, individual health insurance, etc. This field is available in API version 64.0 and later. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of this plan. ### Notes - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Notes about this payer. ### Payer - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The ID of the payer’s Account object record. ### PlanNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The plan’s reference number. ### PlanStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates whether the plan is active. ### PlanType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of plan, with the following default options: - PPO - HMO - Medicare - Medicaid - Workers Comp ### ServiceType - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the service type offered by this plan. ### 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. ### SponsorType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type of sponsor for the plan. For example, if it's self-sponsored, government-sponsored, or company-sponsored. This field is available in API version 64.0 and later. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. [PurchaserPlanFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 data capture is available for this object. # PurchaserPlan for Pharmacy Benefits Verification Represents the payer plan that a purchaser makes available to its members and members’ dependents. Multiple features use this object. See [PurchaserPlan](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_purchaserplan_bv.htm "Represents the payer plan that a purchaser makes available to its members and members’ dependents."). # PurchaserPlanAssn Represents a junction object that associates the purchaser to the plans they offer to members. ## 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # PurchaserPlanCareProgram Represents a junction between puchaser plans and care programs. It defines the care programs that are available under a purchaser plan such as employer-sponsored programs for managing chronic conditions. This object is available in API version 66.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, Update - **Description**: The care program associated with the purchaser plan. This field is a relationship field. - **Relationship Name**: CareProgram - **Refers To**: CareProgram ### 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 name of this record. ### PurchaserPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent purchaser plan associated with the care program. This field is a relationship field. - **Relationship Name**: PurchaserPlan - **Relationship Type**: Master-detail - **Refers To**: PurchaserPlan (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. [PurchaserPlanCareProgramChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanCareProgramFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [PurchaserPlanCareProgramHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # Question Response Output Contains the response values and assessment metadata for a single question. ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | assessment​Details | [Assessment Details Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_assessment_details_output.htm "Contains metadata for the assessment record associated with a question response.") | Details of the assessment record, including name, ID, and timestamps. | Small, 66.0 | 66.0 | | parent​Question​Identifier | String | The identifier of the parent question, if applicable. | Small, 66.0 | 66.0 | | previous​Responses | [Response Value Output\[\]](connect_responses_response_value_output.htm "Contains the specific answer data and its sequence for a question within an assessment.") | The list of response values provided for the specific question. | Small, 66.0 | 66.0 | | question​Identifier | String | The unique identifier of the assessment question. | Small, 66.0 | 66.0 | # Quota Availability Output representation of a list of available quotas, and their start and end dates for a work type. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | workTypeId | String | ID of the work type. | Small, 60.0 | 60.0 | | availabilityRangeList | [Quota Availability Date Range](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_quota_availability_date_range.htm "Output representation of the date range of an available quota.") | Date range of the available quotas. | Small, 60.0 | 60.0 | # Quota Availability Date Range Output representation of the date range of an available quota. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | quotaStartDate | String | Start date for the quota availability. | Small, 60.0 | 60.0 | | quotaEndDate | String | End date for the quota availability. | Small, 60.0 | 60.0 | # Quotas and Allocation Input Input representation of available slots for quotas and allocation. ## Root XML tag ## JSON example { "contextId": "0Wwxx000000003FCAQ", "endDate": "2023-12-01T02:29:59.000Z", "leadTimeMap": { "08qxx0000004CSRAA2": 2, "08qxx0000004CSQAA2": 30, "08qxx0000004CSOAA2": 3, "08qxx0000004CSPAA2": 2 }, "siteId": "0Hhxx0000004CQmCAM", "startDate": "2023-11-15T02:30:00.000Z", "workProcedureId": "0uVxx00000000G9EAI", "workTypeId": "08qxx0000004CSPAA2" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the program enrollee, a case or an opportunity used for slot searching. | Optional | 60.0 | | endDate | String | End date and time of slot searching. | Optional | 60.0 | | leadTimeMap | String | Lead time map of work type to lead time. | Optional | 60.0 | | siteId | String | Work procedure organization used for slot searching. | Optional | 60.0 | | startDate | String | Start date and time of slot searching. | Optional | 60.0 | | workProcedureId | String | ID of the work procedure used for searching. | Optional | 60.0 | | workTypeId | Map | ID of the work type used for slot searching. | Optional | 60.0 | # Quotas and Allocations Find available slots and manage quotas for therapies (Work Procedures) at various stages (Work Types) across multiple treatment centers. See [Advanced Therapy Management](https://help.salesforce.com/s/articleView?id=ind.admin_advanced_therapy_management_overview.htm&type=5&language=en_US) in _Salesforce Help_ for details on quotas, allocations and slot management. ## Resource /connect/health/advanced-therapy-management/quotas-and-allocations ## 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/quotas-and-allocations ## Available Version 60.0 ## HTTP Method POST ## Root XML tag ## JSON example { "contextId": "0Wwxx000000003FCAQ", "endDate": "2023-12-01T02:29:59.000Z", "leadTimeMap": { "08qxx0000004CSRAA2": 2, "08qxx0000004CSQAA2": 30, "08qxx0000004CSOAA2": 3, "08qxx0000004CSPAA2": 2 }, "siteId": "0Hhxx0000004CQmCAM", "startDate": "2023-11-15T02:30:00.000Z", "workProcedureId": "0uVxx00000000G9EAI", "workTypeId": "08qxx0000004CSPAA2" } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | contextId | String | ID of the program enrollee, a case or an opportunity used for slot searching. | Optional | 60.0 | | endDate | String | End date and time of slot searching. | Optional | 60.0 | | leadTimeMap | String | Lead time map of work type to lead time. | Optional | 60.0 | | siteId | String | Work procedure organization used for slot searching. | Optional | 60.0 | | startDate | String | Start date and time of slot searching. | Optional | 60.0 | | workProcedureId | String | ID of the work procedure used for searching. | Optional | 60.0 | | workTypeId | Map | ID of the work type used for slot searching. | Optional | 60.0 | ## Response Body for POST [Quotas and Allocations](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_quota_availability.htm "Output representation of a list of available quotas, and their start and end dates for a work type.") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Record Fields Input Input representation of the request to create a generic object, such as an account, or referral details. ## Properties
Name Type Description Required or Optional Available Version
fields Map<String, Object> Map of API names and values. Required

This is an optional field for performers and requester.

 59.0
id String ID of the object.

If you don’t specify an ID, the API creates an object with the provided fields.

 Required

This is an optional field for performers and requester.

 59.0
# 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_properties)** - **[RecordApexRepresentation Methods](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_embeddedai_RecordApexRepresentation.htm#apex_embeddedai_RecordApexRepresentation_objectType)** Stores the type of the object. - **[recordData](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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) # RecordTypeConfig\_\_c ## Supported Calls create(), delete() ,describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the record type configuration. Limit: 255 characters. # RecurringVisitSchedulingInput Class Contains the input for scheduling recurring home visits, including the default address, work type configurations, recurrence series, resource assignment setting, and time zone. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[RecurringVisitSchedulingInput Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_properties)** ## RecurringVisitSchedulingInput Properties The following are properties for RecurringVisitSchedulingInput. - **[isAutoAssignCareResource](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_isAutoAssignCareResource)** Indicates whether Field Service assigns a resource to the service appointments. When false, the service appointments are created and left unassigned. A null value behaves as true. - **[schedulingPolicyId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_schedulingPolicyId)** ID of the scheduling policy for the request. This value is required. An individual series can override it. - **[serviceTerritoryId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_serviceTerritoryId)** ID of the service territory for the request. This value is required. An individual series can override it. - **[timeZoneId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_timeZoneId)** IANA time zone ID used to interpret series start dates and time slots. If this value is omitted, the running user's time zone is used. - **[visitAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_visitAddress)** Request-level visit address. A series uses this address when the series does not specify its own address. - **[visitRecurrenceDetails](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_visitRecurrenceDetails)** Recurring series that make up this scheduling request. Each series defines its own recurrence rule, time slots, and optional overrides. - **[visitWorkTypes](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_RecurringVisitSchedulingInput.htm#apex_healthcloudext_RecurringVisitSchedulingInput_visitWorkTypes)** Request-level work type configurations. The request can include up to five configurations. A series can override fields for a work type. ### isAutoAssignCareResource Indicates whether Field Service assigns a resource to the service appointments. When false, the service appointments are created and left unassigned. A null value behaves as true. #### Signature @AuraEnabled global Boolean isAutoAssignCareResource {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### schedulingPolicyId ID of the scheduling policy for the request. This value is required. An individual series can override it. #### Signature @AuraEnabled global String schedulingPolicyId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### serviceTerritoryId ID of the service territory for the request. This value is required. An individual series can override it. #### Signature @AuraEnabled global String serviceTerritoryId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### timeZoneId IANA time zone ID used to interpret series start dates and time slots. If this value is omitted, the running user's time zone is used. #### Signature @AuraEnabled global String timeZoneId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### visitAddress Request-level visit address. A series uses this address when the series does not specify its own address. #### Signature @AuraEnabled global healthcloudext.VisitAddress visitAddress {get; set;} #### Property Value Type: [healthcloudext.VisitAddress](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitAddress.htm#apex_class_healthcloudext_VisitAddress "Represents an address for recurring home visits.") ### visitRecurrenceDetails Recurring series that make up this scheduling request. Each series defines its own recurrence rule, time slots, and optional overrides. #### Signature @AuraEnabled global List visitRecurrenceDetails {get; set;} #### Property Value Type: List<[healthcloudext.VisitRecurrenceDetails](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitRecurrenceDetails.htm#apex_class_healthcloudext_VisitRecurrenceDetails "Represents one recurring series for home visits. Each series defines a recurrence pattern and can override request-level defaults.")\> ### visitWorkTypes Request-level work type configurations. The request can include up to five configurations. A series can override fields for a work type. #### Signature @AuraEnabled global List visitWorkTypes {get; set;} #### Property Value Type: List<[healthcloudext.VisitWorkType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_VisitWorkType.htm#apex_class_healthcloudext_VisitWorkType "Represents a work type configuration for recurring home visits.")\> # referenceId A unique reference identifier used to correlate the node within the processing request. ## Signature public String referenceId {get; set;} ## Property Value Type: String # referenceId The reference identifier used to correlate the record with the original extraction request. ## Signature public String referenceId {get; set;} ## Property Value Type: String # Referral Detail Input Input representation of the request to create patient referral details. ## Properties
Name Type Description Required or Optional Available Version
detailCodeId String ID of Code Set, or Code Set Bundle that adds information to a clinical service request record. Optional 59.0
detailRecordId String ID of the detail record. Optional 59.0
detailRecordType String Type of the detail record.
The supported values are:
  • Care Observation
  • Care Plan
  • Care Registered Device
  • Care Specialty
  • Clinical Service Request
  • Diagnostic Summary
  • Health Condition
  • Healthcare Facility
  • Medication Request
  • Member Plan
  • Work Type
 Optional 59.0
detailType String Type of the object that stores patient details.

The supported values are the ClinicalServiceRequestDetail.detailType enum values.

 Required 59.0
fields Map<String, Object> Map of API names and values of detail fields. Optional 59.0
# Referral Management Create a patient referral in a Salesforce org from an external data source. When you send a request to create a patient referral, the API creates records in multiple objects, such as Account, ClinicalServiceRequest, and ClinicalServiceRequestDetail to store the patient referral information. ## Resource /connect/health/referral-management/referrals ## Resource Example Replace {yourInstance} with the My Domain name of your Salesforce org. https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/referral-management/referrals ## Available Version 59.0 ## Requires Chatter No ## HTTP Methods POST ## JSON example Here’s an example request to create an existing patient referral. { "patient": { "id": "005S7000001xLk1IAE" }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" } \], "requester": { "id": "0cmS70000004CAuIAM" }, "referralNotes": "This is an urgent request", "performers": \[ { "id": "0cmRM0000004nAgYAI" }, { "id": "0cmRM0000004nAgDZc" } \], "referral": { "fields": { "PatientInstruction": "Need Appointment ASAP.", "Priority": "Urgent" } }, "shouldUseHighConfidenceMatch": true } Here’s an example request to create a new patient referral. { "patient": { "fields": { "FirstName": "Joe", "LastName": "Clark", "Phone": "801XXXXX89" } }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" }, { "detailType": "Body Site", "detailRecordType": "Health Condition", "detailCodeId": "0hsRM000000043aYAA" }, { "detailType": "Reason Reference", "detailRecordId": "0j4RM0000004MunYAE" } \], "requester": { "id": "0cmRM0000004nAgYAI" }, "performers": \[ { "id": "0cmRM0000000l2JYAQ" }, { "id": "0cmRM0000000tnoYAA" } \], "referralNotes": "This is an urgent request", "referral": { "fields": { "Priority": "Routine", "Status": "Draft", "Type": "Plan" } } } ## Properties
Name Type Description Required or Optional Available Version
patient Record Fields Input[] Account details of the patient being referred. Required 59.0
performers Record Fields Input[] List of healthcare providers who perform the service.

You can provide a maximum of 5 provider IDs in a request.

 Optional 59.0
referral Record Fields Input[] Referral information. Required 59.0
referralDetails Referral Detail Input[] Patient details, such as, insurance, and health condition. Optional 59.0
referralNotes String Referral notes. Optional 59.0
requester Record Fields Input[] Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.

If the requester is new, provide information to create an account.

 Optional 59.0
shouldUseHighConfidenceMatch Boolean Indicates whether to match a duplicate record that has the highest matching confidence (true) or not (false). Optional 59.0
## Response Body for POST [Referral Management Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_referral_management_output.htm "Output representation of the request to create a patient referral.") # Referral Management Input Input representation of the request to create a patient referral. ## JSON example Here’s an example request to create an existing patient referral. { "patient": { "id": "005S7000001xLk1IAE" }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" } \], "requester": { "id": "0cmS70000004CAuIAM" }, "referralNotes": "This is an urgent request", "performers": \[ { "id": "0cmRM0000004nAgYAI" }, { "id": "0cmRM0000004nAgDZc" } \], "referral": { "fields": { "PatientInstruction": "Need Appointment ASAP.", "Priority": "Urgent" } }, "shouldUseHighConfidenceMatch": true } Here’s an example request to create a new patient referral. { "patient": { "fields": { "FirstName": "Joe", "LastName": "Clark", "Phone": "801XXXXX89" } }, "referralDetails": \[ { "detailType": "Insurance", "detailRecordType": "Member Plan", "fields": { "Name": "Aetna PPO", "MemberNumber": "2345678" } }, { "detailType": "Insurance", "detailRecordType": "Member Plan", "detailRecordId": "0SqRM0000004F2z0AE" }, { "detailType": "Body Site", "detailRecordType": "Health Condition", "detailCodeId": "0hsRM000000043aYAA" }, { "detailType": "Reason Reference", "detailRecordId": "0j4RM0000004MunYAE" } \], "requester": { "id": "0cmRM0000004nAgYAI" }, "performers": \[ { "id": "0cmRM0000000l2JYAQ" }, { "id": "0cmRM0000000tnoYAA" } \], "referralNotes": "This is an urgent request", "referral": { "fields": { "Priority": "Routine", "Status": "Draft", "Type": "Plan" } } } ## Properties
Name Type Description Required or Optional Available Version
patient Record Fields Input[] Account details of the patient being referred. Required 59.0
performers Record Fields Input[] List of healthcare providers who perform the service.

You can provide a maximum of 5 provider IDs in a request.

 Optional 59.0
referral Record Fields Input[] Referral information. Required 59.0
referralDetails Referral Detail Input[] Patient details, such as, insurance, and health condition. Optional 59.0
referralNotes String Referral notes. Optional 59.0
requester Record Fields Input[] Information about the provider requesting the service. A requester can be an Account, Asset, Healthcare Provider, or a CareRegisteredDevice object.

If the requester is new, provide information to create an account.

 Optional 59.0
shouldUseHighConfidenceMatch Boolean Indicates whether to match a duplicate record that has the highest matching confidence (true) or not (false). Optional 59.0
# Referral Management Output Output representation of the request to create a patient referral. ## JSON example { "error":null, "referralIds":\[ "0lvxx00004000001AAB", "0bhxx00008000001CAD" \] } ## Properties | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | error | [Error Response](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_error_output.htm "A generic error message containing error code and the message text.") | Error details when the request fails. | Small, 59.0 | 59.0 | | referralsIds | String\[\] | IDs of the created patient referral records. | Small, 59.0 | 59.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 Monitoring and Device Registration The remote monitoring and device registration data model provides objects for managing data collected from devices issued to patients or program members, such as smart watches and heart monitors. The remote monitoring and device registration data model includes standard objects and record types. The health insurance standard objects are visible to users with the Health Cloud and Health Cloud Platform permission set licenses. ![Remote monitoring entity relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/remote_monitoring_erd.png) - **[CareMetricTarget](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caremetrictarget.htm)** Represents the expected care metrics at an org level and patient level. This object is available in API version 49.0 and later. - **[UnitOfMeasure for Remote Monitoring](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_rm_objects_unitofmeasure.htm)** Represents the unit of measures for care metrics and care observations. - **[CareObservation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careobservation.htm)** Represents the observed values for care metrics originating from external systems that contain biometric data. This object is available in API version 49.0 and later. # 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 Health 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 Health Cloud. Health 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 - [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 - [Assessment Details Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_responses_assessment_details_input.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)") - [Assessment Reasons Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_responses_assessment_reason_input.htm "HTML (New Window)") - [Assessment Responses Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_responses_input.htm "HTML (New Window)") - [Assessment Values Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_assessment_responses_assessment_values_input.htm "HTML (New Window)") - [Question Responses Input](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_requests_question_responses_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 | # Reschedule Recurring Home Visits Action Reschedule all the home visits based on the recurrence pattern and scheduling policy provided. This action is available in API version 60.0 and later. ## Special Access Rules The Schedule Recurring Home Visit action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/rescheduleRecurringHomeVisits 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
schedulingPolicyId string Required.

ID of the home health scheduling policy to be used to schedule the home visit.
firstVisitStartDateTime datetime Required.

Rescheduled date and time for the start of the first recurring home visit.
firstVisitEndDateTime datetime Rescheduled date and time for the end of the first recurring home visit.
recurrenceFrequencyType string Required.

Days of recurring home visits. If specified, the selectedDays property is required. Valid values are:

  • Daily
  • Weekly
recurringDaysList string Comma-delimited list of days to reschedule recurring home visits for the patient. For example, Monday, Thursday, Saturday. If recurrenceFrequencyType is set to Weekly, recurringDaysList is required.
operatingHoursId string ID of the operating hours record that specifies the time slots that the patient wants to reschedule recurring visits for.
serviceAppointmentId string Required.

ID of the service appointment record that's associated with the first recurring home visit to be rescheduled.
## Outputs None. ## Example **POST** This sample request is for the Reschedule Recurring Home Visit action. { "inputs" : \[ { "schedulingPolicyId" : "001SG000005OtxxYA0", "serviceAppointmentId" : "0jyxx0000000001AAA", "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z", "firstVisitEndDateTime" : "2024-03-17T01:00:00.000Z", "operatingHoursId" : "0OHxx0000004CKKGA2", "recurrenceFrequencyType" : "WEEKLY", "recurringDaysList" : "Monday, Thursday" } \] } This sample response is for the Reschedule Recurring Home Visit action. \[ { "actionName" : "rescheduleRecurringHomeVisits", "errors" : null, "isSuccess" : true, "version" : 1 } \] # 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 | # ResourceDetails Class Represents the home visit details for manual scheduling of appointments. Once the scheduler has selected the recommended resources along with the time slot, it will schedule the appointment using this Apex class. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[resourceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_HomeHealth_ResourceDetails.htm#apex_healthcloudext_HomeHealth_resourceId)** The ID of the selected service resource. - **[scheduleEnd](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_HomeHealth_ResourceDetails.htm#apex_healthcloudext_HomeHealth_scheduleEnd)** End date time of the selected slot for appointment. - **[scheduleStart](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_HomeHealth_ResourceDetails.htm#apex_healthcloudext_HomeHealth_scheduleStart)** Start date time of the selected slot for appointment. - **[sequence](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_healthcloudext_HomeHealth_ResourceDetails.htm#apex_healthcloudext_HomeHealth_sequence)** Sequence number on which appointment needs to schedule. ## resourceId The ID of the selected service resource. ### Signature public String resourceId {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## scheduleEnd End date time of the selected slot for appointment. ### Signature public String scheduleEnd {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## scheduleStart Start date time of the selected slot for appointment. ### Signature public String scheduleStart {get; set;} ### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ## sequence Sequence number on which appointment needs to schedule. ### Signature public String sequence {get; set;} ### Property Value Type: Integer # Resources Use these resources of Health Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications. This guide documents resources unique to Health Cloud. Health 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 resource reference for these features in that guide. ## Intelligent Form Reader - [Record Creation with Content Documents (POST)](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_create_content_documents.htm "HTML (New Window)") - [Record Creation with Received Documents (POST)](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_create_received_documents.htm "HTML (New Window)") - [Record Update with Content Documents (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_update_content_documents.htm "HTML (New Window)") - [Record Update with Received Documents (PATCH)](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_update_received_documents.htm "HTML (New Window)") ## Discovery Framework - [Omniscript](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_resources_store_discovery_framework_structure.htm "HTML (New Window)") # Resources Input Input representation for getting appointment slot resources. ## JSON Example { "resources": \[ { "resourceId": "string", "serviceTerritoryId": "003xx000000Y4xxYCD", "serviceResourceId": "c51xx000000B1xxBCI", "assetCategory": "string", "serviceTypes": "Provider" } \] } ## Properties
Property Name Type Description Required or Optional available version
resource​Id String ID of the Healthcare Practitioner Facility for Provider and Asset ID for the Asset. Optional 65.0
service​Territory​Id String ID of the Service Territory. Optional 65.0
service​Resource​Id String ID of the service resource. Optional 65.0
assest​Category String Asset category of the resource. Optional 65.0
resource​Type String Type of the resource. Possible values are:
  • provider​
  • device​
 Optional 65.0
# 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 Health Cloud. Health 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 - [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)") ## Discovery Framework - [Additional Attributes Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_additional_attributes.htm "HTML (New Window)") - [Assessment Responses Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_assessment_responses_output.htm "HTML (New Window)") - [Custom Type Details](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_custom_type_details.htm "HTML (New Window)") - [Omniscript Element Discovery Framework Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_os_element_discovery_framework_output.htm "HTML (New Window)") - [Omniscript Element Property Set Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_os_element_property_set_output.htm "HTML (New Window)") - [Omniscript Elements List](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_omniscript_elements_list.htm "HTML (New Window)") - [Omniscript Output](https://developer.salesforce.com/docs/atlas.en-us.264.0.industries_reference.meta/industries_reference/connect_responses_omniscript_output.htm "HTML (New Window)") # Response Value Output Contains the specific answer data and its sequence for a question within an assessment. ## Properties | Property Name | Type | Description | | --- | --- | --- | | response​Identifier | String | The unique identifier of the retrieved response, such as an answer ID or question name. | | response​Question​Sequence | Integer | The sequence number of the question within the assessment question set. | | response​Value | String | The actual value of the retrieved response provided by the user. | # REST Reference You can access Health Cloud Business APIs using REST endpoints. These REST APIs follow similar conventions as Connect REST APIs. To understand the architecture, authentication, rate limits, and how the requests and responses work, see [Connect REST API 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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_resources.htm)** Use these resources of Health Cloud Business APIs to enhance your Salesforce implementation or integrate with other applications. - **[Request Bodies](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_requests.htm)** This section lists the request bodies for Health 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.health_cloud_object_reference.meta/health_cloud_object_reference/hc_responses.htm)** A resource can return a response body in either JSON or XML format. #### See Also - [Connect REST API Architecture](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_architecture.htm "Connect REST API Architecture - HTML (New Window)") - [Connect REST API Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_rate_limits.htm "Connect REST API Rate Limits - HTML (New Window)") - [Build a Resource URL](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/intro_building_url.htm "Build a Resource URL - HTML (New Window)") - [Status Codes and Error Responses](https://developer.salesforce.com/docs/atlas.en-us.264.0.chatterapi.meta/chatterapi/connect_error_responses.htm "Status Codes and Error Responses - HTML (New Window)") # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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
# Save Transformed Data The status list outcome tracking individual upsert status records generated. ## Properties | Property Name | Type | Description | | --- | --- | --- | | version | String | The tracking layout standard configuration signature string. | | data | List | A tracking structure array summarizing newly instantiated record identity mappings. | | errors | List | The database persistence tracking fault records listing structural block validation details. | # Save Transformed Records (POST) Synchronously commits structured object tree models directly to core database layers. ## Resource /connect/document-ai-automation/actions/save ## Available Version 68.0 ## HTTP Methods POST ## JSON example { "transformedData": { "version": "V1", "data": \[...\] } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | transformedData | Object | The final structured representation of the target objects context graph hierarchy. | Required | ## Response Body for POST [Save Transformed Records](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_save_transformed_data_output.htm "The status list outcome tracking individual upsert status records generated.") # Save Transformed Records Input Input configuration parameters carrying verified hierarchical node data rows to commit. ## JSON example { "transformedData": { "version": "V1", "data": \[...\] } } ## Properties | Property Name | Type | Description | Required | | --- | --- | --- | --- | | transformedData | Object | The final structured representation of the target objects context graph hierarchy. | Required | # SavedRecordDetail Represents a record that was created or updated during Document AI processing and is included in the post-save context. ## Namespace [documentai](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_documentai.htm "The DocumentAI namespace provides classes for Document AI to process and extract data from documents, including configurations for duplicate detection, post-transformation, and post-save processing.") - **[SavedRecordDetail Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_saved_record_properties.htm)** The following are properties for savedRecordDetail. # SavedRecordDetail Properties The following are properties for savedRecordDetail. - **[id](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_saved_record_id.htm)** The unique identifier of the saved record. - **[objectName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_saved_record_objectName.htm)** The API name of the object to which the record belongs. - **[referenceId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_docai_saved_record_referenceId.htm)** The reference identifier used to correlate the record with the original extraction request. # Schedule Group Visits Action Create visiting records for patient home visits by bundling them into a group and scheduling either a single start-of-care visit or a series of recurring visits associated with the bundled records. This action is available in API version 60.0 and later. ## Special Access Rules The Schedule Group Visits action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/scheduleGroupVisits 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
schedulingPolicyId string Required.

ID of the home health scheduling policy to be used to schedule the group visits.
appointmentBundlePolicyId string Required.

ID of the home health appointment bundle policy to be used to create the patient visit records.
workTypeId string Required.

ID of the work type that represents the care service that the visits are being scheduled for.
serviceTerritoryId string Required.

ID of the service territory record that contains the care resources to be assigned to the visits.
firstVisitStartDateTime datetime Required.

Scheduled date and time for the start of the first group visit.
firstVisitEndDateTime datetime Date and time when the first group visit ends.
operatingHoursId string ID of the operating hours record that specifies the time slots to schedule the group visit for.
skillsIdsList string A comma-delimited list of record IDs of all skills required for the group visits.
isRecurringVisit boolean Indicates whether recurring visits are scheduled. If false, then a single start-of-care group visit is scheduled.
recurrenceFrequencyType string Required.

Specifies the type of recurring group visits. If specified, the selectedDays property is required. Valid values are:

  • Daily
  • Weekly
recurringDaysList string Comma-delimited list of days to schedule recurring group visits for patients. For example, Monday, Thursday, Saturday. If recurrenceFrequencyType is set to Weekly, recurringDaysList is required.
visitsRequired integer The number of recurring group visits to be scheduled.
groupVisitAddress Apex-defined(Input example of apex type:{“street":"123 Main St","city":"Cityville","state":"CA","zip":"12345"}) An Apex GroupVisitAddress record that specifies the address where the group visit for the selected patients is scheduled.
clinicalServiceRequestIdsList string Comma-delimited list of record IDs of all clinical service requests of the selected patients in the group visit.
## Outputs None. ## Example **POST** This sample request is for the Schedule Group Visits action. { "inputs" : \[ { "schedulingPolicyId" : "001SG000005OtxxYA0", "appointmentBundlePolicyId" : "0jyxx0000000001AAA", ."workTypeId" : "0jyxx0000000001AAA", "serviceTerritoryId" : "0HxxG00000015dZ0AQ", "serviceTerritoryId" : "0HxxG00000015dZ0AQ", "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z", "isRecurringVisit" : "false", "operatingHoursId" : "0OHxx0000004CKKGA2", "recurrenceFrequencyType" : "WEEKLY", "recurringDaysList" : "Monday, Thursday", "clinicalServiceRequestIdsList" :\["0jxxG0000000b1BYAQ","0jyxx0000000b1KYAQ"\], "groupVisitAddress" :{ "city" : "Hyderabad" } } \] } This sample response is for the Schedule Group Visits action. \[ { "actionName" : "scheduleGroupVisits", "errors" : null, "isSuccess" : true, "outputValues" : { "careServiceVisitPlanId": "null" "bundleStatusMessage": "Group visit request has been submitted" }, "version" : 1 } \] # Schedule Home Visit Action Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care. This action is available in API version 58.0 and later. ## Special Access Rules The Schedule Home Visit action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/scheduleHomeVisit 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
schedulingPolicyId String Required.

ID of the scheduling policy that determines the service resource and the visit time to assign to the specified service appointment.
serviceAppointmentId String Required.

ID of the service appointment that’s assigned a service resource for the home visit.
## Outputs None. ## Example **POST** This sample request is for the Schedule Home Visit action. { "inputs" : \[ { "schedulingPolicyId" : "7sTSG00000001H32AI", "serviceAppointmentId" : "08pSG0000000QSLYA2" } \] } This sample response is for the Schedule Home Visit action. \[ { "actionName" : "scheduleHomeVisit", "errors" : null, "isSuccess" : true, "outputValues" : null, "version" : 1 } \] # Schedule Home Visits Manually Action Create start of care or recurring home visits and assign care resources that are manually selected by the scheduler to the visits. This action is available in API version 61.0 and later. ## Special Access Rules Schedule Home Visits Manually action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/scheduleHomeVisitsManually 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 String Required

Personal account ID of the patient for whom the visit is to be scheduled. For each API call, you can send only one account ID in the payload.
clinicalServiceRequestId String Required

ID of the clinical service request record that's associated with the home visits to be scheduled.
firstVisitEndDateTime Datetime Date and time when the first recurring home visit ends.
firstVisitStartDateTime Datetime Required

Date and time when the first recurring home visit starts.
operatingHoursId String ID of the operating hours record that specifies the time slots to schedule the home visit.
recurringDaysList String Comma-delimited list of days to schedule recurring home visits. For example, Monday, Thursday, and Saturday. If recurrenceFrequencyType is set to Weekly, recurringDaysList is required.
recurrenceFrequencyType String

Type of recurring home visits. If Weekly is specified, recurringDaysList is required. Valid values are:

  • Daily
  • Weekly
resourceDetails Apex defined Required

Collection of Apex heathcloudext__ResourceDetails records containing resources and schedule intervals for the visit.
schedulingPolicyId String Required

ID of the home health scheduling policy that's used to identify care resources available for the home visits.
serviceTerritoryId String Required

ID of the service territory record that contains the care resources to be assigned to the visits. Available in API version 66.0 and later.
skillIds String Collection of up to 20 record IDs of skills required for the home visits.
visitsRequired Integer Number of recurring home visits to be scheduled.
visitSourceId String The ID of the reference record to use as a source to schedule the home visit. Available in API version 64 and later.
visitType String Required

Type of home visit to be scheduled. Valid values are:

  • Start of Care
  • Recurring
workPlanTemplateIds String Collection of IDs of work plan template records that are assigned to the service appointment and specify the care instructions to be followed during the home visit. Available in API version 66.0 and later.
## Outputs | Output | Type | Description | | --- | --- | --- | | careServiceVisitPlanId | String | ID of the care service visit plan record that’s associated with the service request for recurring home visits. | | careServiceVisitId | String | ID of the care service visit record that’s associated with the service request to start a care home visit. | ## Example **POST** This sample request is for the Schedule Home Visits Manually action when visitType is Start of Care. { "inputs": \[ { "accountId": "001xx000003GYv7AAG", "visitType": "StartOfCare", "schedulingPolicyId": "a0cxx000000fzXpAAI", "clinicalServiceRequestId": "0jyxx0000000001AAA", "serviceTerritoryId": "0Hhxx0000004C93CAE", "firstVisitStartDateTime": "2026-02-18T05:30:00Z", "firstVisitEndDateTime": "2026-02-18T07:35:00Z", "visitsRequired": 1, "skillIds": \[ "0C5SG0000003O930AE" \], "resourceDetails": \[ { "sequence": 1, "scheduleStart": "2026-02-18T05:30:00Z", "scheduleEnd": "2026-02-18T06:30:00Z", "resourceId": "0Hnxx0000004C92CAE" } \] } \] } This sample request is for the Schedule Home Visits Manually action when visitType is Recurring. { "inputs": \[ { "accountId": "001xx000003GYv7AAG", "visitType": "Recurring", "schedulingPolicyId": "a0cxx000000fzXpAAI", "clinicalServiceRequestId": "0jyxx0000000001AAA", "recurrenceFrequencyType": "Weekly", "recurringDaysList": \[ "Monday", "Tuesday" \], "operatingHoursId": "0OHxx0000004C93GAE\_\_USER", "serviceTerritoryId": "0Hhxx0000004C93CAE", "firstVisitStartDateTime": "2026-02-23T05:30:00Z", "firstVisitEndDateTime": "2026-02-23T07:35:00Z", "visitsRequired": 2, "skillIds": \["0C5SG0000003O930AE"\], "resourceDetails": \[ { "sequence": 1, "scheduleStart": "2026-02-23T05:30:00Z", "scheduleEnd": "2026-02-23T06:30:00Z", "resourceId": "0Hnxx0000004C92CAE" }, { "sequence": 2, "scheduleStart": "2026-02-24T05:30:00Z", "scheduleEnd": "2026-02-24T06:30:00Z", "resourceId": "0Hnxx0000004C92CAE" } \] } \] } This sample response is for the Schedule Home Visits Manually action when visitType is Start of Care. \[ {"careServiceVisitId":"0oxxx00000000WHAAY"} \] This sample response is for the Schedule Home Visits Manually action when visitType is Recurring. \[ {"careServiceVisitPlanId":"0qExx0000000001EAA"} \] # Schedule Recurring Home Visit Action Create a set of recurring home healthcare visits and assign service resources to them based on the specified scheduling policy. This action is available in API version 58.0 and later. ## Special Access Rules The Schedule Recurring Home Visit action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/scheduleRecurringHomeVisit 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 string Required

Person account ID of the patient to schedule the set of recurring visits for.
careResourceCount string The number of care resources required for the home visit.
clinicalServiceRequestId string Required

ID of the clinical service request record that's associated with the recurring home visits to be scheduled.
firstCareResourceSkillsIdsList string ID of the clinical service request record that's associated with the recurring home visits to be scheduled.
firstVisitEndDateTime datetime Scheduled date and time for the end of the first home visit.
flowInterviewId string The ID of the flow interview to set the service appointment template's Comment field to when manually scheduling home visits.
recurrenceFrequencyType string

Required

Days of recurring home visits. If specified, the selectedDays property is required. Valid values are:

  • Daily
  • Weekly
operatingHoursId string ID of the operating hours record that specifies the time slots that the patient wants to schedule visits for.
schedulingPolicyId string Required

ID of the home health scheduling policy to be used to schedule the home visit.
recurringDaysList string Comma-delimited list of days to schedule recurring home visits for the patient. For example, Monday, Thursday, Saturday.

Required if the frequencyType property is set to Weekly.
secondCareResourceSkillsIdsList string A comma-delimited list of skill record IDs required for the second care resource of home visits.
serviceAppointmentAddress String Service appointment record that contains the home visit address specified by the user and is used to create the actual service appointment. Available in API version 66.0 and later.
serviceTerritoryId string Required

ID of the service territory record that contains the care resources to be assigned to the visits.
skillsIdsList List<String> Comma-delimited list of record IDs of all skills required for the home visits.
firstVisitStartDateTime datetime Required

Scheduled date and time for the start of the first home visit.
usageType string

Specifies the method of scheduling of home visits for the action. Valid value is: Manual.
visitsRequired integer Required

Number of recurring home visits to schedule.
visitSourceId string ID of the source from where visits are created.
workTypeIdsList List <String> A comma-delimited list of work type record IDs associated with the clinical service request of the home visit.
## Outputs
Output Type Description
careServiceVisitPlanId string

Required

ID of the care service visit plan record that’s associated with the service request.
serviceAppointmentId string The ID of the service appointment that was used as a template to manually schedule home visits.
## Example **POST** This sample request is for the Schedule Recurring Home Visit action. { "inputs": \[ { "schedulingPolicyId":"a0cSG0000002RlxxAE", "firstVisitStartDateTime":"2024-07-14T07:00:00.000Z", "firstVisitStartEndTime" : "2024-07-15T07:00:00.000Z", "visitsRequired" : 2, "frequencyType" : "DAILY", "selectedDays" : "Monday, Thursday", "clinicalServiceRequestId": "0jySG0000000VFxxAM", "skillsIdList": \["0C5xx0000004C92, 0C5xx0000004C93"\], "operatingHoursId": "0OHxx0000004CKKGA2", "accountId": "001SG00000LNllxxAT", "serviceTerritoryId": "0HxxG00000047xN0AQ", "firstCareResourceSkillsIdsList": \[0D2xx0000008DC91, 0D2xx0000008DC91\], "secondCareResourceSkillsIdsList": \[0P5xx0000004F16, 0P5xx0000004F16\], "careResourceCount" : 1, "workTypeIdsList": \["08qSG0000002b1xxAA"\], "visitSourceId": \["0Q0SG000000821R0xx"\] } \] } This sample response is for the Schedule Recurring Home Visit action. \[ { "actionName" : "scheduleRecurringHomeVisit", "errors" : null, "isSuccess" : true, "outputValues" : { "careServiceVisitPlanId": "0qExx00000000WHEAY" "serviceAppointmentId": "0bZxx00000000yKEDB" }, "version" : 1 } \] # ScheduleBrdcstApptResource Represents a junction between a Schedule Broadcast Appointment and a Service Resource. This object represents the resources to whom a schedule broadcast is sent. 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 ### AppointmentStatus - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the appointment that's broadcasted to the resource. - **Default value**: Unassigned - **Possible values**: - Accepted - Assigned - Expired - Rejected - Unassigned ### 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 name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### ResourceReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The resource to whom the schedule broadcast appointment is sent. This field is a polymorphic relationship field. - **Relationship Name**: ResourceReference - **Relationship Type**: Lookup - **Refers To**: ServiceResource ### ScheduleBroadcastAppointmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The schedule broadcast appointment associated with the schedule broadcast appointment resource. This field is a relationship field. - **Relationship Name**: ScheduleBroadcastAppointment - **Relationship Type**: Lookup - **Refers To**: ScheduleBroadcastAppointment ## 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. [ScheduleBrdcstApptResourceChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBrdcstApptResourceFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBrdcstApptResourceHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBrdcstApptResourceShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ScheduleBroadcast Represents a broadcast of appointments that's sent to resources of specific service territories. 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 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 name of the record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The status of the schedule broadcast. - **Default value**: Created - **Possible values**: - Completed - Created - Failed - InProgress ## 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. [ScheduleBroadcastChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ScheduleBroadcastAppointment Represents appointments that schedulers broadcast to resources using a schedule broadcast. 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 ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The address of the appointment where the home visit is performed. ### AppointmentReferenceId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The appointment associated with the schedule broadcast appointment. This field is a polymorphic relationship field. - **Relationship Name**: AppointmentReference - **Relationship Type**: Lookup - **Refers To**: ServiceAppointment, Visit ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The city of the appointment address. ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The country of the appointment address. ### EndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the appointment. ### GeocodeAccuracy - **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—Extended Zip - NearAddress—Near Address - Neighborhood - State - Street - Unknown - Zip ### IsAccepted - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a care resource has accepted the appointment (true) or not (false). - **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. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Longitude to specify the precise geolocation of the address. ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with Latitude to specify the precise geolocation of the address. ### 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 owner of the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The postal code of the appointment address. ### ScheduleBroadcastId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The schedule broadcast associated with the schedule broadcast appointment. This field is a relationship field. - **Relationship Name**: ScheduleBroadcast - **Relationship Type**: Lookup - **Refers To**: ScheduleBroadcast ### StartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the appointment. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The state of the appointment address. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The street of the appointment address. ### WorkTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The work type associated with the schedule broadcast appointment. 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. [ScheduleBroadcastAppointmentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastAppointmentFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastAppointmentHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastAppointmentShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ScheduleBroadcastTerritory Represent service territories to which a schedule broadcast is sent. 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 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 name of the record. ### ScheduleBroadcastId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The parent schedule broadcast associated with the schedule broadcast territory. This field is a relationship field. - **Relationship Name**: ScheduleBroadcast - **Relationship Type**: Master-Detail - **Refers To**: ScheduleBroadcast ### ServiceTerritoryId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The service territory associated with the schedule broadcast. This field is a polymorphic relationship field. - **Relationship Name**: ServiceTerritory - **Relationship Type**: Lookup - **Refers To**: ServiceTerritory ## 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. [ScheduleBroadcastTerritoryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastTerritoryFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ScheduleBroadcastTerritoryHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # Scope of Appointment (SOA) Insurance Book Slot (POST) Book a follow-up appointment slot for a Scope of Appointment (SOA) insurance consultation with 48-hour compliance and agent prioritization. ## Resource /connect/health/soa-insurance/book-slot ## Available Version 67.0 ## HTTP Methods POST ## JSON example { "accountId": "001xx000003DGb2AAG", "engagementChannelTypeId": "0Hxxx0000000001", "schedulingPolicyId": "0Hlxx0000000001", "slotRangeEnd": "2026-09-01T12:00:00.000Z", "slotRangeStart": "2026-09-01T10:00:00.000Z", "soaId": "a0Xxx0000000001", "territoryId": "0Hpxx0000000001", "workTypeId": "08qxx0000000001" } ## Properties | Property Name | Type | Description | | --- | --- | --- | | account​Id | String | Elderly customer Account identifier. | | engagement​Channel​Type​Id | List | Appointment channel identifier (Phone, Video, etc.). Required only when AFA and Service Territory Member Shifts are enabled. | | scheduling​Policy​Id | String | Lightning Scheduler Scheduling Policy identifier. | | slot​Range​End | String | Preferred booking window end time in ISO 8601 format. Must be later than slotRangeStart. | | slot​Range​Start | String | Preferred booking window start time in ISO 8601 format. Must be at least 48 hours in the future. | | soa​Id | String | Salesforce Scope of Appointment (SOA) record identifier. | | territory​Id | List | Service Territory identifier. | | work​Type​Id | String | Salesforce Scheduler WorkType identifier. | ## Response Body for POST [Scope of Appointment (SOA) Insurance Book Slot Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_soa_insurance_book_slot_result.htm "Scope of Appointment (SOA) insurance book slot result.") # Scope of Appointment (SOA) Insurance Book Slot Input Scope of Appointment (SOA) insurance book slot input. ## JSON example { "accountId": "001xx000003DGb2AAG", "engagementChannelTypeId": "0Hxxx0000000001", "schedulingPolicyId": "0Hlxx0000000001", "slotRangeEnd": "2026-09-01T12:00:00.000Z", "slotRangeStart": "2026-09-01T10:00:00.000Z", "soaId": "a0Xxx0000000001", "territoryId": "0Hpxx0000000001", "workTypeId": "08qxx0000000001" } ## Properties | Property Name | Type | Description | | --- | --- | --- | | account​Id | String | Elderly customer Account identifier. | | engagement​Channel​Type​Id | List | Appointment channel identifier (Phone, Video, etc.). Required only when AFA and Service Territory Member Shifts are enabled. | | scheduling​Policy​Id | String | Lightning Scheduler Scheduling Policy identifier. | | slot​Range​End | String | Preferred booking window end time in ISO 8601 format. Must be later than slotRangeStart. | | slot​Range​Start | String | Preferred booking window start time in ISO 8601 format. Must be at least 48 hours in the future. | | soa​Id | String | Salesforce Scope of Appointment (SOA) record identifier. | | territory​Id | List | Service Territory identifier. | | work​Type​Id | String | Salesforce Scheduler WorkType identifier. | # Scope of Appointment (SOA) Insurance Book Slot Result Scope of Appointment (SOA) insurance book slot result. ## Properties | Property Name | Type | Description | | --- | --- | --- | | assigned​Resource​Id | String | Assigned ServiceResource identifier | | assigned​Resource​Name | String | Assigned resource display name | | booked​End​Time | String | Confirmed booking end datetime in ISO 8601 format | | booked​Start​Time | String | Confirmed booking start datetime in ISO 8601 format | | error​Code | String | Machine-readable error identifier | | error​Message | String | Human-readable error description | | is​Success | Boolean | Indicates overall booking result | | service​Appointment​Id | String | Created ServiceAppointment identifier | | soa​Booking​Id | String | Persisted Scope of Appointment booking (SOA\_Booking\_\_c) record identifier | # ScoreCategory Represents the category and subcategories that form a unified health profile in the Unified Health Scoring feature. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ScoreCategory components have the suffix .scoreCategory and are stored in the scoreCategories folder. ## Version ScoreCategory components are available in API version 55.0 and later. ## Special Access Rules You need the Unified Health Scoring license to use this metadata type. ## Field ### categoryName - **Field Type**: string - **Description**: Required. The name of the score category. ### description - **Field Type**: string - **Description**: Required. The description of the score category. ### developerName - **Field Type**: string - **Description**: Required. 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 unique name prevents conflicts with rules from other packages that have the same masterLabel. ### iconUrl - **Field Type**: string - **Description**: Required. The URL for the image used as the icon of the score category. ### masterLabel - **Field Type**: string - **Description**: Required. The user interface label of the score category record. ### parentCategoryId - **Field Type**: string - **Description**: The score category that the category is a part of. Do not use this field for top-level categories that represent unified health profiles. ### scoreCategoryCalcInsights - **Field Type**: [ScoreCategoryCalcInsight\[\]](#subtype_ScoreCategoryCalcInsight) - **Description**: Maps the score category to its calculated insight in Data Cloud. ### scoreRangeClassifications - **Field Type**: [ScoreRangeClassification\[\]](#subtype_ScoreRangeClassification) - **Description**: Specifies the different score ranges and their classifications for the score category. ## ScoreCategoryCalcInsight Maps the score category to its calculated insight in Data Cloud. Use this subtype type only if you’re using Data Cloud to calculate scores for Unified Health Scoring. ### insightDateFieldName - **Field Type**: string - **Description**: Required. The API name of the date field in the calculated insight that specifies when the last calculation was processed. ### insightName - **Field Type**: string - **Description**: Required. The API name of the calculated insight that derives scores for the category. ### insightScoreFieldName - **Field Type**: string - **Description**: Required. The API name of the field in the calculated insight that specifies the derived scores. This field is the field that’s defined as the measure of the calculated insight. ### insightSubjectFieldName - **Field Type**: string - **Description**: Required. The API name of the field in the calculated insight that references the subject of the score. The referenced subject is either an account, lead, or contact. This field is the field that’s defined as the dimension of the calculated insight. ## ScoreRangeClassification Represents the score ranges of a score category and how scores in those ranges are interpreted. ### classificationName - **Field Type**: string - **Description**: Required. The interpretation or classification of scores in the specified range. Example: Good, Great, Excellent ### colorHexadecimalCode - **Field Type**: string - **Description**: Required. The hexadecimal code for the color that represents the range and its interpretation. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_tip.png) #### Tip Be mindful of cultural differences when you choose a color code. Different colors mean different things in different cultures. ### rangeEndValue - **Field Type**: double - **Description**: Required. The end point of a score range classification. ### rangeStartValue - **Field Type**: double - **Description**: Required. The start point of a score range classification. ## Declarative Metadata Sample Definition The following is an example of a ScoreCategory component. Environmental Score 2 This is second Environmental score for a person env\_score2 https://duckduckgo.com/assets/logo\_header.dddv108.svg Env Score 2 The following is an example package.xml that references the previous definition. \* ScoreCategory 55.0 ## 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). # ScoreCategory Represents the categories that are scored in a unified health profile. This object is available in API version 55.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ## Special Access Rules Requires the Unified Health Scoring license. ## Fields ### CategoryName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The name of the scored category in a unified health profile. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the category. ### DeveloperName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: 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 unique name prevents conflicts with rules from other packages that have the same masterLabel. ### IconUrl - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The URL for the image used as the icon of the score category. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of ScoreCategory. - **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, idLookup, Nillable, Sort, Update - **Description**: Label that identifies the ScoreCategory 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. ### ParentCategoryId - **Type**: Master-Detail - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The category that the score category is a part of. Don’t use this field if you’re defining a top-level score category to represent the a unified health profile. This field is a relationship field. - **Refers To**: ScoreCategory ## Usage Define a unified health profile by creating a score category to represent it. Further define this category by classifying its score ranges and add subcategories. # ScoreCategoryCalcInsight Represents how a score category in Unified Health Scoring is mapped to a calculated insight in Salesforce CDP. Use this object only if you use CDP to calculate scores for Unified Health Scoring. This object is available in API version 55.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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 ## Special Access Rules ## Fields ### InsightDateFieldName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The API name of the date field in the calculated insight that specifies when the last calculation was processed. ### InsightName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of the calculated insight that derives scores for the category. ### InsightScoreFieldName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of the field in the calculated insight that specifies the derived scores. This field is the field that’s defined as the measure of the calculated insight. ### InsightSubjectFieldName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The API name of the field in the calculated insight that references the subject of the score. The referenced subject is either an account, lead, or contact. This field is the field that’s defined as the dimension of the calculated insight. ### ScoreCategoryId - **Type**: Master-detai; - **Properties**: Create, Filter, Group, Sort - **Description**: The score category that’s mapped to a calculated insight. - **Refers To**: ScoreCategory ## Usage Map a category to its calculated insight with the fields that correspond to the measure and dimension of the calculated insight. This mapping ensures that the scores fetched from CDP are assigned with the right category when they’re inserted into HealthScore. # ScoreRangeClassification Represents the different score ranges of a score category and how scores in those ranges are classified or interpreted. This object is available in API version 55.0 and later. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules Requires the Unified Health Scoring license. ## Fields ### ClassificationName - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The interpretation or classification of scores in the specified range. Example: Good, Great, Excellent ### ColorHexadecimalCode - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The hexadecimal code for the color that represents the range and its interpretation. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_tip.png) #### Tip Be mindful of cultural differences when you choose a color code. Different colors mean different things in different cultures. ### RangeEndValue - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The end point of a score range classification. ### RangeStartValue - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: The start point of a score range classification. ### ScoreCategoryId - **Type**: Master-detail - **Properties**: Create, Filter, Group, Sort - **Description**: The score category whose score range and classification are defined. This field is a relationship field. - **Refers To**: ScoreCategory ## Usage Define multiple ranges to cover the full range of a category’s score and classify how scores in each range are interpreted. Ensure that the ranges don’t overlap or leave any gaps between them. # Search Field Output representation of the search result field. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | developerName | String | The developer name of the field. | Small, 54.0 | 54.0 | | value | String | The value of the field. | Small, 54.0 | 54.0 | # 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 Output Output representation of the search response. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | isSuccess | Boolean | Indicates whether the result if successful (true) or not (false). | Small, 54.0 | 54.0 | | message | String | The request response message. | Small, 54.0 | 54.0 | | searchResult | [Search Result](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_search_result.htm "Output representation of the search result.")\[\] | Represents the search result fields. | Small, 54.0 | 54.0 | | searchResultHeader | [Search Result Header](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_search_result_header.htm "Output representation of the search result header.")\[\] | Represents the search result header field list. | Small, 54.0 | 54.0 | # Search Result Output representation of the search result. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | searchFields | [Search Field Representation](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_search_field.htm "Output representation of the search result field.")\[\] | List of search fields. | Small, 54.0 | 54.0 | # Search Result Header Output representation of the search result header. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | dataType | String | The data type of the field. | Small, 54.0 | 54.0 | | developerName | String | The developer name of the field. | Small, 54.0 | 54.0 | | displayLabel | String | The display label of the field. | Small, 54.0 | 54.0 | # SearchFilter Class Contains data filters that is applied in object-based search. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchFilter Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_constructors)** - **[SearchFilter Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_properties)** ## SearchFilter Constructors The following are constructors for SearchFilter. - **[SearchFilter(developerName, value)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_ctor)** Creates an instance of the [SearchFilter](#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.") class with the specified parameter values. - **[SearchFilter()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_ctor_2)** Creates an instance of the [SearchFilter](#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.") class. ### SearchFilter(developerName, value) Creates an instance of the [SearchFilter](#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.") class with the specified parameter values. #### Signature public SearchFilter(String developerName, String value) #### Parameters developerName Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Specifies the developer name of the field that must be searched in object-based search. value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Specifies the value filter to be applied on the field to be searched in object-based search. ### SearchFilter() Creates an instance of the [SearchFilter](#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.") class. #### Signature public SearchFilter() ## SearchFilter Properties The following are properties for SearchFilter. - **[developerName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_developerName)** Specifies the developer name of the field that must be searched in object-based search. - **[isSetDeveloperName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_isSetDeveloperName)** Indicates whether the developer name of the field is used as a search filter. - **[isSetValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_isSetValue)** Indicates whether the value of a field is used as a search filter. - **[value](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_id_verification_SearchFilter_value)** Specifies the value filter to be applied on the field to be searched in object-based search. ### developerName Specifies the developer name of the field that must be searched in object-based search. #### Signature public String developerName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### isSetDeveloperName Indicates whether the developer name of the field is used as a search filter. #### Signature public Boolean isSetDeveloperName {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### isSetValue Indicates whether the value of a field is used as a search filter. #### Signature public Boolean isSetValue {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### value Specifies the value filter to be applied on the field to be searched in object-based search. #### 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) # SearchFilters Class Contains a list of data filters to be applied for object-based search. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchFilters Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_constructors)** - **[SearchFilters Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_properties)** ## SearchFilters Constructors The following are constructors for SearchFilters. - **[SearchFilters(searchFilterList)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_ctor)** Creates an instance of the [SearchFilters](#apex_class_id_verification_SearchFilters "Contains a list of data filters to be applied for object-based search.") class with the specified parameter value. - **[SearchFilters()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_ctor_2)** Creates an instance of the [SearchFilters](#apex_class_id_verification_SearchFilters "Contains a list of data filters to be applied for object-based search.") class. ### SearchFilters(searchFilterList) Creates an instance of the [SearchFilters](#apex_class_id_verification_SearchFilters "Contains a list of data filters to be applied for object-based search.") class with the specified parameter value. #### Signature public SearchFilters(List searchFilterList) #### Parameters searchFilterList Type: List<[id\_verification.SearchFilter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.")\> Specifies the list of data filters that can be applied in object-based search. ### SearchFilters() Creates an instance of the [SearchFilters](#apex_class_id_verification_SearchFilters "Contains a list of data filters to be applied for object-based search.") class. #### Signature public SearchFilters() ## SearchFilters Properties The following are properties for SearchFilters. - **[isSetSearchFilterList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_isSetSearchFilterList)** Indicates whether a list of data filters is set in object-based search. - **[searchFilterList](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilters.htm#apex_id_verification_SearchFilters_searchFilterList)** Specifies the list of data filters that can be applied in object-based search. ### isSetSearchFilterList Indicates whether a list of data filters is set in object-based search. #### Signature public Boolean isSetSearchFilterList {get; set;} #### Property Value Type: [Boolean](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_boolean.htm) ### searchFilterList Specifies the list of data filters that can be applied in object-based search. #### Signature public List searchFilterList {get; set;} #### Property Value Type: List<[id\_verification.SearchFilter](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchFilter.htm#apex_class_id_verification_SearchFilter "Contains data filters that is applied in object-based search.")\> # SearchRequest Class Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchRequest Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_constructors)** - **[SearchRequest Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_properties)** ## SearchRequest Constructors The following are constructors for SearchRequest. - **[SearchRequest(searchTerm, searchFilters, verificationContext)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_ctor)** Creates an instance of the [SearchRequest](#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") class with the specified parameter values. - **[SearchRequest()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_ctor_2)** Creates an instance of the [SearchRequest](#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") class. ### SearchRequest(searchTerm, searchFilters, verificationContext) Creates an instance of the [SearchRequest](#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") class with the specified parameter values. #### Signature public SearchRequest(String searchTerm, List searchFilters, id\_verification.VerificationContext verificationContext) #### Parameters searchTerm Type: String Required. Specifies the search term for the account to use when performing a search. searchFilters Type: List Specifies the search criteria used for the object-based search. verificationContext Type: id\_verification.VerificationContext Required. Specifies the object that contains the setup data and context required to perform the search. ### SearchRequest() Creates an instance of the [SearchRequest](#apex_class_id_verification_SearchRequest "Contains information about the search request data. The search request represents search filters for object-based search, search terms for text-based search, and the verification context that includes the process definition, process details, and process fields.") class. #### Signature public SearchRequest() ## SearchRequest Properties The following are properties for SearchRequest. - **[searchFilters](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_searchFilters)** Specifies the search criteria used for the object-based search. - **[searchTerm](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_searchTerm)** Specifies the search term for the account to use when performing a search. - **[verificationContext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchRequest.htm#apex_id_verification_SearchRequest_verificationContext)** Specifies the object that contains the setup data and context required to perform the search. ### searchFilters Specifies the search criteria used for the object-based search. #### Signature public List searchFilters {get; set;} #### Property Value Type: List<[id\_verification.FieldValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.")\> ### searchTerm Specifies the search term for the account to use when performing a search. #### Signature public String searchTerm {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### verificationContext Specifies the object that contains the setup data and context required to perform the search. #### Signature public id\_verification.VerificationContext verificationContext {get; set;} #### Property Value Type: [id\_verification.VerificationContext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerificationContext.htm#apex_class_id_verification_VerificationContext "Contains information about the verification context, including the process definition, selected search result, selected verified result, and verified result.") # SearchResult Class Contains the contract of search results in tabular format for either the object-based or text-based search. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchResult Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_constructors)** - **[SearchResult Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_properties)** ## SearchResult Constructors The following are constructors for SearchResult. - **[SearchResult(searchResultHeaders, searchResultRows)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_ctor)** Creates an instance of the [SearchResult](#apex_class_id_verification_SearchResult "Contains the contract of search results in tabular format for either the object-based or text-based search.") class with the specified parameter values. - **[SearchResult()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_ctor_2)** Creates an instance of the [SearchResult](#apex_class_id_verification_SearchResult "Contains the contract of search results in tabular format for either the object-based or text-based search.") class. ### SearchResult(searchResultHeaders, searchResultRows) Creates an instance of the [SearchResult](#apex_class_id_verification_SearchResult "Contains the contract of search results in tabular format for either the object-based or text-based search.") class with the specified parameter values. #### Signature public SearchResult(List searchResultHeaders, List searchResultRows) #### Parameters searchResultHeaders Type: List<[id\_verification.SearchResultHeader](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.")\> Represents the search result header field list that contains the metadata information of the columns that are part of the search result. searchResultRows Type: List<[id\_verification.SearchResultRow](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.")\> Represents the search result row field list that contains the column values for a specific row. ### SearchResult() Creates an instance of the [SearchResult](#apex_class_id_verification_SearchResult "Contains the contract of search results in tabular format for either the object-based or text-based search.") class. #### Signature public SearchResult() ## SearchResult Properties The following are properties for SearchResult. - **[searchResultHeaders](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_searchResultHeaders)** Represents the search result header field list that contains the metadata information of the columns that are part of the search result. - **[searchResultRows](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResult.htm#apex_id_verification_SearchResult_searchResultRows)** Represents the search result row field list that contains the column values for a specific row. ### searchResultHeaders Represents the search result header field list that contains the metadata information of the columns that are part of the search result. #### Signature public List searchResultHeaders {get; set;} #### Property Value Type: List<[id\_verification.SearchResultHeader](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.")\> ### searchResultRows Represents the search result row field list that contains the column values for a specific row. #### Signature public List searchResultRows {get; set;} #### Property Value Type: List<[id\_verification.SearchResultRow](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.")\> # SearchResultHeader Class Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchResultHeader Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_constructors)** - **[SearchResultHeader Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_properties)** ## SearchResultHeader Constructors The following are constructors for SearchResultHeader. - **[SearchResultHeader(developerName, dataType, displayLabel)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_ctor)** Creates an instance of the [SearchResultHeader](#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.") class with the specified parameter values. - **[SearchResultHeader()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_ctor_2)** Creates an instance of the [SearchResultHeader](#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.") class. ### SearchResultHeader(developerName, dataType, displayLabel) Creates an instance of the [SearchResultHeader](#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.") class with the specified parameter values. #### Signature public SearchResultHeader(String developerName, String dataType, String displayLabel) #### Parameters developerName Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Represents the developer name of the field. dataType Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Represents the data type of the header field. displayLabel Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Represents the label of the field. ### SearchResultHeader() Creates an instance of the [SearchResultHeader](#apex_class_id_verification_SearchResultHeader "Contains information about the search result header field list. This list represents the metadata information of the columns that are part of the search result.") class. #### Signature public SearchResultHeader() ## SearchResultHeader Properties The following are properties for SearchResultHeader. - **[dataType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_dataType)** Represents the data type of the header field. - **[developerName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_developerName)** Represents the developer name of the field. - **[displayLabel](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultHeader.htm#apex_id_verification_SearchResultHeader_displayLabel)** Represents the label of the field. ### dataType Represents the data type of the header field. #### Signature public String dataType {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### developerName Represents the developer name of the field. #### Signature public String developerName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### displayLabel Represents the label of the field. #### Signature public String displayLabel {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) # SearchResultRow Class Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SearchResultRow Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_id_verification_SearchResultRow_constructors)** - **[SearchResultRow Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_id_verification_SearchResultRow_properties)** ## SearchResultRow Constructors The following are constructors for SearchResultRow. - **[SearchResultRow(searchResultFieldValues)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_id_verification_SearchResultRow_ctor)** Creates an instance of the [SearchResultRow](#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.") class with the specified parameter values. - **[SearchResultRow()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_id_verification_SearchResultRow_ctor_2)** Creates an instance of the [SearchResultRow](#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.") class. ### SearchResultRow(searchResultFieldValues) Creates an instance of the [SearchResultRow](#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.") class with the specified parameter values. #### Signature public SearchResultRow(List searchResultFieldValues) #### Parameters searchResultFieldValues Type: List<[id\_verification.FieldValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.")\> A list of object record fields on which the data has been verified. ### SearchResultRow() Creates an instance of the [SearchResultRow](#apex_class_id_verification_SearchResultRow "Contains information about the search result row field list. This list represents the column values for a specific row that are part of the search result.") class. #### Signature public SearchResultRow() ## SearchResultRow Properties The following are properties for SearchResultRow. - **[searchResultFieldValues](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SearchResultRow.htm#apex_id_verification_SearchResultRow_searchResultFieldValues)** A list of object record fields on which the data has been verified. ### searchResultFieldValues A list of object record fields on which the data has been verified. #### Signature public List searchResultFieldValues {get; set;} #### Property Value Type: List<[id\_verification.FieldValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.")\> # Selected Search Result Input Input representation for the selected search result. ## Root XML tag ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | objectName | String | The name of the object to be verified. | Required | 54.0 | | selectedRecordId | String | The object record ID on which the data is to be verified. | Required | 54.0 | | selectedRecordObject | [Field Value Input](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_field_value_input.htm "Input representation for each field.")\[\] | The object record fields on which the data is to be verified. | Optional | 54.0 | # Selected Search Result Output Represents the selected search result. | Property Name | Type | Description | Filter Group and Version | Available Version | | --- | --- | --- | --- | --- | | objectName | String | The API name of the object. | Small, 54.0 | 54.0 | | selectedRecordId | String | The record ID of the caller. | Small, 54.0 | 54.0 | | selectedRecordObject | [Field Value Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_field_value_output.htm "Represents the value of a field.") | The API name of the caller’s object. | Small, 54.0 | 54.0 | # SelectedSearchResult Class Contains the details of the record that has been selected for verification. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SelectedSearchResult Constructors](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_constructors)** - **[SelectedSearchResult Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_properties)** ## SelectedSearchResult Constructors The following are constructors for SelectedSearchResult. - **[SelectedSearchResult(selectedRecordId, objectName, selectedRecordObject)](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_ctor)** Creates an instance of the [SelectedSearchResult](#apex_class_id_verification_SelectedSearchResult "Contains the details of the record that has been selected for verification.") class with the specified parameter values. - **[SelectedSearchResult()](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_ctor_2)** Creates an instance of the [SelectedSearchResult](#apex_class_id_verification_SelectedSearchResult "Contains the details of the record that has been selected for verification.") class. ### SelectedSearchResult(selectedRecordId, objectName, selectedRecordObject) Creates an instance of the [SelectedSearchResult](#apex_class_id_verification_SelectedSearchResult "Contains the details of the record that has been selected for verification.") class with the specified parameter values. #### Signature public SelectedSearchResult(String selectedRecordId, String objectName, List selectedRecordObject) #### Parameters selectedRecordId Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Required. Specifies the object record ID on which the data is to be verified. objectName Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) Required. Specifies the name of the object to be verified. selectedRecordObject Type: List<[id\_verification.FieldValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.")\> Specifies the object record fields on which the data is to be verified. ### SelectedSearchResult() Creates an instance of the [SelectedSearchResult](#apex_class_id_verification_SelectedSearchResult "Contains the details of the record that has been selected for verification.") class. #### Signature public SelectedSearchResult() ## SelectedSearchResult Properties The following are properties for SelectedSearchResult. - **[objectName](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_objectName)** Specifies the name of the object to be verified. - **[selectedRecordId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_selectedRecordId)** Specifies the object record ID on which the data is to be verified. - **[selectedRecordObject](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedSearchResult.htm#apex_id_verification_SelectedSearchResult_selectedRecordObject)** Specifies the object record fields on which the data is to be verified. ### objectName Specifies the name of the object to be verified. #### Signature public String objectName {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### selectedRecordId Specifies the object record ID on which the data is to be verified. #### Signature public String selectedRecordId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### selectedRecordObject Specifies the object record fields on which the data is to be verified. #### Signature public List selectedRecordObject {get; set;} #### Property Value Type: List<[id\_verification.FieldValue](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_FieldValue.htm#apex_class_id_verification_FieldValue "Contains a key-value pair represented by the developer name and value of the field. The key-value pair is used for both search results and verification.")\> # SelectedVerifiedResult Class Contains information about the verified object that is used for the secondary search. ## Namespace [id\_verification](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_id_verification.htm "The id_verification namespace provides an interface and classes for Health Cloud to verify the caller’s identity.") - **[SelectedVerifiedResult Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedVerifiedResult.htm#apex_id_verification_SelectedVerifiedResult_properties)** ## SelectedVerifiedResult Properties The following are properties for SelectedVerifiedResult. - **[verifiedDetails](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_SelectedVerifiedResult.htm#apex_id_verification_SelectedVerifiedResult_verifiedDetails)** A list of details about the verified object that is used for secondary search. ### verifiedDetails A list of details about the verified object that is used for secondary search. #### Signature public List verifiedDetails {get; set;} #### Property Value Type: List<[id\_verification.VerifiedDetails](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_id_verification_VerifiedDetails.htm#apex_class_id_verification_VerifiedDetails "Contains details about the verified object that is used for secondary search, including the process that’s used to verify the search object.")\> # Serialize Identity Verification Context Action Returns a JSON array of identity verification field descriptors that an Agentforce agent uses to collect caller answers. This action is available in API version 68.0 and later. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/serializeVerificationContext 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
verificationContext Reference Required

An Apex id_verification__VerificationContext record that represents the active identity verification session.
## Outputs | Output | Type | Description | | --- | --- | --- | | verificationFields | Array | A JSON array of verification field descriptors with empty answer placeholders. For example, \[{"label":"Date of Birth","answer":"","developerName":"Birthdate\_Field"}\]. The agent populates each answer and passes the array as callerAnswers to the Identity Verification flow. | ## Example **Sample Request** { "inputs": \[ { "verificationContext": { "processDefinition": { "developerName": "StandardIdentityVerification" } } } \] } **Sample Response** \[ { "verificationFields": \[ { "label": "Date of Birth", "answer": "", "developerName": "Birthdate\_Field" }, { "label": "ZIP Code", "answer": "", "developerName": "ZipCode\_Field" } \] } \] # 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 # ServiceAppointmentAsset Represents a junction between Service Appointment and Asset. This junction object enables admins to associate a patient appointment to an asset such as a piece of medical equipment. 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 To access this object, you must have the Health Cloud Appointment Management permission set. ## Fields ### AssetId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The asset associated with the service appointment. This field is a relationship field. - **Relationship Name**: Asset - **Refers To**: Asset ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset is required for the appointment (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**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the service appointment asset 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 ### ServiceAppointmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Required. The service appointment associated with the asset. This field is a relationship field. - **Relationship Name**: ServiceAppointment - **Refers To**: ServiceAppointment ## 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. [ServiceAppointmentAssetHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceAppointmentAssetOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceAppointmentAssetShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRequestDetail Represents additional details about a service information request, such as the detail type and detail code. 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 ### DetailCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code for the issue encountered while processing the request. This field is a polymorphic relationship field. - **Relationship Name**: DetailCode - **Refers To**: CodeSet, CodeSetBundle ### DetailCodeType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of issue encountered while processing the request. ### DetailType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of detail added to the service information request. For example, an issue encountered while processing the request. - **Possible values**: - Assertion Identifier - Issue - OrderDetail ### DetailValue - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value of the detail type. For example, the assertion ID when the detail type is Assertion Identifier. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### ServiceInformationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated service information request. This field is a relationship field. - **Relationship Name**: ServiceInformationRequest - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationRequest (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. [ServiceInfoRequestDetailChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRequestDetailFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRequestDetailHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRequestOperation Represents the system operation performed for a service information request such as a session launch or a questionnaire package operation. 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 ### InitiatedDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the operation was initiated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OperationType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The system operation performed for the service information request. ### QuestionnaireUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The canonical URL of the questionnaire associated with the service information request operation. ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response for the operation was sent. ### ResponseStatusCode - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The status code of the response. ### ServiceInformationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The service information request associated with the operation. This field is a relationship field. - **Relationship Name**: ServiceInformationRequest - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationRequest (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. [ServiceInfoRequestOperationChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRequestOperationFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRequestOperationHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoResponseAction Represents actions to be performed as suggested by a service information response. 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 ### Context - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The context in which the action is performed. ### ContextIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the context. ### Description - **Type**: textarea - **Properties**: Create, Update - **Description**: The description of the service information response action. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### 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 user who owns the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### ResponseReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The record of the object that's related to the service information response action. This field is a polymorphic relationship field. - **Relationship Name**: ResponseReferenceRecord - **Refers To**: ServiceInfoRespSuggestion, ServiceInformationResponse ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of action to be performed. - **Possible values**: - CREATE—Create - DELETE—Delete - UPDATE—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. [ServiceInfoResponseActionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseActionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseActionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseActionShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoResponseCoverage Represents coverage details about a service information response. For example, if additional information or documentation is required for the coverage to be provided. 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 ### AssertionDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date on which the coverge assertion was made. ### CoverageAssertionIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the coverage assertion. ### CoverageIndicator - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies if the requested service is covered under the insurance plan. - **Possible values**: - conditional - covered - not-covered ### CoveragePlanTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of plan the coverage assertion falls under. This field is a polymorphic relationship field. - **Relationship Name**: CoveragePlanType - **Refers To**: CodeSet, CodeSetBundle, PurchaserPlan ### DocRequiredReason - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies why the additional documentation is required for coverage to be provided. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### MemberPlanId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The member plan associated with the service information response coverage. This field is a relationship field. - **Relationship Name**: MemberPlan - **Refers To**: MemberPlan ### 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 user who owns the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### PreapprovalIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique identifier of the preapproval, if satisfied. ### PreapprovalRequirementInd - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies if preapproval is required for coverage to be provided. ### ReferenceUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL of the reference used for determining the coverage information. ### RequiredAddlInfoType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the type of additional information required for coverage to be provided. For example, the performer and location of the service. ### RequiredDocumentationType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of additional documentation required for coverage to be provided. - **Possible values**: - admin - clinical - conditional ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated service information response. This field is a polymorphic relationship field. - **Relationship Name**: ServiceInformationResponse - **Refers To**: ServiceInformationResponse ## 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. [ServiceInfoResponseCoverageChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseCoverageFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseCoverageHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoResponseCoverageShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRespOvrideOpt Represents the possible reasons for overriding a service information response. 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 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OverrideReasonCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The code representing a possible reason for overriding the service information response. This field is a polymorphic relationship field. - **Relationship Name**: OverrideReasonCode - **Refers To**: CodeSet ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The asscoiated service information response. This field is a relationship field. - **Relationship Name**: ServiceInformationResponse - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationResponse (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. [ServiceInfoRespOvrideOptChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespOvrideOptFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespOvrideOptHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRespResourceUrl Represents the URLs of resources relevant to a service information response. 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 ### AdditionalNote - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional information about the URL. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: A human-readable name for the URL. ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated service information response. This field is a relationship field. - **Relationship Name**: ServiceInformationResponse - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationResponse (the master object) ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Specifies the type of URL. ### Url - **Type**: url - **Properties**: Create, Filter, Sort, Update - **Description**: The URL that loads the resource. ## 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. [ServiceInfoRespResourceUrlChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespResourceUrlFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespResourceUrlHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRespSuggestion Represents suggestions in a service information response. For example, suggesting a change in medication dosage. 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 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the service information response suggestion. ### ServiceInformationResponseId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The associated service information response. This field is a relationship field. - **Relationship Name**: ServiceInformationResponse - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationResponse (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. [ServiceInfoRespSuggestionChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespSuggestionFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRespSuggestionHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInformationRequest Represents information about a service information request, such as the date and time when the request was submitted and the type of service requested. 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 ### AccessTokenUsageStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the usage status of the access token that was sent with the request. ### ApplicationUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL of the application used by the requester. ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the service information request. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### ClientSourceSysIdentifier - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: An identifier of the client's source system that sent the request. ### ContextType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the context from which the service information request was launched. ### DocRequiredReasonType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Indicates the reason why the documentation is required. For example, it may be required to be submitted with a prior-auhtorization or claim. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### 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 user who owns the record. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Refers To**: Group, User ### RecipientOrgIdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The unique identifier of the organization to whom the request was sent. This field is a polymorphic relationship field. - **Relationship Name**: RecipientOrgIdentifier - **Refers To**: Identifier ### RequestDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The date and time when the request was recieved. ### RequestPayload - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The input payload sent as part of the request. ### RequesterExternalIdentifier - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The identifier of the user who sent the request, as recorded in an external system. This field is available in API version 64.0 and later. ### RequesterOrgExtlIdentifier - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The identifier of the organization that sent the request, as recorded in an external system. This field is available in API version 64.0 and later. ### RequesterOrgStdIdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique standard identifier of the organization that sent the request. This field is a polymorphic relationship field. - **Relationship Name**: RequesterOrgStdIdentifier - **Refers To**: Identifier ### RequesterStandardIdentifierId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unique standard identifier of the user who sent the request. This field is a polymorphic relationship field. - **Relationship Name**: RequesterStandardIdentifier - **Refers To**: Identifier ### ResponseCode - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The status code returned in response to the request. ### ResponseDateTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when the response to the request was sent. ### ServiceType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the type of service that was requested. - **Possible values**: - order-echo - order-sign ### SourceType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of system that captured the request. - **Possible values**: - payer-sourced - provider-sourced ### SvcRqstInvocationIdentifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the service request invocation. ### UsageType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the usage type of the service information request. For example, Coverage Requirement Discovery (CRD) or Documentation Templates and Rules (DTR). - **Possible values**: - CRD - DTR - 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. [ServiceInformationRequestChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationRequestShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInformationResponse Represents a response to a service information request. 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 ### AdditionalNote - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Additional information related to the response. ### FocusType - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies the types of data the response focuses on. - **Possible values**: - MedicationRequest - ServiceRequest ### Identifier - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique identifier of the response. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### ReferenceSourceCategoryCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the category that the reference source belongs to. This field is a polymorphic relationship field. - **Relationship Name**: ReferenceSourceCategoryCode - **Refers To**: CodeSet ### ReferenceSourceIconUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL to the icon representing the source of information of the response. The icon should be a 100x100 pixel PNG image without any transparent region. ### ReferenceSourceName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The name of the source of information for the response. ### ReferenceSourceUrl - **Type**: url - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The URL to the source of information for the response. ### ResponseEngagementStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the engagement status of the response. ### ResponseSubtype - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the subtype of service information response. For example, coverage info, cost, network, etc. ### ResponseType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of service information response. For example, card or system action. - **Possible values**: - Card - SystemAction—System Action ### ServiceInformationRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The service information request for which the response is sent. This field is a relationship field. - **Relationship Name**: ServiceInformationRequest - **Relationship Type**: Master-detail - **Refers To**: ServiceInformationRequest (the master object) ### SuggestionSelectionType - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of selection to be made for the suggestions in the response. ### Summary - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The summary of the response. ### UrgencyIndicator - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates how urgent the content of the response is. - **Possible values**: - info - warning ## 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. [ServiceInformationResponseChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationResponseFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInformationResponseHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # ServiceInfoRqstOpOutcome Represents the outcome of a service information request operation. 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 ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The date when the record was last viewed. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the record. ### OutcomeCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The code of the service information request operation outcome. This field is a relationship field. - **Relationship Name**: OutcomeCode - **Refers To**: CodeSetBundle ### OutcomeType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Specifies the type of service information request operation outcome. ### ServiceInfoRequestOperationId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The service information request operation associated with the outcome. This field is a relationship field. - **Relationship Name**: ServiceInfoRequestOperation - **Relationship Type**: Master-detail - **Refers To**: ServiceInfoRequestOperation (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. [ServiceInfoRqstOpOutcomeChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRqstOpOutcomeFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [ServiceInfoRqstOpOutcomeHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/Mappings_FHIR/images/srd_hc_servicerequest.png) #### See Also - [ClinicalServiceRequest](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/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 | # SharedSavingPaymentAgreement Specifies the payment terms for contracts of Shared Saving Payment Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BenchmarkEndDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The end date of the benchmark period based on which the profit or loss is determined for the Shared Saving payment type. ### BenchmarkStartDateTime - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: The start date of the benchmark period based on which the profit or loss is determined for the Shared Saving payment type. ### BenchmarkedExpenditureAmount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: This is the expenditure amount for the selected benchmark period. ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this shared savings payment agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### ForecastedExpenditureAmount - **Type**: currency - **Properties**: Create, Filter, Sort, Update - **Description**: This is the expenditure amount that's forecasted for the contract payment agreement duration. ### 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. ### LossPlanDescription - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The description of the shared savings payment agreement in case of a loss. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: The name of the shared savings payment agreement. ### ProfitPlanDescription - **Type**: textarea - **Properties**: Create, Update - **Description**: The description of the shared savings payment agreement when a profit is attained. ### QualifyingProfitPercentage - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The minimum profit percentage to be reached to share the profit. ## 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. [SharedSavingPaymentAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [SharedSavingPaymentAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [SharedSavingPaymentAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # SkillType Represents the broader type or category that a skill belongs to. This object is available in API version 58.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. 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. ### Language - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The language of the define skill type. Possible values are: ### MasterLabel - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the skill type. ## Usage Skills are grouped into types and categories by first defining a SkillType and then referencing that SkillType when you create a skill. # Slot Class Represents the time period slot details for the appointment. ## Namespace [healthcloudext](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_namespace_healthcloudext.htm "The HealthCloudExt namespace provides an interface and classes for Health Cloud to integrate with a source electronic health records (EHR) system.") - **[Slot Properties](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_properties)** ## Slot Properties The following are properties for Slot. - **[slotEnd](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_slotEnd)** Represents the date and time that the appointment time slot ends in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.. - **[slotStart](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_slotStart)** Represents the date and time that the appointment time slot starts in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.. - **[slotStatus](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_slotStatus)** Represents the status of the time slot. - **[sourceSlotId](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_sourceSlotId)** Represents the ID of the time slot in the external scheduling system. - **[sourceSystem](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/apex_class_healthcloudext_Slot.htm#apex_healthcloudext_Slot_sourceSystem)** Represents the name of the external scheduling system from which the record was sourced. ### slotEnd Represents the date and time that the appointment time slot ends in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.. #### Signature public String slotEnd {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotStart Represents the date and time that the appointment time slot starts in ISO 8601 format, for example, 2021-02-26T21:24:31.000Z.. #### Signature public String slotStart {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### slotStatus Represents the status of the time slot. #### Signature public String slotStatus {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) The expected value for the string is SlotAvailable, SlotNotAvailable, or ServiceNotAvailable. ### sourceSlotId Represents the ID of the time slot in the external scheduling system. #### Signature public String sourceSlotId {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.htm) ### sourceSystem Represents the name of the external scheduling system from which the record was sourced. #### Signature public String sourceSystem {get; set;} #### Property Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_methods_system_string.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. You must have the Health Cloud managed package installed in your org to add the social determinants data model. The social determinants standard objects are visible to users with the Health Cloud and the Health Cloud Platform permission set licenses and the Health Cloud Permission Set License and Health Cloud Social Determinants permission sets. ![Social determinants entity-relationship diagram](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/dev_guides/healthcare_api/images/social_determinants_ERD.png) - **[CareBarrier](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carebarrier.htm)** Represents the circumstances or obstacles affecting a patient or member. Available in API version 45.0 and later. - **[CareBarrierDeterminant](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carebarrierdeterminant.htm)** Represents the relationship of a barrier to a determinant for a patient or member. Available in API version 45.0 and later. - **[CareBarrierType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_carebarriertype.htm)** Represents the standard, defined list of barriers maintained by an organization. Available in API version 45.0 and later. - **[CareDeterminant](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caredeterminant.htm)** Represents the determinants of health for a patient such as availability of safe housing, adequate employment, or local food markets. Available in API version 45.0 and later. - **[CareDeterminantType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_caredeterminanttype.htm)** Represents the standard, defined list of determinants of health maintained by an organization, including the domain and type. Available in API version 45.0 and later. - **[CareInterventionType](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_objects_careinterventiontype.htm)** Represents the standard, defined list of interventions maintained by an organization. Available in API version 45.0 and later. #### See Also - [_Salesforce Help_: Social Determinants of Health](https://help.salesforce.com/s/articleView?id=ind.landing_social_determinants.htm&language=en_US) # Specimen Represents a sample used for analysis. This object is available in API version 64.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### BodySiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The body site code set bundle associated with a specimen that represents the anatomical collection site. This field is a relationship field. - **Relationship Name**: BodySite - **Refers To**: CodeSet ### CaseId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The case associated with the specimen. This field is a relationship field. - **Relationship Name**: Case - **Refers To**: Case ### CollectionDeviceCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The device code set bundle associated with a specimen that represents the device used to collect the specimen. For example, SST tube, red top tube, or 100-mL sterile polycup. This field is a relationship field. - **Relationship Name**: CollectionDeviceCode - **Refers To**: CodeSet ### CollectionDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total time period over which the specimen was collected. ### CollectionDurationUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure of the collection duration. This field is a relationship field. - **Relationship Name**: CollectionDurationUom - **Refers To**: UnitOfMeasure ### CollectionEndDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The end date and time of the collection from the specimen. ### CollectionMethodCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The method code set bundle associated with a specimen that represents the method used to collect the specimen. For example, Biopsy. This field is a relationship field. - **Relationship Name**: CollectionMethodCode - **Refers To**: CodeSet ### CollectionQuantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The quantity of specimen collected. For example, the volume of a blood sample, or the physical measurement of an anatomic pathology sample. ### CollectionQuantityUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The unit of measure for collected quantity. This field is a relationship field. - **Relationship Name**: CollectionQuantityUom - **Refers To**: UnitOfMeasure ### CollectionStartDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The start date and time of the collection from the specimen. ### CollectorId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The account of the healthcare provider that collected the specimen. This field is a polymorphic relationship field. - **Relationship Name**: Collector - **Refers To**: Account, HealthcareProvider ### ConditionCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The condition code set bundle associated with a specimen that represents the state of the specimen. This field is a relationship field. - **Relationship Name**: ConditionCode - **Refers To**: CodeSetBundle ### FastingDuration - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The total time period over which the individual fasted before sample collection. ### FastingDurationUomId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the unit of measure for the fasting duration. This field is a relationship field. - **Relationship Name**: FastingDurationUom - **Refers To**: UnitOfMeasure ### FastingStatusCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The fasting status code set bundle associated with specimen that represents the fasting status of the individual from whom the specimen was collected. This field is a relationship field. - **Relationship Name**: FastingStatusCode - **Refers To**: CodeSet ### FeatureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The feature code set bundle associated with a specimen that represents the type of physical feature or landmark of a specimen, which is highlighted for context by the collector. This field is a relationship field. - **Relationship Name**: FeatureCode - **Refers To**: CodeSetBundle ### GroupingMethod - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the specimen is part of a group or pooled with other specimens. - **Default value**: Grouped - **Possible values**: - Grouped - Pooled ### 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 specimen. ### 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 ### ReceivedDate - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The date and time when a specimen is received by the testing laboratory. ### SourceReferenceRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents where a specimen came from. For example, from a patient, from a location (the source of an environmental sample), a sampling of a substance, a biologically derived product, or a device. This field is a polymorphic relationship field. - **Relationship Name**: SourceReferenceRecord - **Refers To**: Account, Location ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the specimen. - **Default value**: Available - **Possible values**: - Available - EnteredInError - Unavailable - Unsatisfactory ### TypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The type code set bundle associated with a specimen that represents the type of material that forms the specimen. This field is a relationship field. - **Relationship Name**: Type - **Refers To**: CodeSet ### UsageCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The usage code set bundle associated with a specimen that represents the role of the specimen in the testing workflow. This field is a relationship field. - **Relationship Name**: UsageCode - **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. [SpecimenChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [SpecimenHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [SpecimenOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [SpecimenShare](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_document_management_result.htm "Output representation of the document split request.") # StandardCareFeeAgreement Specifies the payment terms for contracts of Standard Care Fee Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### ContractPaymentAgreementId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The contract payment agreement record to which this standard care fee agreement is associated. This is a relationship field. - **Relationship Name**: ContractPaymentAgreement - **Relationship Type**: Master-Detail - **Refers To**: ContractPaymentAgreement ### FacilityPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The fees when the procedure is performed in a facility location such as a hospital or Ambulatory Surgical Center (ASC). ### 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 standard care fee agreement. ### NonFacilityPrice - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The fees when the procedure is performed in a non-facility location such as the physician's office. ### ProcedureCodeDescription - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of the procedure code. ### ProcedureCodeId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The industry standard code for the procedure such as CPT or HCPCS. This is a relationship field. - **Relationship Name**: ProcedureCode - **Relationship Type**: Lookup - **Refers To**: CodeSetBundle ### StdCareFeeAgreementKey - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: A unique key assigned to the Standard Care Fee Agreement 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. [StandardCareFeeAgreementFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [StandardCareFeeAgreementHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. [StandardCareFeeAgreementChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/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. # 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. - AccountServicePreference - Accreditation - ActivityTiming - AdvTherapyFieldOptOverride - AllergyIntolerance - ApplicationCase - AssessmentConfiguration - AssessmentEnvelope - AssessmentEnvelopeItem - Award - BoardCertification - BundledCareFeeAgreement - CapitationCareFeeAgreement - CareBarrier - CareBarrierDeterminant - CareBarrierType - CareBenefitVerifyRequest - CareBenefitVerifySettings - CareDeterminant - CareDeterminantType - CareDiagnosis - CareFeeScheduleItem - CareInterventionType - CareLimitType - CareMetricTarget - CareObservation - CarePgmEnrolleeWkOrdStep - CarePgmEnrolleeWorkOrder - CarePgmProvHealthcareProvider - CarePreauth - CarePreauthItem - CareProgram - CareProgramCampaign - CareProgramEligibilityRule - CareProgramEnrollee - CareProgramEnrolleeProduct - CareProgramEnrollmentCard - CareProgramGoal - CareProgramProduct - CareProgramProvider - CareProgramTeamMember - CareProviderAdverseAction - CareProviderFacilitySpecialty - CareProviderSearchableField - CareProviderSearchConfig - CareRegisteredDevice - CareRequest - CareRequestDrug - CareRequestExtension - CareRequestItem - CareRequestReviewer - CareServiceVisit - CareServiceVisitPlan - CareSpecialty - CareSpecialtyTaxonomy - CareTaxonomy - CategorizedCareFeeAgreement - ClinicalEncounter - ClinicalEncounterDiagnosis - CodeSet - CodeSetBundle - ContractPaymentAgreement - CoverageBenefit - CoverageBenefitItem - CoverageBenefitItemLimit - CustodyChainEntry - CustodyItem - CustodyVerfcTypeOverride - DiagnosticSummary - EngagementAttendee - EngagementInteraction - EngagementTopic - EnrollmentEligibilityCriteria - FeeScheduleDefinition - HealthCareDiagnosis - HealthcareFacility - HealthcareFacilityNetwork - HealthcarePayerNetwork - HealthCareProcedure - HealthcareProvider - HealthcareProviderNpi - HealthcareProviderSpecialty - HealthcareProviderTaxonomy - HealthCondition - HealthScore - InsurancePolicy - InventoryCntProdtBatchItem - InventoryCountAssessment - InventoryOperation - Location - Medication - MedicationDispense - MedicationReconciliation - MedicationRequest - MedicationStatement - MedicationStatementDetail - MedicinalIngredient - MedReconRecommendation - MedReconStmtRecommendation - MemberPlan - OcrDocumentScanResult - PatientImmunization - PatientMedicalProcedure - PatientMedicalProcedureDetail - PatientMedicationDosage - PercentileBsdCareFeeAgreement - PersonEducation - PersonEmployment - PlanBenefit - PlanBenefitItem - PreventiveCareAgreement - ProductBatchItem - ProductDisbursement - ProductionBatch - ProductItemTransaction - ProductRequest - ProductRequestLineItem - ProductTransfer - ProviderNetworkContract - ProviderNetworkTier - ProviderSampleLimit - ProviderSearchSyncLog - ProviderSmplLmtTmplAssignment - PrvdVstSmplLmtDiscrepancy - PrvdVstSmplLmtTransaction - PurchaserPlan - PurchaserPlanAssn - ReceivedDocument - ReceivedDocumentType - ResearchStdyCndtStatusPrd - ScheduleBrdcstApptResource - ScheduleBroadcast - ScheduleBroadcastAppointment - ScheduleBroadcastTerritory - ServiceAppointmentGroup - ServiceTerritoryRelationship - SharedSavingPaymentAgreement - StandardCareFeeAgreement - Team - TeamMember - TerritoryProdtQtyAllocation - TimelineObjectDefinition - UnitOfMeasure - WorkProcedure - WorkProcedureStep - WorkTypeExtension - WorkTypeStep - WorkTypeStepLdTimeOvride - WorkTypeSvcTerrSchdPrio # 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.health_cloud_object_reference.meta/health_cloud_object_reference/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.health_cloud_object_reference.meta/health_cloud_object_reference/images/icon_note_tip.png) #### Tip Though the
tag isn’t supported, you can use

 

to create lines. - - - - - - -