ClinicalServiceRequest

Represents requests for a procedure or diagnostic service that needs to be planned, proposed, or performed as part of the patient’s healthcare. 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

Field	Details
BodySiteId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents site of the body associated with the service request. Referenced Objects CodeSetBundle
CategoryId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the category of the service request. Referenced Objects CodeSetBundle
ConditionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The condition that justifies the service request. Referenced Objects HealthCondition
DateSigned	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date the service request was signed.
DiagnosticReportId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The diagnosis that justifies the service request. Referenced Objects ClinicalEncounterDiagnosis
DiseaseInvestigationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The disease investigation related to the clinical service request. This field is a relationship field. Relationship Name DiseaseInvestigation Refers To DiseaseInvestigation
EncounterId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The encounter related to the service request. Referenced Objects ClinicalEncounter
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The end date and time for the service request.
FacilityCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-generated code for the facility where the service request is to be performed. Referenced Objects CodeSetBundle
FacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The facility where the service request is to be performed. Referenced Objects HealthcareFacility
HasPrerequisites	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether there are any prerequisites for the service request. If the value of this field is `true`, then you can’t select a PrerequisiteCodeId.
IsAccepted	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the clinical service request is accepted (`true`) or not (`false`). The default value is `false`.
IsIgnored	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the request should be ignored.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated name of the clinical service request.
ObservationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The observation that justifies the service request. Referenced Objects ClinicalObservation
OriginalRequestId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A reference to the original service request the service request replaces. Referenced Objects ClinicalServiceRequest
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the clinical service request record. Available in API version 56.0 and later. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group User To enable queues for the Clinical Service Request object, change the sharing settings for the object from Controlled By Parent to Private. Note
PatientId	Type Master-detail reference Properties Create, Filter, Group, Sort Description The patient associated with the service request. Referenced Objects Account
PatientInstruction	Type textarea Properties Create, Nillable, Update Description Instructions for the patient.
PerformerId	Type Polymorphic reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person or device that performs the service request. Referenced Objects Account Asset HealthcareProvider CareRegisteredDevice
PerformerTypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the type or role of the person performing the service request. Referenced Objects CodeSetBundle
PrerequisiteCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-generated code that represents the prerequisites for the service request. You can’t select a record for this field if the HasPrerequisites field is set to `true`. Referenced Objects CodeSetBundle
Priority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the priority of the service request. Possible values are: `ASAP` `Routine` `Stat` `Urgent`
QuantityDenominator	Type double Properties Create, Filter, Nillable, Sort, Update Description The denominator value of the quantity associated with the service request.
QuantityNumerator	Type double Properties Create, Filter, Nillable, Sort, Update Description The numerator value of the quantity associated with the service request.
QuantityNumeratorUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the numerator value of the quantity associated with the service request. Referenced Objects UnitOfMeasure
QuantityType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the type of quantity related to the service request. Possible values are: `Range` `Ratio`
ReasonCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the justification for the service request. Referenced Objects CodeSetBundle
RequestCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the service request. Referenced Objects CodeSetBundle
RequesterId	Type Polymorphic reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person or device raising a service request. Referenced Objects Account Asset HealthcareProvider CareRegisteredDevice
ServiceRequestGroupIdentifierId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Identifier that ties the service request to its batch of requests. Referenced Objects Identifier
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the system this record came from.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of this record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which this item was last changed in the source system.
StartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The start date and time for the service request.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The status of the service request. Possible values are: `Active` `Completed` `Draft` `Entered-in-Error` `On-Hold` `Revoked` `Unknown`
Type	Type picklist Properties Create, Filter, Group, Sort, Update Description The type of the service request. Possible values are: `Directive` `Filler-Order` `Instance-Order` `Option` `Order` `Original-Order` `Plan` `Proposal` `Reflex-Order`

Additional Information for ClinicalServiceRequest in Other Objects

In addition to creating a record using these fields, you can add more details to your ClinicalServiceRequest record by creating records in certain other objects, and referencing your ClinicalServiceRequest record as the parent record. Here’s the list of objects you can associate to ClinicalServiceRequest in this way, the type of information they add, and the field they use to reference ClinicalServiceRequest.

Object	Type of Information	Reference Field
Identifier	Associates an identifier value to the service request.	ParentRecordId
ClinicalServiceRequestDetail	Associates the service request with various other records and defines the nature of the association. For instance, if the service request is based on an associated record.	ClinicalServiceRequestId

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.

ClinicalServiceRequestFeed: Feed tracking is available for the object.
ClinicalServiceRequestHistory: History is available for tracked fields of the object.
ClinicalServiceRequestOwnerSharingRule (API version 56.0): Sharing rules are available for the object.
ClinicalServiceRequestShare (API version 56.0): Sharing is available for the object.
ClinicalServiceRequestChangeEvent (API version 61.0): Change events are available for the object.

Salesforce Health Cloud Developer Guide

ClinicalServiceRequest

Supported Calls

Fields

Additional Information for ClinicalServiceRequest in Other Objects

Associated Objects