---
schema_version: "1"
id: 4d55d0c2725ab22a49e20ffa8b882a6e3c23072ac67ed318435961c08c454ffd
title: HomeVisitPatientBenefitDetails Class
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/apex_healthcloudext_home_visit_patient_benefit_details.md
canonical_url: 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
source_site: developer.salesforce.com
content_type: documentation
content_hash: 995fe3785d1edffea2debc0f022fec3e6516c3780fb0c03a6d15d633ad841c4c
description: 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.The ID of patient benefit.The date on which the benefit ends.The name of the benefit.The date on which the benefit starts.The ID of the product catalog.The name of the product catalog.The ID of the product category.The name of the product category.The ID of the coverage benefit.The ID of the coverage Benefit Item.The ID of the coverage benefit item limit.Indicates if the benefit ID is present in the system.The ID of the member plan.The name of the member plan.The ID of the product.The name of the product.The count of the benefit item.The price of the benefit.
---
# 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)