|
CollectedBy
|
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The contact, account, or a healthcare provider who collected the
dispensed medication. This field is available in API version 55.0
and later.
- This field is a polymorphic relationship field.
- Relationship Name
- CollectedBy
- Relationship Type
- Lookup
- Refers To
- Account, Contact, HealthcareProvider
|
| ContextId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The encounter that establishes the context for the dispense of a
medication.
- Refers To
-
|
| DeliveryLocationId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The location where the dispensed medication will be delivered.
This field is available in API version 55.0 and later.
- This field is a polymorphic relationship field.
- Relationship Name
- DeliveryLocation
- Relationship Type
- Lookup
- Refers To
- HealthcareFacility, Location
|
| DispenseTypeCodeId |
- Type
- Polymorphic lookup
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The system-defined code that identifies the dispense event type.
For instance, a first fill, trial fill, or refill.
- Refers To
-
|
| DispensedDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date and time when the medication was handed over.
|
| HealthcareFacilityId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The location where the dispense occurred.
- Refers To
-
|
| IsSubstituted |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- Indicates whether a substitute medication was dispensed.
- The default value is false.
- This field is available in API version 55.0 and later.
|
| 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.
|
| MedAdministrationSettingCategory |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Specifies the setting in which the medication is expected to be
administered to the patient.
- Possible values are:
- Inpatient
- Outpatient
- Community
- Discharge
|
| MedicationCodeId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The system-defined code that identifies the medication that's
dispensed.
- Refers To
-
|
| MedicationId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The medication that's dispensed.
- Relationship Name
- Medication
- Relationship Type
- Lookup
- Refers To
-
|
| Name |
- Type
- string
- Properties
- Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description
- The name of the record.
|
| PatientId |
- Type
- Master-detail reference
- Properties
- Create, Filter, Group, Sort
- Description
- The patient for whom the medication is dispensed.
- Refers To
-
|
| PreparedDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date and time when the medication was prepared for
dispense.
|
| PrimaryDetectedIssueId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The primary clinical issue associated with the medication
dispensation. This field is available in API version 55.0 and
later.
- This field is a relationship field.
- Relationship Name
- PrimaryDetectedIssue
- Relationship Type
- Lookup
- Refers To
- ClinicalDetectedIssue
|
| PrimaryMedicationRequestId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The primary medication request that authorized the dispense of the
medication.
- Refers To
-
|
| PrimaryProcedureId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The primary medical procedure associated with the medication
dispensation. This field is available in API version 55.0 and
later.
- This field is a relationship field.
- Relationship Name
- PrimaryProcedure
- Relationship Type
- Lookup
- Refers To
- PatientMedicalProcedure
|
| Quantity |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The quantity of medication that was dispensed.
|
| QuantityUnitId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The unit of the quantity of medication that was dispensed.
- Refers To
-
|
| 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.
|
| SourceSystemModifiedDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date and time when this item was last changed in the source
system.
|
| Status |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Specifies the status of the dispense event.
- Possible values are:
- Cancelled
- Completed
- Declined
- Entered-In-Error
- In-Progress
- On-Hold
- Preparation
- Stopped
- Unknown
|
| StatusReasonCodeId |
- Type
- Polymorphic reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The system-defined code that specifies the reason for the
specified status.
- Refers To
-
|
| StatusReasonRelatedIssueId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Specifies clinical issue that resulted in the status of the
medication dispensation. This field is available in API version
55.0 and later.
- This field is a relationship field.
- Relationship Name
- StatusReasonRelatedIssue
- Relationship Type
- Lookup
- Refers To
- ClinicalDetectedIssue
|
| SubstitutedById |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Specifies the user or healthcare provider who substituted the
medication. This field is available in API version 55.0 and
later.
- This field is a polymorphic relationship field.
- Relationship Name
- SubstitutedBy
- Relationship Type
- Lookup
- Refers To
- HealthcareProvider, User
|
| SubstitutionReason |
- Type
- multipicklist
- Properties
- Create, Filter, Nillable, Update
- Description
- Specifies the reason for substituting the medication.
- Possible values are:
- Continuing therapy
- Formulary policy
- Out of stock
- Regulatory
requirement
- This field is available in API version 55.0 and later.
|
| SubstitutionType |
- Type
- picklist
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- Specifies the type of substitution done for the medication.
- Possible values are:
- Brand composition
- Equivalent
- Equivalent
composition
- Formulary
- Generic
composition
- None
- Therapeutic
alternative
- Therapeutic brand
- Therapeutic
generic
- This field is available in API version 55.0 and later.
|
| SupplyDaysCount |
- Type
- double
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The number of days that the dispensed supply is expected to
last.
|