Package com.ibm.fhir.model.resource
Class NutritionOrder
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.NutritionOrder
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class NutritionOrder extends DomainResource
A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NutritionOrder.Builder
static class
NutritionOrder.EnteralFormula
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.static class
NutritionOrder.OralDiet
Diet given orally in contrast to enteral (tube) feeding.static class
NutritionOrder.Supplement
Oral nutritional products given in order to add further nutritional value to the patient's diet.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static NutritionOrder.Builder
builder()
boolean
equals(Object obj)
List<Reference>
getAllergyIntolerance()
A link to a record of allergies or intolerances which should be included in the nutrition order.DateTime
getDateTime()
The date and time that this nutrition order was requested.Reference
getEncounter()
An encounter that provides additional information about the healthcare context in which this request is made.NutritionOrder.EnteralFormula
getEnteralFormula()
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.List<CodeableConcept>
getExcludeFoodModifier()
This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given.List<CodeableConcept>
getFoodPreferenceModifier()
This modifier is used to convey order-specific modifiers about the type of food that should be given.List<Identifier>
getIdentifier()
Identifiers assigned to this order by the order sender or by the order receiver.List<Uri>
getInstantiates()
The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.List<Canonical>
getInstantiatesCanonical()
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.List<Uri>
getInstantiatesUri()
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.NutritionOrderIntent
getIntent()
Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.List<Annotation>
getNote()
Comments made about the {{title}} by the requester, performer, subject or other participants.NutritionOrder.OralDiet
getOralDiet()
Diet given orally in contrast to enteral (tube) feeding.Reference
getOrderer()
The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.Reference
getPatient()
The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.NutritionOrderStatus
getStatus()
The workflow status of the nutrition order/request.List<NutritionOrder.Supplement>
getSupplement()
Oral nutritional products given in order to add further nutritional value to the patient's diet.boolean
hasChildren()
int
hashCode()
NutritionOrder.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
Identifiers assigned to this order by the order sender or by the order receiver.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getInstantiatesCanonical
public List<Canonical> getInstantiatesCanonical()
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getInstantiatesUri
public List<Uri> getInstantiatesUri()
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getInstantiates
public List<Uri> getInstantiates()
The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getStatus
public NutritionOrderStatus getStatus()
The workflow status of the nutrition order/request.- Returns:
- An immutable object of type
NutritionOrderStatus
that is non-null.
-
getIntent
public NutritionOrderIntent getIntent()
Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.- Returns:
- An immutable object of type
NutritionOrderIntent
that is non-null.
-
getPatient
public Reference getPatient()
The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getEncounter
public Reference getEncounter()
An encounter that provides additional information about the healthcare context in which this request is made.- Returns:
- An immutable object of type
Reference
that may be null.
-
getDateTime
public DateTime getDateTime()
The date and time that this nutrition order was requested.- Returns:
- An immutable object of type
DateTime
that is non-null.
-
getOrderer
public Reference getOrderer()
The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.- Returns:
- An immutable object of type
Reference
that may be null.
-
getAllergyIntolerance
public List<Reference> getAllergyIntolerance()
A link to a record of allergies or intolerances which should be included in the nutrition order.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getFoodPreferenceModifier
public List<CodeableConcept> getFoodPreferenceModifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getExcludeFoodModifier
public List<CodeableConcept> getExcludeFoodModifier()
This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids 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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getOralDiet
public NutritionOrder.OralDiet getOralDiet()
Diet given orally in contrast to enteral (tube) feeding.- Returns:
- An immutable object of type
NutritionOrder.OralDiet
that may be null.
-
getSupplement
public List<NutritionOrder.Supplement> getSupplement()
Oral nutritional products given in order to add further nutritional value to the patient's diet.- Returns:
- An unmodifiable list containing immutable objects of type
NutritionOrder.Supplement
that may be empty.
-
getEnteralFormula
public NutritionOrder.EnteralFormula getEnteralFormula()
Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.- Returns:
- An immutable object of type
NutritionOrder.EnteralFormula
that may be null.
-
getNote
public List<Annotation> getNote()
Comments made about the {{title}} by the requester, performer, subject or other participants.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
toBuilder
public NutritionOrder.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static NutritionOrder.Builder builder()
-
-