Package org.hl7.fhir.r5.model

Class MedicationRequest.MedicationRequestDispenseRequestComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.MedicationRequest.MedicationRequestDispenseRequestComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

MedicationRequest

public static class MedicationRequest.MedicationRequestDispenseRequestComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Duration	dispenseInterval	The minimum period of time that must occur between dispenses of the medication.
protected Reference	dispenser	Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.
protected List<Annotation>	dispenserInstruction	Provides additional information to the dispenser, for example, counselling to be provided to the patient.
protected CodeableConcept	doseAdministrationAid	Provides information about the type of adherence packaging to be supplied for the medication dispense.
protected Duration	expectedSupplyDuration	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.
protected MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent	initialFill	Indicates the quantity or duration for the first dispense of the medication.
protected UnsignedIntType	numberOfRepeatsAllowed	An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication.
protected Quantity	quantity	The amount that is to be dispensed for one fill.
protected Period	validityPeriod	This indicates the validity period of a prescription (stale dating the Prescription).

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
MedicationRequestDispenseRequestComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Annotation	addDispenserInstruction()
MedicationRequest.MedicationRequestDispenseRequestComponent	addDispenserInstruction(Annotation t)
MedicationRequest.MedicationRequestDispenseRequestComponent	copy()
void	copyValues(MedicationRequest.MedicationRequestDispenseRequestComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Duration	getDispenseInterval()
Reference	getDispenser()
List<Annotation>	getDispenserInstruction()
Annotation	getDispenserInstructionFirstRep()
CodeableConcept	getDoseAdministrationAid()
Duration	getExpectedSupplyDuration()
MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent	getInitialFill()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
int	getNumberOfRepeatsAllowed()
UnsignedIntType	getNumberOfRepeatsAllowedElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
String[]	getTypesForProperty(int hash, String name)
Period	getValidityPeriod()
boolean	hasDispenseInterval()
boolean	hasDispenser()
boolean	hasDispenserInstruction()
boolean	hasDoseAdministrationAid()
boolean	hasExpectedSupplyDuration()
boolean	hasInitialFill()
boolean	hasNumberOfRepeatsAllowed()
boolean	hasNumberOfRepeatsAllowedElement()
boolean	hasQuantity()
boolean	hasValidityPeriod()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setDispenseInterval(Duration value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setDispenser(Reference value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setDispenserInstruction(List<Annotation> theDispenserInstruction)
MedicationRequest.MedicationRequestDispenseRequestComponent	setDoseAdministrationAid(CodeableConcept value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setExpectedSupplyDuration(Duration value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setInitialFill(MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setNumberOfRepeatsAllowed(int value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setNumberOfRepeatsAllowedElement(UnsignedIntType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setQuantity(Quantity value)
MedicationRequest.MedicationRequestDispenseRequestComponent	setValidityPeriod(Period value)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

initialFill

protected MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent initialFill

Indicates the quantity or duration for the first dispense of the medication.

dispenseInterval

protected Duration dispenseInterval

The minimum period of time that must occur between dispenses of the medication.

validityPeriod

protected Period validityPeriod

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

numberOfRepeatsAllowed

protected UnsignedIntType numberOfRepeatsAllowed

An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that 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. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

quantity

protected Quantity quantity

The amount that is to be dispensed for one fill.

expectedSupplyDuration

protected Duration expectedSupplyDuration

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.

dispenser

protected Reference dispenser

Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.

dispenserInstruction

protected List<Annotation> dispenserInstruction

Provides additional information to the dispenser, for example, counselling to be provided to the patient.

doseAdministrationAid

protected CodeableConcept doseAdministrationAid

Provides information about the type of adherence packaging to be supplied for the medication dispense.

Constructor Details

MedicationRequestDispenseRequestComponent

public MedicationRequestDispenseRequestComponent()

Constructor

Method Details

getInitialFill

public MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent getInitialFill()

Returns:

initialFill (Indicates the quantity or duration for the first dispense of the medication.)

hasInitialFill

public boolean hasInitialFill()

setInitialFill

public MedicationRequest.MedicationRequestDispenseRequestComponent setInitialFill(MedicationRequest.MedicationRequestDispenseRequestInitialFillComponent value)

Parameters:

value - initialFill (Indicates the quantity or duration for the first dispense of the medication.)

getDispenseInterval

public Duration getDispenseInterval()

Returns:

dispenseInterval (The minimum period of time that must occur between dispenses of the medication.)

hasDispenseInterval

public boolean hasDispenseInterval()

setDispenseInterval

public MedicationRequest.MedicationRequestDispenseRequestComponent setDispenseInterval(Duration value)

Parameters:

value - dispenseInterval (The minimum period of time that must occur between dispenses of the medication.)

getValidityPeriod

public Period getValidityPeriod()

Returns:

validityPeriod (This indicates the validity period of a prescription (stale dating the Prescription).)

hasValidityPeriod

public boolean hasValidityPeriod()

setValidityPeriod

public MedicationRequest.MedicationRequestDispenseRequestComponent setValidityPeriod(Period value)

Parameters:

value - validityPeriod (This indicates the validity period of a prescription (stale dating the Prescription).)

getNumberOfRepeatsAllowedElement

public UnsignedIntType getNumberOfRepeatsAllowedElement()

Returns:

numberOfRepeatsAllowed (An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that 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. A prescriber may explicitly say that zero refills are permitted after the initial dispense.). This is the underlying object with id, value and extensions. The accessor "getNumberOfRepeatsAllowed" gives direct access to the value

hasNumberOfRepeatsAllowedElement

public boolean hasNumberOfRepeatsAllowedElement()

hasNumberOfRepeatsAllowed

public boolean hasNumberOfRepeatsAllowed()

setNumberOfRepeatsAllowedElement

public MedicationRequest.MedicationRequestDispenseRequestComponent setNumberOfRepeatsAllowedElement(UnsignedIntType value)

Parameters:

value - numberOfRepeatsAllowed (An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that 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. A prescriber may explicitly say that zero refills are permitted after the initial dispense.). This is the underlying object with id, value and extensions. The accessor "getNumberOfRepeatsAllowed" gives direct access to the value

getNumberOfRepeatsAllowed

public int getNumberOfRepeatsAllowed()

Returns:

An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that 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. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

setNumberOfRepeatsAllowed

public MedicationRequest.MedicationRequestDispenseRequestComponent setNumberOfRepeatsAllowed(int value)

Parameters:

value - An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that 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. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

getQuantity

public Quantity getQuantity()

Returns:

quantity (The amount that is to be dispensed for one fill.)

hasQuantity

public boolean hasQuantity()

setQuantity

public MedicationRequest.MedicationRequestDispenseRequestComponent setQuantity(Quantity value)

Parameters:

value - quantity (The amount that is to be dispensed for one fill.)

getExpectedSupplyDuration

public Duration getExpectedSupplyDuration()

Returns:

expectedSupplyDuration (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.)

hasExpectedSupplyDuration

public boolean hasExpectedSupplyDuration()

setExpectedSupplyDuration

public MedicationRequest.MedicationRequestDispenseRequestComponent setExpectedSupplyDuration(Duration value)

Parameters:

value - expectedSupplyDuration (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.)

getDispenser

public Reference getDispenser()

Returns:

dispenser (Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.)

hasDispenser

public boolean hasDispenser()

setDispenser

public MedicationRequest.MedicationRequestDispenseRequestComponent setDispenser(Reference value)

Parameters:

value - dispenser (Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.)

getDispenserInstruction

public List<Annotation> getDispenserInstruction()

Returns:

dispenserInstruction (Provides additional information to the dispenser, for example, counselling to be provided to the patient.)

setDispenserInstruction

public MedicationRequest.MedicationRequestDispenseRequestComponent setDispenserInstruction(List<Annotation> theDispenserInstruction)

Returns:

Returns a reference to this for easy method chaining

hasDispenserInstruction

public boolean hasDispenserInstruction()

addDispenserInstruction

public Annotation addDispenserInstruction()

addDispenserInstruction

public MedicationRequest.MedicationRequestDispenseRequestComponent addDispenserInstruction(Annotation t)

getDispenserInstructionFirstRep

public Annotation getDispenserInstructionFirstRep()

Returns:

The first repetition of repeating field dispenserInstruction, creating it if it does not already exist {3}

getDoseAdministrationAid

public CodeableConcept getDoseAdministrationAid()

Returns:

doseAdministrationAid (Provides information about the type of adherence packaging to be supplied for the medication dispense.)

hasDoseAdministrationAid

public boolean hasDoseAdministrationAid()

setDoseAdministrationAid

public MedicationRequest.MedicationRequestDispenseRequestComponent setDoseAdministrationAid(CodeableConcept value)

Parameters:

value - doseAdministrationAid (Provides information about the type of adherence packaging to be supplied for the medication dispense.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public MedicationRequest.MedicationRequestDispenseRequestComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(MedicationRequest.MedicationRequestDispenseRequestComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)