EhrDosageInstruction__c

Represents instructions for how a medication is to be used by a patient.

Supported Calls

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

This packaged object has a standard object counterpart in the Clinical Data Model. We recommend using the standard object because it’s more closely aligned with FHIR v4.0.

Fields

AdditionalInstruction__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Additional dosage instructions such as “Take with food.”

AdditionalInstructionCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents additional dosage instructions.

AdditionalInstructionLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents additional dosage instructions.

AdditionalInstructionSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines additional dosage instructions.

AsNeeded__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Whether a medication is taken only when needed within the specified schedule (true) or at every scheduled dose (false). The default checkbox value is deselected.

AsNeededCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents whether a medication is taken only when needed within the specified schedule rather than at every scheduled dose.

AsNeededLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents whether a medication is taken only when needed within the specified schedule rather than at every scheduled dose.

AsNeededSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines whether a medication is taken only when needed within the specified schedule rather than at every scheduled dose.

DoseQuantityUnit__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement in the amount of medication that was dispensed.

DoseQuantityValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The amount of medication that was dispensed.

EhrPatient__c

Type: reference
Properties: Create, Filter, Group, Sort
Description: The individual receiving healthcare services.

Instruction__c

Type: textarea
Properties: Create, Nillable, Update
Description: A long text description of how a medication is to be used by a patient.

IsRestricted__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether or not this field has restricted visibility based on sharing rules.

IsVisibleOnPatientCard__c

Type: boolean
Properties: Defaulted on create, Filter, Group
Description: Indicates whether or not this field appears on the patient card.

LastActivityDate

Type: date
Properties: Filter, Group, Nillable, Sort
Description: Whichever of the following is the most recent:
- Due date of the most recent event logged against the record.
- Due date of the most recently closed task associated with the record.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The time stamp that indicates when the current user last viewed a related 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.

MaxDosePerPeriodAmountUnit__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement in the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodAmountValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodDenominatorUnit__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement in the denominator of the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodDenominatorValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The denominator in the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodNumeratorUnit__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement in the numerator of the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodNumeratorValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The numerator in the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodTimeUnit__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement of time in the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MaxDosePerPeriodTimeValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The time value in the maximum total quantity of a therapeutic substance that can be administered to a subject over a period of time.

MedicationPrescription__c

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: An order for supply of a medication and the instructions for administration of the medicine to a patient. Lookup to EhrMedicationPrescription__c.

MedicationStatement__c

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A record of the medication that the patient takes or that was given to the patient, where the record is the result of a report from the patient or another clinician. Lookup to EhrMedicationStatement__c.

MethodCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the method by which a medication is introduced into or onto the body, most commonly used for injections.

MethodLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the method by which a medication is introduced into or onto the body, most commonly used for injections.

MethodSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the method by which a medication is introduced into or onto the body, most commonly used for injections.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The EHR dosage instruction ID. Limit: 255 characters.

RateDenominator__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The denominator in the speed at which the substance is introduced into the subject, typically the rate for an infusion. An example rate is 200ml in 2 hours.

RateNumerator__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The numerator in the speed at which the substance is introduced into the subject, typically the rate for an infusion. An example rate is 200ml in 2 hours.

RouteCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the route or physiological path of administration of a therapeutic agent into or onto a subject.

RouteLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the route or physiological path of administration of a therapeutic agent into or onto a subject.

RouteSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the route or physiological path of administration of a therapeutic agent into or onto a subject.

SiteCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that specifies the anatomic site where the medication first enters the body.

SiteLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that specifies the anatomic site where the medication first enters the body.

SiteSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the anatomic site where the medication first enters the body.

SourceSystem__c

Type: string
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: A name that identifies the system that created the record and owns update rights to it.

SourceSystemModified__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The most recent date when the integration system wrote the record from the source record.

SupplementalInstructions__c

Type: textarea
Properties: Create, Nillable, Update
Description: Any additional instructions.

TimingPeriod__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The defined period of time.

TimingPeriodEnd__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The last day of the time period.

TimingPeriodStart__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The first day of the time period.