MedicationDispense class
MedicationDispense Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
MedicationDispense({@Default(R5ResourceType.MedicationDispense) @JsonKey(unknownEnumValue: R5ResourceType.MedicationDispense) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, List<Reference> ? basedOn, List<Reference> ? partOf, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableReference? notPerformedReason, FhirDateTime? statusChanged, @JsonKey(name: '_statusChanged') Element? statusChangedElement, List<CodeableConcept> ? category, required CodeableReference medication, required Reference subject, Reference? encounter, List<Reference> ? supportingInformation, List<MedicationDispensePerformer> ? performer, Reference? location, List<Reference> ? authorizingPrescription, CodeableConcept? type, Quantity? quantity, Quantity? daysSupply, FhirDateTime? recorded, @JsonKey(name: '_recorded') Element? recordedElement, FhirDateTime? whenPrepared, @JsonKey(name: '_whenPrepared') Element? whenPreparedElement, FhirDateTime? whenHandedOver, @JsonKey(name: '_whenHandedOver') Element? whenHandedOverElement, Reference? destination, List<Reference> ? receiver, List<Annotation> ? note, FhirMarkdown? renderedDosageInstruction, @JsonKey(name: '_renderedDosageInstruction') Element? renderedDosageInstructionElement, List<Dosage> ? dosageInstruction, MedicationDispenseSubstitution? substitution, List<Reference> ? eventHistory}) -
MedicationDispense Indicates that a medication product is to be or has
been dispensed for a named person/patient. This includes a description
of the medication product (supply) provided and the instructions for
administering the medication. The medication dispense is the result of
a pharmacy system responding to a medication order.
constfactory
-
MedicationDispense.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- MedicationDispense.fromJsonString(String source)
-
Acts like a constructor, returns a MedicationDispense, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- MedicationDispense.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
authorizingPrescription Indicates the medication order that is being
dispensed against.
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn A plan that is fulfilled in whole or in part by this
MedicationDispense.
no setterinherited
-
category
→ List<
CodeableConcept> ? -
category Indicates the type of medication dispense (for example, drug
classification like ATC, where meds would be administered, legal
category of the medication.).
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $MedicationDispenseCopyWith<
MedicationDispense> -
no setterinherited
- daysSupply → Quantity?
-
daysSupply The amount of medication expressed as a timing amount.
no setterinherited
- dbId → int?
-
no setterinherited
- destination → Reference?
-
destination Identification of the facility/location where the
medication was/will be shipped to, as part of the dispense event.
no setterinherited
-
dosageInstruction
→ List<
Dosage> ? -
dosageInstruction Indicates how the medication is to be used by the
patient.
no setterinherited
- encounter → Reference?
-
encounter The encounter that establishes the context for this event.
no setterinherited
-
eventHistory
→ List<
Reference> ? -
eventHistory A summary of the events of interest that have occurred,
such as when the dispense was verified.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifiers associated with this Medication Dispense that
are defined by business processes and/or used to refer to it when a
direct URL reference to the resource itself is not appropriate. They
are business identifiers assigned to this resource by the performer or
other systems and remain constant as the resource is updated and
propagates from server to server.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- location → Reference?
-
location The principal physical location where the dispense was
performed.
no setterinherited
- medication → CodeableReference
-
medication Identifies the medication supplied. This is either a link
to a resource representing the details of the medication or a simple
attribute carrying a code that identifies the medication from a known
list of medications.
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
-
note
→ List<
Annotation> ? -
note Extra information about the dispense that could not be conveyed
in the other attributes.
no setterinherited
- notPerformedReason → CodeableReference?
-
notPerformedReason Indicates the reason why a dispense was not
performed.
no setterinherited
-
partOf
→ List<
Reference> ? -
partOf The procedure or medication administration that triggered the
dispense.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
performer
→ List<
MedicationDispensePerformer> ? -
performer Indicates who or what performed the event.
no setterinherited
- quantity → Quantity?
-
quantity The amount of medication that has been dispensed. Includes
unit of measure.
no setterinherited
-
receiver
→ List<
Reference> ? -
receiver Identifies the person who picked up the medication or the
location of where the medication was delivered. This will usually be
a patient or their caregiver, but some cases exist where it can be a
healthcare professional or a location.
no setterinherited
- recorded → FhirDateTime?
-
recorded The date (and maybe time) when the dispense activity started
if whenPrepared or whenHandedOver is not populated.
no setterinherited
- recordedElement → Element?
-
recordedElement ("_recorded") Extensions for recorded
no setterinherited
- renderedDosageInstruction → FhirMarkdown?
-
renderedDosageInstruction The full representation of the dose of the
medication included in all dosage instructions. To be used when
multiple dosage instructions are included to represent complex dosing
such as increasing or tapering doses.
no setterinherited
- renderedDosageInstructionElement → Element?
-
renderedDosageInstructionElement ("_renderedDosageInstruction")
Extensions for renderedDosageInstruction
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a MedicationDispense resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status A code specifying the state of the set of dispense events.
no setterinherited
- statusChanged → FhirDateTime?
-
statusChanged The date (and maybe time) when the status of the
dispense record changed.
no setterinherited
- statusChangedElement → Element?
-
statusChangedElement ("_statusChanged") Extensions for statusChanged
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- subject → Reference
-
subject A link to a resource representing the person or the group to
whom the medication will be given.
no setterinherited
- substitution → MedicationDispenseSubstitution?
-
substitution Indicates whether or not substitution was made as part
of the dispense. In some cases, substitution will be expected but
does not happen, in other cases substitution is not expected but does
happen. This block explains what substitution did or did not happen
and why. If nothing is specified, substitution was not done.
no setterinherited
-
supportingInformation
→ List<
Reference> ? -
supportingInformation Additional information that supports the
medication being dispensed. For example, there may be requirements
that a specific lab test has been completed prior to dispensing or the
patient's weight at the time of dispensing is documented.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- type → CodeableConcept?
-
type Indicates the type of dispensing event that is performed. For
example, Trial Fill, Completion of Trial, Partial Fill, Emergency
Fill, Samples, etc.
no setterinherited
- whenHandedOver → FhirDateTime?
-
whenHandedOver The time the dispensed product was provided to the
patient or their representative.
no setterinherited
- whenHandedOverElement → Element?
-
whenHandedOverElement ("_whenHandedOver") Extensions for
whenHandedOver
no setterinherited
- whenPrepared → FhirDateTime?
-
whenPrepared The time when the dispensed product was packaged and
reviewed.
no setterinherited
- whenPreparedElement → Element?
-
whenPreparedElement ("_whenPrepared") Extensions for whenPrepared
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited