Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.MedicationDispense extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

Dispensing a medication to a named patient.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = MedicationDispense;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = MedicationDispense;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property authorizingPrescription as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "authorizingPrescription", XMLPROJECTION = "ELEMENT");

Medication order that authorizes the dispense.


Property methods: authorizingPrescriptionBuildValueArray(), authorizingPrescriptionCollectionToDisplay(), authorizingPrescriptionCollectionToOdbc(), authorizingPrescriptionDisplayToCollection(), authorizingPrescriptionGet(), authorizingPrescriptionGetObject(), authorizingPrescriptionGetObjectId(), authorizingPrescriptionGetSwizzled(), authorizingPrescriptionIsValid(), authorizingPrescriptionOdbcToCollection(), authorizingPrescriptionSet(), authorizingPrescriptionSetObject(), authorizingPrescriptionSetObjectId()
property daysSupply as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "daysSupply", XMLPROJECTION = "ELEMENT");

Days Supply.

Property methods: daysSupplyGet(), daysSupplyGetSwizzled(), daysSupplyIsValid(), daysSupplyNewObject(), daysSupplySet()
property destination as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "destination", XMLPROJECTION = "ELEMENT");

Where the medication was sent.


Property methods: destinationGet(), destinationGetSwizzled(), destinationIsValid(), destinationNewObject(), destinationSet()
property dispenser as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "dispenser", XMLPROJECTION = "ELEMENT");

Practitioner responsible for dispensing medication.


Property methods: dispenserGet(), dispenserGetSwizzled(), dispenserIsValid(), dispenserNewObject(), dispenserSet()
property dosageInstruction as list of HS.FHIR.DTL.vDSTU2.Model.Element.MedicationDispense.dosageInstruction (XMLNAME = "dosageInstruction", XMLPROJECTION = "ELEMENT");

Medicine administration instructions to the patient/caregiver.

Property methods: dosageInstructionBuildValueArray(), dosageInstructionCollectionToDisplay(), dosageInstructionCollectionToOdbc(), dosageInstructionDisplayToCollection(), dosageInstructionGet(), dosageInstructionGetObject(), dosageInstructionGetObjectId(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionOdbcToCollection(), dosageInstructionSet(), dosageInstructionSetObject(), dosageInstructionSetObjectId()
property identifier as HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

External identifier.

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property medicationCodeableConcept as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];

What medication was supplied.

any FHIR2 code from any ValueSet may be used.

Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "medicationReference", XMLPROJECTION = "ELEMENT") [ Required ];

What medication was supplied.


Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as %String (MAXLEN = 1000000, XMLNAME = "note", XMLPROJECTION = "ATTRIBUTE");

Information about the dispense.

Property methods: noteDisplayToLogical(), noteGet(), noteIsValid(), noteLogicalToDisplay(), noteLogicalToOdbc(), noteNormalize(), noteSet()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");

Who the dispense is for.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property quantity as HS.FHIR.DTL.vDSTU2.Model.Datatype.SimpleQuantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");

Amount dispensed.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property receiver as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "receiver", XMLPROJECTION = "ELEMENT");

Who collected the medication.

Patient | Practitioner

Property methods: receiverBuildValueArray(), receiverCollectionToDisplay(), receiverCollectionToOdbc(), receiverDisplayToCollection(), receiverGet(), receiverGetObject(), receiverGetObjectId(), receiverGetSwizzled(), receiverIsValid(), receiverOdbcToCollection(), receiverSet(), receiverSetObject(), receiverSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

in-progress | on-hold | completed | entered-in-error | stopped

medication-dispense-status is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend medication-dispense-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property substitution as HS.FHIR.DTL.vDSTU2.Model.Element.MedicationDispense.substitution (XMLNAME = "substitution", XMLPROJECTION = "ELEMENT");

Deals with substitution of one medicine for another.

Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()
property type as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");

Trial fill, partial fill, emergency fill, etc.

any FHIR2 code may be used; v3-ActPharmacySupplyType shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property whenHandedOver as %String (MAXLEN = 1000000, XMLNAME = "whenHandedOver", XMLPROJECTION = "ATTRIBUTE");

When product was given out.

Property methods: whenHandedOverDisplayToLogical(), whenHandedOverGet(), whenHandedOverIsValid(), whenHandedOverLogicalToDisplay(), whenHandedOverLogicalToOdbc(), whenHandedOverNormalize(), whenHandedOverSet()
property whenPrepared as %String (MAXLEN = 1000000, XMLNAME = "whenPrepared", XMLPROJECTION = "ATTRIBUTE");

Dispense processing time.

Property methods: whenPreparedDisplayToLogical(), whenPreparedGet(), whenPreparedIsValid(), whenPreparedLogicalToDisplay(), whenPreparedLogicalToOdbc(), whenPreparedNormalize(), whenPreparedSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab