Salesforce Docs Portal

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

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

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

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

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

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 (API version 58.0)
Change events are available for the object.
CareObservationFeed
Feed tracking is available for the object.
CareObservationHistory
History is available for tracked fields of the object.
CareObservationOwnerSharingRule (API version 56.0)
Sharing rules are available for the object.
CareObservationShare (API version 56.0)
Sharing is available for the object.