Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicationDispense

class HS.FHIR.DTL.vR4.Model.Resource.MedicationDispense extends HS.FHIR.DTL.vR4.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.vR4.Model.Base.Reference (XMLNAME = "authorizingPrescription", XMLPROJECTION = "ELEMENT");
Reference

Medication order that authorizes the dispense.

MedicationRequest

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

Type of medication dispense.

medicationdispense-category is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in medicationdispense-category, you may use codes from any ValueSet.

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property context as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter / Episode associated with event.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property daysSupply as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "daysSupply", XMLPROJECTION = "ELEMENT");
Quantity

Amount of medication expressed as a timing amount.

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

Where the medication was sent.

Location

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

Clinical issue with action.

DetectedIssue

Property methods: detectedIssueBuildValueArray(), detectedIssueCollectionToDisplay(), detectedIssueCollectionToOdbc(), detectedIssueDisplayToCollection(), detectedIssueGet(), detectedIssueGetObject(), detectedIssueGetObjectId(), detectedIssueGetSwizzled(), detectedIssueIsValid(), detectedIssueOdbcToCollection(), detectedIssueSet(), detectedIssueSetObject(), detectedIssueSetObjectId()
property dosageInstruction as list of HS.FHIR.DTL.vR4.Model.Element.Dosage (XMLNAME = "dosageInstruction", XMLPROJECTION = "ELEMENT");
Dosage

How the medication is to be used by the patient or administered by the caregiver.

Property methods: dosageInstructionBuildValueArray(), dosageInstructionCollectionToDisplay(), dosageInstructionCollectionToOdbc(), dosageInstructionDisplayToCollection(), dosageInstructionGet(), dosageInstructionGetObject(), dosageInstructionGetObjectId(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionOdbcToCollection(), dosageInstructionSet(), dosageInstructionSetObject(), dosageInstructionSetObjectId()
property eventHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "eventHistory", XMLPROJECTION = "ELEMENT");
Reference

A list of relevant lifecycle events.

Provenance

Property methods: eventHistoryBuildValueArray(), eventHistoryCollectionToDisplay(), eventHistoryCollectionToOdbc(), eventHistoryDisplayToCollection(), eventHistoryGet(), eventHistoryGetObject(), eventHistoryGetObjectId(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryOdbcToCollection(), eventHistorySet(), eventHistorySetObject(), eventHistorySetObjectId()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where the dispense occurred.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property medicationCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What medication was supplied.

any FHIR4 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

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

What medication was supplied.

Medication.

Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Information about the dispense.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Event that dispense is part of.

Procedure

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performer as list of HS.FHIR.DTL.vR4.Model.Element.MedicationDispense.performer (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
BackboneElement

Who performed event.

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property quantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "quantity", XMLPROJECTION = "ELEMENT");
Quantity

Amount dispensed.

Property methods: quantityGet(), quantityGetSwizzled(), quantityIsValid(), quantityNewObject(), quantitySet()
property receiver as list of HS.FHIR.DTL.vR4.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") [ Required ];
code

preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown

medicationdispense-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medicationdispense-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonCodeableConceptGet(), statusReasonCodeableConceptGetSwizzled(), statusReasonCodeableConceptIsValid(), statusReasonCodeableConceptNewObject(), statusReasonCodeableConceptSet(), statusReasonReferenceGet(), statusReasonReferenceGetSwizzled(), statusReasonReferenceIsValid(), statusReasonReferenceNewObject(), statusReasonReferenceSet(), statusSet()
property statusReasonCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReasonCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why a dispense was not performed.

any FHIR4 code may be used; medicationdispense-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonCodeableConceptGet(), statusReasonCodeableConceptGetSwizzled(), statusReasonCodeableConceptIsValid(), statusReasonCodeableConceptNewObject(), statusReasonCodeableConceptSet()
property statusReasonReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "statusReasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why a dispense was not performed.

DetectedIssue.

Property methods: statusReasonReferenceGet(), statusReasonReferenceGetSwizzled(), statusReasonReferenceIsValid(), statusReasonReferenceNewObject(), statusReasonReferenceSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Who the dispense is for.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property substitution as HS.FHIR.DTL.vR4.Model.Element.MedicationDispense.substitution (XMLNAME = "substitution", XMLPROJECTION = "ELEMENT");
BackboneElement

Whether a substitution was performed on the dispense.

Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()
property supportingInformation as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Information that supports the dispensing of the medication.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Trial fill, partial fill, emergency fill, etc.

any FHIR4 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

When product was packaged and reviewed.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab