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 

ApprovedUnits 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Approved quantity of the drug.

AssertionIdentifier 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique identifier of the coverage assertion.

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:

    • 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:

    • 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.

    This field is available in API version 57.0 and later.

  • Possible values:

    • Community
    • Discharge
    • Inpatient
    • Outpatient

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:

    • 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.

    This field is available in API version 57.0 and later.

  • Possible values:

    • Routine
    • Stat
    • Urgent

RequestType 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The type of drug request.

    This field is available in API version 57.0 and later.

  • Possible values:

    • Filler Order
    • Instance Order
    • Option
    • Order
    • Original Order
    • Plan
    • Proposal
    • Reflex Order

RequiredResponseCount 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of responses required for the requested drug.

ResponseDateTime 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the response was sent for the drug request.

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.

ServiceInformationResponseId 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The service information response associated with the drug request.

    This field is a relationship field.

  • Relationship Name: ServiceInformationResponse

  • Refers To: ServiceInformationResponse

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.

    This field is available in API version 57.0 and later.

  • Possible values:

    • Active
    • Cancelled
    • Completed
    • Draft
    • Entered-in-Error
    • On-Hold
    • Stopped
    • Unknown

StatusCodeId 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: The code of the action taken by the reviewer for the requested drug.

    This field is a relationship field.

  • Relationship Name: StatusCode

  • Refers To: CodeSetBundle

StatusReason 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: The reason for assigning the authorization status to the requested drug.

    This field is available in API version 57.0 and later.

  • Possible values:

    • Insufficient Information
    • Medically Not Required
    • Other

Strength 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Strength of the drug.

SubmittedDateTime 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the drug request was submitted.

TherapyDuration 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Duration of therapy for the drug.

TransactionNumber 
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The transaction number assigned to the drug request.

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.

Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Clinical Data Model
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
CareDiagnosis
CareProcessingError
CareRequest
CareRequestDrug
CareRequestExchangeInfo
CareRequestExtension
CareRequestItem
CareRequestReviewer
CareRequestSupportingCntnt
TrackedCommunication
TrackedCommunicationDetail
ProductRequest
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
Health Cloud Managed Package
Previous Versions