Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
ActivityTiming
AllergyIntolerance
AuthorNote
CareObservation
CareObservationComponent
CarePerformer
CareRegisteredDevice
DiagnosticSummary
ClinicalAlert
ClinicalDetectedIssue
ClinicalDetectedIssueDetail
ClinicalEncounter
ClinicalServiceRequest
CodeSet
CodeSetBundle
ContactProfile
HealthcareFacility
HealthCondition
HealthRiskEvaluation
HealthRiskEvalDetail
HealthRiskEvalOutcome
Identifier
Medication
MedicationAdministration
MedicationDispense
MedicationRequest
MedicationStatement
PatientHealthReaction
PatientImmunization
PatientMedicalProcedure
PatientMedicationDosage
PersonLanguage
PersonName
ProblemDefRelationship
Specimen
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

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

Field Details
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.
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.
ValueInterpretation
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the interpretation of values observed.
Possible values are:
  • High
  • Low
  • Normal
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 are:
  • 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
Feed tracking is available for the object.
CareObservationComponentHistory
History is available for tracked fields of the object.
CareObservationComponentChangeEvent (API version 61.0)
Change events are available for the object.