Newer Version Available

This content describes an older version of this product. View Latest

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(), undelete(), update(), upsert()

Fields

Field Details
CodeId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The CodeSet ID related to the observation.

When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs.

Note

DeviceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the device generating the observed value.

When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs.

Note

EffectiveDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the observation was recorded.
ExpectedValueId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The CodeSet ID related to the care metric target.

When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs.

Note

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.
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. The default value Is false.
IsOutcomePositive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates the observed boolean value. The default value is 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 this care observation.
NumericValue
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The numeric value of the care observation (6 decimal places).
ObservedSubjectId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The account ID of the subject being observed. For example, the ID of the patient being observed.

When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs.

Note

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 are:
  • 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.
UnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of measure for the observed value.

When creating a Care Observation record in Apex, use Salesforce IDs instead of external IDs.

Note

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

CareObservationFeed
Feed tracking is available for the object.
CareObservationHistory
History is available for tracked fields of the object.