Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.MedicationDispense

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

Parameters

parameter ELEMENTQUALIFIED = 1;
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 XMLPROJECTION = ELEMENT;
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.

Properties

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

Medication order that authorizes the dispense.

MedicationOrder

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");
SimpleQuantity

Days Supply.

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

Where the medication was sent.

Location

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

Practitioner responsible for dispensing medication.

Practitioner

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

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");
Identifier

External identifier.

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

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 ];
Reference

What medication was supplied.

Medication.

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

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");
Reference

Who the dispense is for.

Patient

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

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");
Reference

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");
code

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");
BackboneElement

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");
CodeableConcept

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");
dateTime

When product was given out.

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

Dispense processing time.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab