Salesforce Docs Portal

CareObservationDetail

Represents the details of a care observation. It provides detailed findings or contextual information for a patient's health assessment, such as a particular lab result or a clinician's specific insight. The detailed observations enable providers to capture comprehensive and precise health data. This object is available in API version 68.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

CareObservationId

  • Type: Master-detail reference
  • Properties: Create, Filter, Group, Sort
  • Description: The parent care observation that this detail belongs to.
  • Referenced Objects:
    • CareObservation

DetailRecordId

  • Type: Polymorphic reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The record that adds detailed findings or contextual information to the care observation. Select the record based on the specified detail type.
  • Referenced Objects:
    • CareObservation
    • CarePlan
    • ClinicalServiceRequest
    • CodeSetBundle
    • MedicationRequest
    • MedicationStatement

DetailType

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies the type of relationship between the care observation record and the detail record.
  • Possible values:
    • BasedOn—Based On
    • PartOf—Part Of
    • Interpretation
    • HasMember—Has Member
    • DataAbsentReason—Data Absent Reason

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 the care observation detail.

Usage

CareObservationDetail records add additional information to CareObservation records. The type of information is specified using the DetailType field, and the related record is selected using the DetailRecordId field. Connect the detail to its parent observation with the CareObservationId field.

This information can be of the following types, referencing the following types of records:

  • Based On: Care plans, clinical service requests, or medication requests
  • Data Absent Reason: Code set bundles
  • Has Member: Care observations
  • Interpretation: Code set bundles
  • Part Of: Care observations or medication statements

One CareObservationDetail record can specify only one type and piece of information. If multiple detail types or detail instances are required for the parent care observation, create multiple CareObservationDetail records.

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.

CareObservationDetailChangeEvent
Change events are available for the object.
CareObservationDetailHistory
History is available for tracked fields of the object.