Package org.hl7.fhir.r5.model

Class MedicationRequest.MedicationRequestDoseComponent

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.MedicationRequestDoseComponent

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.MedicationRequestDoseComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Dosage>	dosageInstruction	Specific instructions for how the medication is to be used by the patient.
protected DateTimeType	effectiveDosePeriod	The period over which the medication is to be taken.
protected StringType	renderedDosageInstruction	The full representation of the dose of the medication included in all dosage instructions.

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
MedicationRequestDoseComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Dosage	addDosageInstruction()
MedicationRequest.MedicationRequestDoseComponent	addDosageInstruction(Dosage t)
MedicationRequest.MedicationRequestDoseComponent	copy()
void	copyValues(MedicationRequest.MedicationRequestDoseComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Dosage>	getDosageInstruction()
Dosage	getDosageInstructionFirstRep()
Date	getEffectiveDosePeriod()
DateTimeType	getEffectiveDosePeriodElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getRenderedDosageInstruction()
StringType	getRenderedDosageInstructionElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDosageInstruction()
boolean	hasEffectiveDosePeriod()
boolean	hasEffectiveDosePeriodElement()
boolean	hasRenderedDosageInstruction()
boolean	hasRenderedDosageInstructionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
MedicationRequest.MedicationRequestDoseComponent	setDosageInstruction(List<Dosage> theDosageInstruction)
MedicationRequest.MedicationRequestDoseComponent	setEffectiveDosePeriod(Date value)
MedicationRequest.MedicationRequestDoseComponent	setEffectiveDosePeriodElement(DateTimeType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
MedicationRequest.MedicationRequestDoseComponent	setRenderedDosageInstruction(String value)
MedicationRequest.MedicationRequestDoseComponent	setRenderedDosageInstructionElement(StringType value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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

children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, 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 Detail

renderedDosageInstruction

protected StringType renderedDosageInstruction

The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

effectiveDosePeriod

protected DateTimeType effectiveDosePeriod

The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.

dosageInstruction

protected List<Dosage> dosageInstruction

Specific instructions for how the medication is to be used by the patient.

Constructor Detail

MedicationRequestDoseComponent

public MedicationRequestDoseComponent()

Constructor

Method Detail

getRenderedDosageInstructionElement

public StringType getRenderedDosageInstructionElement()

Returns:

renderedDosageInstruction (The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.). This is the underlying object with id, value and extensions. The accessor "getRenderedDosageInstruction" gives direct access to the value

hasRenderedDosageInstructionElement

public boolean hasRenderedDosageInstructionElement()

hasRenderedDosageInstruction

public boolean hasRenderedDosageInstruction()

setRenderedDosageInstructionElement

public MedicationRequest.MedicationRequestDoseComponent setRenderedDosageInstructionElement(StringType value)

Parameters:

value - renderedDosageInstruction (The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.). This is the underlying object with id, value and extensions. The accessor "getRenderedDosageInstruction" gives direct access to the value

getRenderedDosageInstruction

public String getRenderedDosageInstruction()

Returns:

The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

setRenderedDosageInstruction

public MedicationRequest.MedicationRequestDoseComponent setRenderedDosageInstruction(String value)

Parameters:

value - The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.

getEffectiveDosePeriodElement

public DateTimeType getEffectiveDosePeriodElement()

Returns:

effectiveDosePeriod (The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.). This is the underlying object with id, value and extensions. The accessor "getEffectiveDosePeriod" gives direct access to the value

hasEffectiveDosePeriodElement

public boolean hasEffectiveDosePeriodElement()

hasEffectiveDosePeriod

public boolean hasEffectiveDosePeriod()

setEffectiveDosePeriodElement

public MedicationRequest.MedicationRequestDoseComponent setEffectiveDosePeriodElement(DateTimeType value)

Parameters:

value - effectiveDosePeriod (The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.). This is the underlying object with id, value and extensions. The accessor "getEffectiveDosePeriod" gives direct access to the value

getEffectiveDosePeriod

public Date getEffectiveDosePeriod()

Returns:

The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.

setEffectiveDosePeriod

public MedicationRequest.MedicationRequestDoseComponent setEffectiveDosePeriod(Date value)

Parameters:

value - The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.

getDosageInstruction

public List<Dosage> getDosageInstruction()

Returns:

dosageInstruction (Specific instructions for how the medication is to be used by the patient.)

setDosageInstruction

public MedicationRequest.MedicationRequestDoseComponent setDosageInstruction(List<Dosage> theDosageInstruction)

Returns:

Returns a reference to this for easy method chaining

hasDosageInstruction

public boolean hasDosageInstruction()

addDosageInstruction

public Dosage addDosageInstruction()

addDosageInstruction

public MedicationRequest.MedicationRequestDoseComponent addDosageInstruction(Dosage t)

getDosageInstructionFirstRep

public Dosage getDosageInstructionFirstRep()

Returns:

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

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

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.MedicationRequestDoseComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(MedicationRequest.MedicationRequestDoseComponent 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