CareRequestItem

Represents the details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request.

Supported Calls

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

Fields

Field Name	Details
AmbulanceTransportDistance	Type double Properties Create, Filter, Nillable, Sort, Update Description Distance traveled during ambulance transport.
AmbulanceTransportReason	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reason for ambulance transport.
AmbulanceTransportType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Type of ambulance transport.
ApprovedLengthOfStay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days requested for the admission.
ApprovedLevelOfCare	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the approved level of care for the patient. Possible values are: `Hospital - Inpatient` `Hospital - Intensive Care` `Hospital - Rehabilitation` `Psychiatric Intensive Care` `Psychiatric Room - Semi-private` `Psychiatric Room and Board - Private` `Psychiatric Ward` `SNF - Inpatient` `SNF - Rehabilitation` `SNF - Specialized Care`
ApprovedQuantity	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The approved quantity of the care item.
ApprovedServiceEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the approved service that the patient received.
ApprovedServiceStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the approved service that the patient received.
AuthApprovalIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier assigned to the item on approval of the authorization request. This field is available in API version 57.0 and later.
AuthorizationRefIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier of the authorization request associated with the requested item. This field is available in API version 57.0 and later.
CareRequestCaseId	Type reference Properties Create, Filter, Group, Sort Description Case related to the care request. This is a relationship field. Relationship Name CareRequestCase Relationship Type Lookup Refers To Case
CareRequestId	Type reference Properties Create, Filter, Group, Sort, Update Description Care request for the care request item. This is a relationship field. Relationship Name CareRequest Relationship Type Lookup Refers To CareRequest
ClinicalDetermination	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The clinical determination of the care request. Possible values are: `Approved` `Denied` `Medical Director Review Pending` `Partially Approved` `Reduced` `Stopped` `Suspended`
ClinicalDeterminationNotes	Type textarea Properties Create, Nillable, Update Description The notes related to the clinical determination.
ClinicalDeterminationReasonId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for the clinical determination. This field is a relationship field. Relationship Name ClinicalDeterminationReason Relationship Type Lookup Refers To CodeSet
ClinicalServiceRequestId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The clinical service request associated with the care request item. This field is a relationship field. Relationship Name ClinicalServiceRequest Relationship Type Lookup Refers To ClinicalServiceRequest This field is available in API version 57.0 and later.
CodeDescription	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the denied service code.
CodeType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Code type for the service.
CodeTypeIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the code type for the service.
CumulativeLengthOfStay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days a patient is admitted.
CurrentLevelOfCare	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the level of care the patient is receiving. Possible values are: `Hospital - Inpatient` `Hospital - Intensive Care` `Hospital - Rehabilitation` `Psychiatric Intensive Care` `Psychiatric Room - Semi-private` `Psychiatric Room and Board - Private` `Psychiatric Ward` `SNF - Inpatient` `SNF - Rehabilitation` `SNF - Specialized Care`
DecisionDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the last decision was made for this care request item.
DeniedLevelOfCare	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The level of care denied for the patient. Possible values are: `Hospital - Inpatient` `Hospital - Intensive Care` `Hospital - Rehabilitation` `Psychiatric Intensive Care` `Psychiatric Room - Semi-private` `Psychiatric Room and Board - Private` `Psychiatric Ward` `SNF - Inpatient` `SNF - Rehabilitation` `SNF - Specialized Care`
DeniedQuantity	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The quantity of the denied service.
EffectiveDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Effective date for the diagnosis.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Termination date for the service.
FreeFormProcedureDescription	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Free-form description of the procedure.
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.
ModifiedCodeDescription	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the modified service code.
ModifiedCodeIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the code for the modified service.
ModifiedCodeType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Code type for the modified service.
ModifiedCodeTypeIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the code type for the modified service.
ModifiedEffectiveDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Effective date for the modified service.
ModifiedEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Termination date for the modified service.
ModifiedLevelOfCare	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the modified level of care for the patient. Possible values are: `Hospital - Inpatient` `Hospital - Intensive Care` `Hospital - Rehabilitation` `Psychiatric Intensive Care` `Psychiatric Room - Semi-private` `Psychiatric Room and Board - Private` `Psychiatric Ward` `SNF - Inpatient` `SNF - Rehabilitation` `SNF - Specialized Care`
ModifiedModifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Modifier for modified service code.
ModifiedModifierDescription	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Modifier description for modified service code.
ModifiedProcedureCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Code for the modified service, drug, or equipment. ModifiedProcedureCodeId will be deprecated in a future release, so use ModifiedProcedureCodeSetId instead. This is a relationship field. Relationship Name ModifiedProcedureCode Relationship Type Lookup Refers To HealthCareProcedure
ModifiedProcedureCodeSetId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The code set for the modified service, drug, or device associated with the care request item. This is a polymorphic relationship field. Relationship Name ModifiedProcedureCodeSet Relationship Type Lookup Refers To CodeSet, CodeSetBundle
ModifiedQuantity	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The modified quantity of requested care.
Modifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Modifier for the service code.
Modifier2	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Second modifier for service code.
Modifier2Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the second modifier for the service code.
Modifier3	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Third modifier for service code.
Modifier3Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the third modifier for the service code.
Modifier4	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Fourth modifier for service code.
Modifier4Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the fourth modifier for the service code.
ModifierCodeSetId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The modifier code set for the service code associated with the care request item. This is a polymorphic relationship field. Relationship Name ModifierCodeSet Relationship Type Lookup Refers To CodeSet, CodeSetBundle
ModifierDescription	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the modifier for the service code
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description ID of the service code.
Priority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the authorization for the requested item. Possible values are: `Routine` `Stat` `Urgent` This field is available in API version 57.0 and later.
ProcedureCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Code for the service, drug, or equipment. ProcedureCodeId will be deprecated in a future release, so use ProcedureCodeSetId instead. This is a relationship field. Relationship Name ProcedureCode Relationship Type Lookup Refers To HealthCareProcedure
ProcedureCodeSetId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The code set for the service, drug, or device associated with the care request item. This is a polymorphic relationship field. Relationship Name ProcedureCodeSet Relationship Type Lookup Refers To CodeSet, CodeSetBundle
Quantity	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The quantity of the item that is requested.
QuantityType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Quantity type for the request such as days, units, or visits.
ReasonCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for requesting the item. This field is a polymorphic relationship field. Relationship Name ReasonCode Relationship Type Lookup Refers To CareDiagnosis, CodeSet, CodeSetBundle This field is available in API version 57.0 and later.
RequestType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of item request. Possible values are: `Filler Order` `Instance Order` `Option` `Order` `Original Order` `Plan` `Proposal` `Reflex Order` This field is available in API version 57.0 and later.
RequestedLengthOfStay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days requested for the admission.
RequestedLevelOfCare	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the requested level of care for the patient. Possible values are: `Hospital - Inpatient` `Hospital - Intensive Care` `Hospital - Rehabilitation` `Psychiatric Intensive Care` `Psychiatric Room - Semi-private` `Psychiatric Room and Board - Private` `Psychiatric Ward` `SNF - Inpatient` `SNF - Rehabilitation` `SNF - Specialized Care`
RequestedServiceEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date of the requested service.
RequestedServiceStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date of the requested service.
ServiceCategory	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the service type such as medical care, diagnostic radiology, pharmacy, or diagnostic laboratory.
ServiceCategoryCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Alphanumeric code that uniquely identifies a service type
ServicingFacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The facility where a patient receives service of the requested item. This field is a polymorphic relationship field. Relationship Name ServicingFacility Relationship Type Lookup Refers To HealthcareFacility, HealthcarePractitionerFacility This field is available in API version 57.0 and later.
ServicingProviderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The healthcare provider who provides the service of the requested item. This field is a relationship field. Relationship Name ServicingProvider Relationship Type Lookup Refers To HealthcareProvider This field is available in API version 57.0 and later.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description System from which the request was sourced.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description ID of the system from which the request was sourced.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Timestamp of the most recent update from the source system.
Status	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The authorization status of this service.
StatusReason	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reason for the authorization status of this service.
TransportLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Destination location for ambulance transport. This is a relationship field. Relationship Name TransportLocation Relationship Type Lookup Refers To Account

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.

CareRequestItemChangeEvent (API version 59.0): Change events are available for the object.
CareRequestItemFeed: Feed tracking is available for the object.
CareRequestItemHistory: History is available for tracked fields of the object.

Salesforce Health Cloud Developer Guide

CareRequestItem

Supported Calls

Fields

Associated Objects

See Also