Salesforce Docs Portal

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
Feed tracking is available for the object.
CareGapHistory
History is available for tracked fields of the object.
CareGapOwnerSharingRule
Sharing rules are available for the object.
CareGapShare
Sharing is available for the object.