CareRequestDrug

Represents the details of a requested drug including name, strength, frequency, and instructions for administration. One or more drug 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
ApprovedUnits	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Approved quantity of the drug.
AuthApprovalIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The unique identifier assigned to the drug 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 drug. 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, Nillable, Sort, Update Description Care request for the care request drug. 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 drug request. Possible values are: Approved Denied Partially Approved Stopped Reduced Suspended Medical Director Review Pending
ClinicalDeterminationNote	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 is a relationship field. Relationship Name ClinicalDeterminationReason Relationship Type Lookup Refers To CodeSet
Code	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Code for the drug.
CodeType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ID code type for the drug. Possible values are: NDC RxNorm
DaysSupply	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of days to supply the drug.
DecisionDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the decision was made for this drug request.
DeniedUnits	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Denied quantity of the drug.
DispenserAddress	Type address Properties Filter, Nillable Description Pharmacy address.
DispenserFaxNumber	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Pharmacy fax number.
DispenserIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID for the pharmacy.
DispenserName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description ID for the pharmacy.
DispenserPhoneNumber	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Pharmacy phone number.
DispenserTaxIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Pharmacy tax identification number.
DispenserVerbalNotificationDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the pharmacy or pharmacy benefit manager was contacted verbally.
DispenserWrittenNotificationDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time when the pharmacy or pharmacy benefit manager was notified in writing or electronically.
DispensingPharmacyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The pharmacy that dispenses the drug. This is a polymorphic relationship field. Relationship Name DispensingPharmacy Relationship Type Lookup Refers To Account, HealthcareProvider
Dose	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Dose of the drug.
DrugAdministrationSetting	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The setting where the drug is administered to the patient. Possible values are: `Community` `Discharge` `Inpatient` `Outpatient` This field is available in API version 57.0 and later.
DrugCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The code set that defines the requested drug. This field is a polymorphic relationship field. Relationship Name DrugCode Relationship Type Lookup Refers To CodeSet, CodeSetBundle This field is available in API version 58.0 and later.
Frequency	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Frequency of the drug.
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.
MedicationCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The code of the care request drug. This is a relationship field. Relationship Name MedicationCode Relationship Type Lookup Refers To Medication
MedicationRefObjectId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The medication request or statement associated with the requested drug. This field is a polymorphic relationship field. Relationship Name MedicationRefObject Relationship Type Lookup Refers To MedicationRequest, MedicationStatement This field is available in API version 57.0 and later.
ModifiedCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Code for the modified drug.
ModifiedCodeType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description ID code type for the modified drug. Possible values are: NDC RxNorm
ModifiedDaysSupply	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of days of supply for the modified drug.
ModifiedDose	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Dose of the modified drug.
ModifiedFrequency	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Frequency of the modified drug.
ModifiedName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name of the modified drug.
ModifiedSig	Type textarea Properties Create, Nillable, Update Description Directions for use of the modified drug.
ModifiedStrength	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Strength of the modified drug.
ModifiedTherapyDuration	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Duration of therapy for the modified drug.
ModifiedUnits	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Modified quantity of the drug.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the drug.
PrescriptionDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date for the prescription.
PrescriptionFillDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Number of fills for the prescription.
PrescriptionFills	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of fills for the prescription.
PrescriptionNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Drug prescription number.
Priority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the authorization for the requested drug. Possible values are: `Routine` `Stat` `Urgent` 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 drug 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.
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 drug. 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 drug. 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.
Sig	Type textarea Properties Create, Nillable, Update Description Directions for use of the drug.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description System from which this 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 the requested drug. Possible values are: `Active` `Cancelled` `Completed` `Draft` `Entered-in-Error` `On-Hold` `Stopped` `Unknown` This field is available in API version 57.0 and later.
StatusReason	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reason for assigning the authorization status to the requested drug. Possible values are: `Insufficient Information` `Medically Not Required` `Other` This field is available in API version 57.0 and later.
Strength	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Strength of the drug.
TherapyDuration	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Duration of therapy for the drug.
Units	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Quantity of the drug.

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.

CareRequestDrugChangeEvent (API version 59.0): Change events are available for the object.
CareRequestDrugFeed: Feed tracking is available for the object.
CareRequestDrugHistory: History is available for tracked fields of the object.

Salesforce Health Cloud Developer Guide

CareRequestDrug

Supported Calls

Fields

Associated Objects

See Also