Package org.hl7.fhir.dstu2.model

Class MedicationOrder.MedicationOrderDispenseRequestComponent

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.BackboneElement

org.hl7.fhir.dstu2.model.MedicationOrder.MedicationOrderDispenseRequestComponent

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:

MedicationOrder

public static class MedicationOrder.MedicationOrderDispenseRequestComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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 Type	medication	Identifies the medication being administered.
protected PositiveIntType	numberOfRepeatsAllowed	An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication.
protected SimpleQuantity	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.dstu2.model.BackboneElement

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
MedicationOrderDispenseRequestComponent()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
MedicationOrder.MedicationOrderDispenseRequestComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Duration	getExpectedSupplyDuration()
Type	getMedication()
CodeableConcept	getMedicationCodeableConcept()
Reference	getMedicationReference()
int	getNumberOfRepeatsAllowed()
PositiveIntType	getNumberOfRepeatsAllowedElement()
SimpleQuantity	getQuantity()
Period	getValidityPeriod()
boolean	hasExpectedSupplyDuration()
boolean	hasMedication()
boolean	hasMedicationCodeableConcept()
boolean	hasMedicationReference()
boolean	hasNumberOfRepeatsAllowed()
boolean	hasNumberOfRepeatsAllowedElement()
boolean	hasQuantity()
boolean	hasValidityPeriod()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
MedicationOrder.MedicationOrderDispenseRequestComponent	setExpectedSupplyDuration(Duration value)
MedicationOrder.MedicationOrderDispenseRequestComponent	setMedication(Type value)
MedicationOrder.MedicationOrderDispenseRequestComponent	setNumberOfRepeatsAllowed(int value)
MedicationOrder.MedicationOrderDispenseRequestComponent	setNumberOfRepeatsAllowedElement(PositiveIntType value)
void	setProperty(String name, Base value)
MedicationOrder.MedicationOrderDispenseRequestComponent	setQuantity(SimpleQuantity value)
MedicationOrder.MedicationOrderDispenseRequestComponent	setValidityPeriod(Period value)

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

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

medication

protected Type medication

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.

validityPeriod

protected Period validityPeriod

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

numberOfRepeatsAllowed

protected PositiveIntType numberOfRepeatsAllowed

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.

quantity

protected SimpleQuantity 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.

Constructor Details

MedicationOrderDispenseRequestComponent

public MedicationOrderDispenseRequestComponent()

Method Details

getMedication

public Type getMedication()

Returns:

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

getMedicationCodeableConcept

public CodeableConcept getMedicationCodeableConcept()
                                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasMedicationCodeableConcept

public boolean hasMedicationCodeableConcept()

getMedicationReference

public Reference getMedicationReference()
                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasMedicationReference

public boolean hasMedicationReference()

hasMedication

public boolean hasMedication()

setMedication

public MedicationOrder.MedicationOrderDispenseRequestComponent setMedication(Type value)

Parameters:

value - medication (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 Period getValidityPeriod()

Returns:

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

hasValidityPeriod

public boolean hasValidityPeriod()

setValidityPeriod

public MedicationOrder.MedicationOrderDispenseRequestComponent setValidityPeriod(Period value)

Parameters:

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

getNumberOfRepeatsAllowedElement

public PositiveIntType getNumberOfRepeatsAllowedElement()

Returns:

numberOfRepeatsAllowed (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.). 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 MedicationOrder.MedicationOrderDispenseRequestComponent setNumberOfRepeatsAllowedElement(PositiveIntType value)

Parameters:

value - numberOfRepeatsAllowed (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.). 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 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.MedicationOrderDispenseRequestComponent setNumberOfRepeatsAllowed(int value)

Parameters:

value - 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 SimpleQuantity getQuantity()

Returns:

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

hasQuantity

public boolean hasQuantity()

setQuantity

public MedicationOrder.MedicationOrderDispenseRequestComponent setQuantity(SimpleQuantity 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 MedicationOrder.MedicationOrderDispenseRequestComponent 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.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

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

Overrides:

setProperty 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 MedicationOrder.MedicationOrderDispenseRequestComponent copy()

Specified by:

copy in class BackboneElement

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