Package ca.uhn.fhir.model.dstu2.resource

Class MedicationOrder.DispenseRequest

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.resource.MedicationOrder.DispenseRequest
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
Enclosing class:
MedicationOrder
public static class MedicationOrder.DispenseRequest extends ca.uhn.fhir.model.api.BaseIdentifiableElement implements ca.uhn.fhir.model.api.IResourceBlock
Block class for child element: MedicationOrder.dispenseRequest ()

Definition: Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

See Also:

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getMedication

      public ca.uhn.fhir.model.api.IDatatype getMedication()
      Gets the value(s) for medication[x] (). creating it if it does not exist. Will not return null.

      Definition: Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

    • setMedication

      public MedicationOrder.DispenseRequest setMedication(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for medication[x] ()

      Definition: Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

    • getValidityPeriod

      public PeriodDt getValidityPeriod()
      Gets the value(s) for validityPeriod (). creating it if it does not exist. Will not return null.

      Definition: This indicates the validity period of a prescription (stale dating the Prescription)

    • setValidityPeriod

      public MedicationOrder.DispenseRequest setValidityPeriod(PeriodDt theValue)
      Sets the value(s) for validityPeriod ()

      Definition: This indicates the validity period of a prescription (stale dating the Prescription)

    • getNumberOfRepeatsAllowedElement

      public ca.uhn.fhir.model.primitive.PositiveIntDt getNumberOfRepeatsAllowedElement()
      Gets the value(s) for numberOfRepeatsAllowed (). creating it if it does not exist. Will not return null.

      Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

    • getNumberOfRepeatsAllowed

      public Integer getNumberOfRepeatsAllowed()
      Gets the value(s) for numberOfRepeatsAllowed (). creating it if it does not exist. This method may return null.

      Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

    • setNumberOfRepeatsAllowed

      public MedicationOrder.DispenseRequest setNumberOfRepeatsAllowed(ca.uhn.fhir.model.primitive.PositiveIntDt theValue)
      Sets the value(s) for numberOfRepeatsAllowed ()

      Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

    • setNumberOfRepeatsAllowed

      public MedicationOrder.DispenseRequest setNumberOfRepeatsAllowed(int theInteger)
      Sets the value for numberOfRepeatsAllowed ()

      Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

    • getQuantity

      public SimpleQuantityDt getQuantity()
      Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

      Definition: The amount that is to be dispensed for one fill.

    • setQuantity

      public MedicationOrder.DispenseRequest setQuantity(SimpleQuantityDt theValue)
      Sets the value(s) for quantity ()

      Definition: The amount that is to be dispensed for one fill.

    • getExpectedSupplyDuration

      public DurationDt getExpectedSupplyDuration()
      Gets the value(s) for expectedSupplyDuration (). creating it if it does not exist. Will not return null.

      Definition: Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

    • setExpectedSupplyDuration

      public MedicationOrder.DispenseRequest setExpectedSupplyDuration(DurationDt theValue)
      Sets the value(s) for expectedSupplyDuration ()

      Definition: Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.