Data Model Libraries
    Preparing search index...

    Class MedicationDispense

    MedicationDispense Class

    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.

    FHIR Specification

    • Short: Dispensing a medication to a named patient
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR MedicationDispense

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? basedOn? partOf? medicationdispenseStatusEnum status notPerformedReason? statusChanged? category? medication subject encounter? supportingInformation? performer? location? authorizingPrescription? type_? quantity? daysSupply? recorded? whenPrepared? whenHandedOver? destination? receiver? note? renderedDosageInstruction? dosageInstruction? substitution? eventHistory?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getNotPerformedReason setNotPerformedReason hasNotPerformedReason getStatusChangedElement setStatusChangedElement hasStatusChangedElement getStatusChanged setStatusChanged hasStatusChanged getCategory setCategory addCategory hasCategory getMedication setMedication hasMedication getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation getPerformer setPerformer addPerformer hasPerformer getLocation setLocation hasLocation getAuthorizingPrescription setAuthorizingPrescription addAuthorizingPrescription hasAuthorizingPrescription getType setType hasType getQuantity setQuantity hasQuantity getDaysSupply setDaysSupply hasDaysSupply getRecordedElement setRecordedElement hasRecordedElement getRecorded setRecorded hasRecorded getWhenPreparedElement setWhenPreparedElement hasWhenPreparedElement getWhenPrepared setWhenPrepared hasWhenPrepared getWhenHandedOverElement setWhenHandedOverElement hasWhenHandedOverElement getWhenHandedOver setWhenHandedOver hasWhenHandedOver getDestination setDestination hasDestination getReceiver setReceiver addReceiver hasReceiver getNote setNote addNote hasNote getRenderedDosageInstructionElement setRenderedDosageInstructionElement hasRenderedDosageInstructionElement getRenderedDosageInstruction setRenderedDosageInstruction hasRenderedDosageInstruction getDosageInstruction setDosageInstruction addDosageInstruction hasDosageInstruction getSubstitution setSubstitution hasSubstitution getEventHistory setEventHistory addEventHistory hasEventHistory fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initBasedOn initPartOf initCategory initSupportingInformation initPerformer initAuthorizingPrescription initReceiver initNote initDosageInstruction initEventHistory

    Constructors

    Properties

    identifier?: Identifier[]

    MedicationDispense.identifier Element

    FHIR Specification

    • Short: External identifier
    • Definition: 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.
    • Comment: This is a business identifier, not a resource identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    basedOn?: Reference[]

    MedicationDispense.basedOn Element

    FHIR Specification

    • Short: Plan that is fulfilled by this dispense
    • Definition: A plan that is fulfilled in whole or in part by this MedicationDispense.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    partOf?: Reference[]

    MedicationDispense.partOf Element

    FHIR Specification

    medicationdispenseStatusEnum: MedicationdispenseStatusEnum

    FHIR CodeSystem: MedicationdispenseStatus

    MedicationdispenseStatusEnum

    status: null | EnumCodeType

    MedicationDispense.status Element

    FHIR Specification

    • Short: preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown
    • Definition: A code specifying the state of the set of dispense events.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: MedicationdispenseStatusEnum

    notPerformedReason?: CodeableReference

    MedicationDispense.notPerformedReason Element

    FHIR Specification

    • Short: Why a dispense was not performed
    • Definition: Indicates the reason why a dispense was not performed.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    statusChanged?: DateTimeType

    MedicationDispense.statusChanged Element

    FHIR Specification

    • Short: When the status changed
    • Definition: The date (and maybe time) when the status of the dispense record changed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    category?: CodeableConcept[]

    MedicationDispense.category Element

    FHIR Specification

    • Short: Type of medication dispense
    • Definition: Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).
    • Comment: The category can be used to include where the medication is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    medication: null | CodeableReference

    MedicationDispense.medication Element

    FHIR Specification

    • Short: What medication was supplied
    • Definition: 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.
    • Comment: If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource.
    • FHIR Type: CodeableReference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    MedicationDispense.subject Element

    FHIR Specification

    encounter?: Reference

    MedicationDispense.encounter Element

    FHIR Specification

    • Short: Encounter associated with event
    • Definition: The encounter that establishes the context for this event.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    supportingInformation?: Reference[]

    MedicationDispense.supportingInformation Element

    FHIR Specification

    • Short: Information that supports the dispensing of the medication
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    performer?: MedicationDispensePerformerComponent[]

    MedicationDispense.performer Element

    FHIR Specification

    • Short: Who performed event
    • Definition: Indicates who or what performed the event.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    location?: Reference

    MedicationDispense.location Element

    FHIR Specification

    • Short: Where the dispense occurred
    • Definition: The principal physical location where the dispense was performed.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    authorizingPrescription?: Reference[]

    MedicationDispense.authorizingPrescription Element

    FHIR Specification

    • Short: Medication order that authorizes the dispense
    • Definition: Indicates the medication order that is being dispensed against.
    • Comment: Maps to basedOn in Event logical model.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Private Optionaltype_

    type_?: CodeableConcept

    MedicationDispense.type Element

    FHIR Specification

    • Short: Trial fill, partial fill, emergency fill, etc
    • Definition: Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    MedicationDispense.quantity Element

    FHIR Specification

    • Short: Amount dispensed
    • Definition: The amount of medication that has been dispensed. Includes unit of measure.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    daysSupply?: Quantity

    MedicationDispense.daysSupply Element

    FHIR Specification

    • Short: Amount of medication expressed as a timing amount
    • Definition: The amount of medication expressed as a timing amount.
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    recorded?: DateTimeType

    MedicationDispense.recorded Element

    FHIR Specification

    • Short: When the recording of the dispense started
    • Definition: The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    whenPrepared?: DateTimeType

    MedicationDispense.whenPrepared Element

    FHIR Specification

    • Short: When product was packaged and reviewed
    • Definition: The time when the dispensed product was packaged and reviewed.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    whenHandedOver?: DateTimeType

    MedicationDispense.whenHandedOver Element

    FHIR Specification

    • Short: When product was given out
    • Definition: The time the dispensed product was provided to the patient or their representative.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    destination?: Reference

    MedicationDispense.destination Element

    FHIR Specification

    • Short: Where the medication was/will be sent
    • Definition: Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    receiver?: Reference[]

    MedicationDispense.receiver Element

    FHIR Specification

    note?: Annotation[]

    MedicationDispense.note Element

    FHIR Specification

    • Short: Information about the dispense
    • Definition: Extra information about the dispense that could not be conveyed in the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    renderedDosageInstruction?: MarkdownType

    MedicationDispense.renderedDosageInstruction Element

    FHIR Specification

    • Short: Full representation of the dosage instructions
    • Definition: 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.
    • Comment: The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    dosageInstruction?: Dosage[]

    MedicationDispense.dosageInstruction Element

    FHIR Specification

    • Short: How the medication is to be used by the patient or administered by the caregiver
    • Definition: Indicates how the medication is to be used by the patient.
    • Comment: When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.
    • FHIR Type: Dosage
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    substitution?: MedicationDispenseSubstitutionComponent

    MedicationDispense.substitution Element

    FHIR Specification

    • Short: Whether a substitution was performed on the dispense
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    eventHistory?: Reference[]

    MedicationDispense.eventHistory Element

    FHIR Specification

    • Short: A list of relevant lifecycle events
    • Definition: A summary of the events of interest that have occurred, such as when the dispense was verified.
    • Comment: This might not include provenances for all versions of the request - only those deemed "relevant" or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MedicationDispense JSON to instantiate the MedicationDispense data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationDispense

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicationDispense

      Returns undefined | MedicationDispense

      MedicationDispense data model or undefined for MedicationDispense

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetBasedOnsetBasedOnaddBasedOnhasBasedOngetPartOfsetPartOfaddPartOfhasPartOfgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetNotPerformedReasonsetNotPerformedReasonhasNotPerformedReasongetStatusChangedElementsetStatusChangedElementhasStatusChangedElementgetStatusChangedsetStatusChangedhasStatusChangedgetCategorysetCategoryaddCategoryhasCategorygetMedicationsetMedicationhasMedicationgetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetSupportingInformationsetSupportingInformationaddSupportingInformationhasSupportingInformationgetPerformersetPerformeraddPerformerhasPerformergetLocationsetLocationhasLocationgetAuthorizingPrescriptionsetAuthorizingPrescriptionaddAuthorizingPrescriptionhasAuthorizingPrescriptiongetTypesetTypehasTypegetQuantitysetQuantityhasQuantitygetDaysSupplysetDaysSupplyhasDaysSupplygetRecordedElementsetRecordedElementhasRecordedElementgetRecordedsetRecordedhasRecordedgetWhenPreparedElementsetWhenPreparedElementhasWhenPreparedElementgetWhenPreparedsetWhenPreparedhasWhenPreparedgetWhenHandedOverElementsetWhenHandedOverElementhasWhenHandedOverElementgetWhenHandedOversetWhenHandedOverhasWhenHandedOvergetDestinationsetDestinationhasDestinationgetReceiversetReceiveraddReceiverhasReceivergetNotesetNoteaddNotehasNotegetRenderedDosageInstructionElementsetRenderedDosageInstructionElementhasRenderedDosageInstructionElementgetRenderedDosageInstructionsetRenderedDosageInstructionhasRenderedDosageInstructiongetDosageInstructionsetDosageInstructionaddDosageInstructionhasDosageInstructiongetSubstitutionsetSubstitutionhasSubstitutiongetEventHistorysetEventHistoryaddEventHistoryhasEventHistoryfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitBasedOninitPartOfinitCategoryinitSupportingInformationinitPerformerinitAuthorizingPrescriptioninitReceiverinitNoteinitDosageInstructioninitEventHistory