Package org.hl7.fhir.dstu2.model
Class NutritionOrder
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.NutritionOrder
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class NutritionOrder extends DomainResource
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classNutritionOrder.NutritionOrderEnteralFormulaAdministrationComponentstatic classNutritionOrder.NutritionOrderEnteralFormulaComponentstatic classNutritionOrder.NutritionOrderOralDietComponentstatic classNutritionOrder.NutritionOrderOralDietNutrientComponentstatic classNutritionOrder.NutritionOrderOralDietTextureComponentstatic classNutritionOrder.NutritionOrderStatusstatic classNutritionOrder.NutritionOrderStatusEnumFactorystatic classNutritionOrder.NutritionOrderSupplementComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>allergyIntoleranceA link to a record of allergies or intolerances which should be included in the nutrition order.protected List<AllergyIntolerance>allergyIntoleranceTargetThe actual objects that are the target of the reference (A link to a record of allergies or intolerances which should be included in the nutrition order.)protected DateTimeTypedateTimeThe date and time that this nutrition order was requested.protected ReferenceencounterAn encounter that provides additional information about the healthcare context in which this request is made.protected EncounterencounterTargetThe actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)protected NutritionOrder.NutritionOrderEnteralFormulaComponententeralFormulaFeeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.protected List<CodeableConcept>excludeFoodModifierThis modifier is used to convey order-specific modifiers about the type of food that should NOT be given.protected List<CodeableConcept>foodPreferenceModifierThis modifier is used to convey order-specific modifiers about the type of food that should be given.protected List<Identifier>identifierIdentifiers assigned to this order by the order sender or by the order receiver.protected NutritionOrder.NutritionOrderOralDietComponentoralDietDiet given orally in contrast to enteral (tube) feeding.protected ReferenceordererThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.protected PractitionerordererTargetThe actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)protected ReferencepatientThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.protected PatientpatientTargetThe actual object that is the target of the reference (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)static StringSP_ADDITIVEstatic StringSP_DATETIMEstatic StringSP_ENCOUNTERstatic StringSP_FORMULAstatic StringSP_IDENTIFIERstatic StringSP_ORALDIETstatic StringSP_PATIENTstatic StringSP_PROVIDERstatic StringSP_STATUSstatic StringSP_SUPPLEMENTprotected Enumeration<NutritionOrder.NutritionOrderStatus>statusThe workflow status of the nutrition order/request.protected List<NutritionOrder.NutritionOrderSupplementComponent>supplementOral nutritional products given in order to add further nutritional value to the patient's diet.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description NutritionOrder()NutritionOrder(Reference patient, DateTimeType dateTime)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
patient
protected Reference patient
The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
orderer
protected Reference orderer
The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
-
ordererTarget
protected Practitioner ordererTarget
The actual object that is the target of the reference (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
identifier
protected List<Identifier> identifier
Identifiers assigned to this order by the order sender or by the order receiver.
-
encounter
protected Reference encounter
An encounter that provides additional information about the healthcare context in which this request is made.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)
-
dateTime
protected DateTimeType dateTime
The date and time that this nutrition order was requested.
-
status
protected Enumeration<NutritionOrder.NutritionOrderStatus> status
The workflow status of the nutrition order/request.
-
allergyIntolerance
protected List<Reference> allergyIntolerance
A link to a record of allergies or intolerances which should be included in the nutrition order.
-
allergyIntoleranceTarget
protected List<AllergyIntolerance> allergyIntoleranceTarget
The actual objects that are the target of the reference (A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
foodPreferenceModifier
protected List<CodeableConcept> foodPreferenceModifier
This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
excludeFoodModifier
protected List<CodeableConcept> excludeFoodModifier
This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced allergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
oralDiet
protected NutritionOrder.NutritionOrderOralDietComponent oralDiet
Diet given orally in contrast to enteral (tube) feeding.
-
supplement
protected List<NutritionOrder.NutritionOrderSupplementComponent> supplement
Oral nutritional products given in order to add further nutritional value to the patient's diet.
-
enteralFormula
protected NutritionOrder.NutritionOrderEnteralFormulaComponent enteralFormula
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_DATETIME
public static final String SP_DATETIME
- See Also:
- Constant Field Values
-
SP_PROVIDER
public static final String SP_PROVIDER
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_SUPPLEMENT
public static final String SP_SUPPLEMENT
- See Also:
- Constant Field Values
-
SP_FORMULA
public static final String SP_FORMULA
- See Also:
- Constant Field Values
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
- See Also:
- Constant Field Values
-
SP_ORALDIET
public static final String SP_ORALDIET
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
SP_ADDITIVE
public static final String SP_ADDITIVE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NutritionOrder
public NutritionOrder()
-
NutritionOrder
public NutritionOrder(Reference patient, DateTimeType dateTime)
-
-
Method Detail
-
getPatient
public Reference getPatient()
- Returns:
patient(The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public NutritionOrder setPatient(Reference value)
- Parameters:
value-patient(The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
setPatientTarget
public NutritionOrder setPatientTarget(Patient value)
- Parameters:
value-patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
getOrderer
public Reference getOrderer()
- Returns:
orderer(The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
hasOrderer
public boolean hasOrderer()
-
setOrderer
public NutritionOrder setOrderer(Reference value)
- Parameters:
value-orderer(The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
getOrdererTarget
public Practitioner getOrdererTarget()
- Returns:
ordererThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
setOrdererTarget
public NutritionOrder setOrdererTarget(Practitioner value)
- Parameters:
value-ordererThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers assigned to this order by the order sender or by the order receiver.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(Identifiers assigned to this order by the order sender or by the order receiver.)
-
addIdentifier
public NutritionOrder addIdentifier(Identifier t)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public NutritionOrder setEncounter(Reference value)
- Parameters:
value-encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
getEncounterTarget
public Encounter getEncounterTarget()
- Returns:
encounterThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An encounter that provides additional information about the healthcare context in which this request is made.)
-
setEncounterTarget
public NutritionOrder setEncounterTarget(Encounter value)
- Parameters:
value-encounterThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (An encounter that provides additional information about the healthcare context in which this request is made.)
-
getDateTimeElement
public DateTimeType getDateTimeElement()
- Returns:
dateTime(The date and time that this nutrition order was requested.). This is the underlying object with id, value and extensions. The accessor "getDateTime" gives direct access to the value
-
hasDateTimeElement
public boolean hasDateTimeElement()
-
hasDateTime
public boolean hasDateTime()
-
setDateTimeElement
public NutritionOrder setDateTimeElement(DateTimeType value)
- Parameters:
value-dateTime(The date and time that this nutrition order was requested.). This is the underlying object with id, value and extensions. The accessor "getDateTime" gives direct access to the value
-
getDateTime
public Date getDateTime()
- Returns:
- The date and time that this nutrition order was requested.
-
setDateTime
public NutritionOrder setDateTime(Date value)
- Parameters:
value- The date and time that this nutrition order was requested.
-
getStatusElement
public Enumeration<NutritionOrder.NutritionOrderStatus> getStatusElement()
- Returns:
status(The workflow status of the nutrition order/request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public NutritionOrder setStatusElement(Enumeration<NutritionOrder.NutritionOrderStatus> value)
- Parameters:
value-status(The workflow status of the nutrition order/request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public NutritionOrder.NutritionOrderStatus getStatus()
- Returns:
- The workflow status of the nutrition order/request.
-
setStatus
public NutritionOrder setStatus(NutritionOrder.NutritionOrderStatus value)
- Parameters:
value- The workflow status of the nutrition order/request.
-
getAllergyIntolerance
public List<Reference> getAllergyIntolerance()
- Returns:
allergyIntolerance(A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
hasAllergyIntolerance
public boolean hasAllergyIntolerance()
-
addAllergyIntolerance
public Reference addAllergyIntolerance()
- Returns:
allergyIntolerance(A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
addAllergyIntolerance
public NutritionOrder addAllergyIntolerance(Reference t)
-
getAllergyIntoleranceTarget
public List<AllergyIntolerance> getAllergyIntoleranceTarget()
- Returns:
allergyIntolerance(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
addAllergyIntoleranceTarget
public AllergyIntolerance addAllergyIntoleranceTarget()
- Returns:
allergyIntolerance(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
getFoodPreferenceModifier
public List<CodeableConcept> getFoodPreferenceModifier()
- Returns:
foodPreferenceModifier(This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.)
-
hasFoodPreferenceModifier
public boolean hasFoodPreferenceModifier()
-
addFoodPreferenceModifier
public CodeableConcept addFoodPreferenceModifier()
- Returns:
foodPreferenceModifier(This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.)
-
addFoodPreferenceModifier
public NutritionOrder addFoodPreferenceModifier(CodeableConcept t)
-
getExcludeFoodModifier
public List<CodeableConcept> getExcludeFoodModifier()
- Returns:
excludeFoodModifier(This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced allergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.)
-
hasExcludeFoodModifier
public boolean hasExcludeFoodModifier()
-
addExcludeFoodModifier
public CodeableConcept addExcludeFoodModifier()
- Returns:
excludeFoodModifier(This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced allergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.)
-
addExcludeFoodModifier
public NutritionOrder addExcludeFoodModifier(CodeableConcept t)
-
getOralDiet
public NutritionOrder.NutritionOrderOralDietComponent getOralDiet()
- Returns:
oralDiet(Diet given orally in contrast to enteral (tube) feeding.)
-
hasOralDiet
public boolean hasOralDiet()
-
setOralDiet
public NutritionOrder setOralDiet(NutritionOrder.NutritionOrderOralDietComponent value)
- Parameters:
value-oralDiet(Diet given orally in contrast to enteral (tube) feeding.)
-
getSupplement
public List<NutritionOrder.NutritionOrderSupplementComponent> getSupplement()
- Returns:
supplement(Oral nutritional products given in order to add further nutritional value to the patient's diet.)
-
hasSupplement
public boolean hasSupplement()
-
addSupplement
public NutritionOrder.NutritionOrderSupplementComponent addSupplement()
- Returns:
supplement(Oral nutritional products given in order to add further nutritional value to the patient's diet.)
-
addSupplement
public NutritionOrder addSupplement(NutritionOrder.NutritionOrderSupplementComponent t)
-
getEnteralFormula
public NutritionOrder.NutritionOrderEnteralFormulaComponent getEnteralFormula()
- Returns:
enteralFormula(Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.)
-
hasEnteralFormula
public boolean hasEnteralFormula()
-
setEnteralFormula
public NutritionOrder setEnteralFormula(NutritionOrder.NutritionOrderEnteralFormulaComponent value)
- Parameters:
value-enteralFormula(Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public NutritionOrder copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected NutritionOrder typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-