PatientMedicationDosage

Represents dosage information for medication. This object is primarily used to add dosage information in MedicationStatement, MedicationRequest, or MedicationDispense records. This object is available in API version 51.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Fields

Field	Details
AdditionalInstruction	Type textarea Properties Create, Nillable, Update Description The supplemental instructions or warnings associated with the medication for the patient.
Comments	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The comments associated with the medication dosage for the patient.
DosageDefinitionType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies how the dosage was determined. Possible values are: `Calculated` `Ordered`
DosageQuantityDenominator	Type double Properties Create, Filter, Nillable, Sort, Update Description The denominator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range.
DosageQuantityNumerator	Type double Properties Create, Filter, Nillable, Sort, Update Description The numerator value for the quantity of medication per dose. This field can be used to record a simple quantity or a quantity range.
DosageQuantityType	Type Static picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of dosage quantity recorded in DosageQuantityNumerator and DosageQuantityDenominator. Possible values are: `Dose` `Dose Range`
DosageRateDenominator	Type double Properties Create, Filter, Nillable, Sort, Update Description The denominator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range.
DosageRateNumerator	Type double Properties Create, Filter, Nillable, Sort, Update Description The numerator value for the rate of medication in the dosage. That is, amount of medication per unit of time. This field can be used to record a simple rate, a rate ratio, or a rate range.
DosageRateType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of dosage rate recorded in DosageRateNumerator and DosageRateDenominator. Possible values are: `Frequency` `Frequency Range` `Frequency Ratio`
DosageRateUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the dosage rate recorded using DosageRateNumerator and DosageRateDenominator. Referenced Objects UnitOfMeasure
DosageUnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of the dosage rate recorded using DosageQuantityNumerator and DosageQuantityDenominator. Referenced Objects UnitOfMeasure
DosePrerequisiteId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the conditions that are to be met for the dosage to be taken. Referenced Objects CodeSetBundle
IsAsNeeded	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the medication is taken on an as-needed basis.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last referenced.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The date and time when the record was last viewed.
MethodId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the method of dosage adminisitration. Referenced Objects CodeSetBundle
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The system-generated name of the PatientMedicationDosage record.
ParentRecordId	Type Master-detail polymorphic reference Properties Create, Filter, Group, Sort Description The MedicationStatement, MedicationRequest, or the MedicationDispense record that the PatientMedicationDosage record belongs to. Referenced Objects MedicationDispense—This value is available in API version 55.0 and later. MedicationStatement MedicationRequest
PatientInstruction	Type textarea Properties Create, Nillable, Update Description The patient or consumer instructions associated with this medication.
RouteId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the route of dosage adminisitration. Referenced Objects CodeSetBundle
Sequence	Type double Properties Create, Filter, Nillable, Sort, Update Description The position of this medication in the sequence of medications prescribed to a patient.
SiteId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the site of dosage adminisitration. Referenced Objects CodeSetBundle
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source system from where the dosage record was brought into Health Cloud.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the dosage record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the dosage record was last modified in its source system.
TimingId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The timing information for when and how frequent the medication dosage should be taken. Referenced Objects ActivityTiming

Usage

PatientMedicationDosage records are used to add more dosage-related information to MedicationStatement, MedicationRequest, and MedicationDispense records. The PatientMedicationDosage record is associated to the MedicationStatement, MedicationRequest, and MedicationDispense records using the ParentRecordId field.

Salesforce Health Cloud Developer Guide

PatientMedicationDosage

Supported Calls

Fields

Usage