--- schema_version: "1" id: 3667fc9f06e6027f6c38af02a708fdceffce5e6ce92c6ec675a4f5df6c4cfb82 title: CareObservationComponent collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_r4_api_objects_CareObservationComponent.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_CareObservationComponent.htm source_site: developer.salesforce.com content_type: documentation content_hash: 737cf625894a8cab800c8411491ff76910921145c055083bc0fcde7166db41ef description: Represents information about a component of a care observation. This object is available in API version 51.0 and later. --- # 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 ### 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. ### 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 ### 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. ### 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. ### 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**: - 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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [CareObservationComponentHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [CareObservationComponentChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object.