Class NutritionOrder

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class NutritionOrder
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR NutritionOrder Resource (clinical.careprovision)

    Definition: A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/NutritionOrder

    See Also:
    Serialized Form
    • Field Detail

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: The identity of the person who requires the diet, formula or nutritional supplement
        Type: reference
        Path: NutritionOrder.patient

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The identity of the person who requires the diet, formula or nutritional supplement
        Type: reference
        Path: NutritionOrder.patient

      • SP_PROVIDER

        public static final String SP_PROVIDER
        Search parameter constant for provider

        Description: The identify of the provider who placed the nutrition order
        Type: reference
        Path: NutritionOrder.orderer

        See Also:
        Constant Field Values
      • PROVIDER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PROVIDER
        Fluent Client search parameter constant for provider

        Description: The identify of the provider who placed the nutrition order
        Type: reference
        Path: NutritionOrder.orderer

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: Return nutrition orders with this external identifier
        Type: token
        Path: NutritionOrder.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Return nutrition orders with this external identifier
        Type: token
        Path: NutritionOrder.identifier

      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter constant for encounter

        Description: Return nutrition orders with this encounter identifier
        Type: reference
        Path: NutritionOrder.encounter

        See Also:
        Constant Field Values
      • ENCOUNTER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
        Fluent Client search parameter constant for encounter

        Description: Return nutrition orders with this encounter identifier
        Type: reference
        Path: NutritionOrder.encounter

      • SP_DATETIME

        public static final String SP_DATETIME
        Search parameter constant for datetime

        Description: Return nutrition orders requested on this date
        Type: date
        Path: NutritionOrder.dateTime

        See Also:
        Constant Field Values
      • DATETIME

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATETIME
        Fluent Client search parameter constant for datetime

        Description: Return nutrition orders requested on this date
        Type: date
        Path: NutritionOrder.dateTime

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter constant for status

        Description: Status of the nutrition order.
        Type: token
        Path: NutritionOrder.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: Status of the nutrition order.
        Type: token
        Path: NutritionOrder.status

      • SP_ORALDIET

        public static final String SP_ORALDIET
        Search parameter constant for oraldiet

        Description: Type of diet that can be consumed orally (i.e., take via the mouth).
        Type: token
        Path: NutritionOrder.oralDiet.type

        See Also:
        Constant Field Values
      • ORALDIET

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ORALDIET
        Fluent Client search parameter constant for oraldiet

        Description: Type of diet that can be consumed orally (i.e., take via the mouth).
        Type: token
        Path: NutritionOrder.oralDiet.type

      • SP_SUPPLEMENT

        public static final String SP_SUPPLEMENT
        Search parameter constant for supplement

        Description: Type of supplement product requested
        Type: token
        Path: NutritionOrder.supplement.type

        See Also:
        Constant Field Values
      • SUPPLEMENT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUPPLEMENT
        Fluent Client search parameter constant for supplement

        Description: Type of supplement product requested
        Type: token
        Path: NutritionOrder.supplement.type

      • SP_FORMULA

        public static final String SP_FORMULA
        Search parameter constant for formula

        Description: Type of enteral or infant formula
        Type: token
        Path: NutritionOrder.enteralFormula.baseFormulaType

        See Also:
        Constant Field Values
      • FORMULA

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam FORMULA
        Fluent Client search parameter constant for formula

        Description: Type of enteral or infant formula
        Type: token
        Path: NutritionOrder.enteralFormula.baseFormulaType

      • SP_ADDITIVE

        public static final String SP_ADDITIVE
        Search parameter constant for additive

        Description: Type of module component to add to the feeding
        Type: token
        Path: NutritionOrder.enteralFormula.additiveType

        See Also:
        Constant Field Values
      • ADDITIVE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDITIVE
        Fluent Client search parameter constant for additive

        Description: Type of module component to add to the feeding
        Type: token
        Path: NutritionOrder.enteralFormula.additiveType

      • INCLUDE_ENCOUNTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:encounter".
      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:patient".
      • INCLUDE_PROVIDER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PROVIDER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:provider".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.

        Definition: The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.

      • setPatient

        public NutritionOrder setPatient​(ResourceReferenceDt theValue)
        Sets the value(s) for patient (who.focus)

        Definition: The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.

      • getOrderer

        public ResourceReferenceDt getOrderer()
        Gets the value(s) for orderer (who.author). creating it if it does not exist. Will not return null.

        Definition: The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.

      • setOrderer

        public NutritionOrder setOrderer​(ResourceReferenceDt theValue)
        Sets the value(s) for orderer (who.author)

        Definition: The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.

      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Identifiers assigned to this order by the order sender or by the order receiver

      • setIdentifier

        public NutritionOrder setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

        Definition: Identifiers assigned to this order by the order sender or by the order receiver

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Identifiers assigned to this order by the order sender or by the order receiver

      • addIdentifier

        public NutritionOrder addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: Identifiers assigned to this order by the order sender or by the order receiver

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (id), creating it if it does not already exist.

        Definition: Identifiers assigned to this order by the order sender or by the order receiver

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (context). creating it if it does not exist. Will not return null.

        Definition: An encounter that provides additional information about the healthcare context in which this request is made

      • setEncounter

        public NutritionOrder setEncounter​(ResourceReferenceDt theValue)
        Sets the value(s) for encounter (context)

        Definition: An encounter that provides additional information about the healthcare context in which this request is made

      • getDateTimeElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getDateTimeElement()
        Gets the value(s) for dateTime (when.recorded). creating it if it does not exist. Will not return null.

        Definition: The date and time that this nutrition order was requested.

      • getDateTime

        public Date getDateTime()
        Gets the value(s) for dateTime (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The date and time that this nutrition order was requested.

      • setDateTime

        public NutritionOrder setDateTime​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for dateTime (when.recorded)

        Definition: The date and time that this nutrition order was requested.

      • setDateTime

        public NutritionOrder setDateTime​(Date theDate,
                                          ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for dateTime (when.recorded)

        Definition: The date and time that this nutrition order was requested.

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<NutritionOrderStatusEnumgetStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: The workflow status of the nutrition order/request.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: The workflow status of the nutrition order/request.

      • getAllergyIntolerance

        public List<ResourceReferenceDtgetAllergyIntolerance()
        Gets the value(s) for allergyIntolerance (). creating it if it does not exist. Will not return null.

        Definition: A link to a record of allergies or intolerances which should be included in the nutrition order.

      • addAllergyIntolerance

        public ResourceReferenceDt addAllergyIntolerance()
        Adds and returns a new value for allergyIntolerance ()

        Definition: A link to a record of allergies or intolerances which should be included in the nutrition order.

      • getFoodPreferenceModifier

        public List<CodeableConceptDtgetFoodPreferenceModifier()
        Gets the value(s) for foodPreferenceModifier (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setFoodPreferenceModifier

        public NutritionOrder setFoodPreferenceModifier​(List<CodeableConceptDt> theValue)
        Sets the value(s) for foodPreferenceModifier ()

        Definition: 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 CodeableConceptDt addFoodPreferenceModifier()
        Adds and returns a new value for foodPreferenceModifier ()

        Definition: 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​(CodeableConceptDt theValue)
        Adds a given new value for foodPreferenceModifier ()

        Definition: 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.

        Parameters:
        theValue - The foodPreferenceModifier to add (must not be null)
      • getFoodPreferenceModifierFirstRep

        public CodeableConceptDt getFoodPreferenceModifierFirstRep()
        Gets the first repetition for foodPreferenceModifier (), creating it if it does not already exist.

        Definition: 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.

      • getExcludeFoodModifier

        public List<CodeableConceptDtgetExcludeFoodModifier()
        Gets the value(s) for excludeFoodModifier (). creating it if it does not exist. Will not return null.

        Definition: 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.

      • setExcludeFoodModifier

        public NutritionOrder setExcludeFoodModifier​(List<CodeableConceptDt> theValue)
        Sets the value(s) for excludeFoodModifier ()

        Definition: 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 CodeableConceptDt addExcludeFoodModifier()
        Adds and returns a new value for excludeFoodModifier ()

        Definition: 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​(CodeableConceptDt theValue)
        Adds a given new value for excludeFoodModifier ()

        Definition: 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.

        Parameters:
        theValue - The excludeFoodModifier to add (must not be null)
      • getExcludeFoodModifierFirstRep

        public CodeableConceptDt getExcludeFoodModifierFirstRep()
        Gets the first repetition for excludeFoodModifier (), creating it if it does not already exist.

        Definition: 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.

      • getOralDiet

        public NutritionOrder.OralDiet getOralDiet()
        Gets the value(s) for oralDiet (). creating it if it does not exist. Will not return null.

        Definition: Diet given orally in contrast to enteral (tube) feeding.

      • getSupplement

        public List<NutritionOrder.SupplementgetSupplement()
        Gets the value(s) for supplement (). creating it if it does not exist. Will not return null.

        Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.

      • addSupplement

        public NutritionOrder.Supplement addSupplement()
        Adds and returns a new value for supplement ()

        Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.

      • addSupplement

        public NutritionOrder addSupplement​(NutritionOrder.Supplement theValue)
        Adds a given new value for supplement ()

        Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.

        Parameters:
        theValue - The supplement to add (must not be null)
      • getSupplementFirstRep

        public NutritionOrder.Supplement getSupplementFirstRep()
        Gets the first repetition for supplement (), creating it if it does not already exist.

        Definition: Oral nutritional products given in order to add further nutritional value to the patient's diet.

      • getEnteralFormula

        public NutritionOrder.EnteralFormula getEnteralFormula()
        Gets the value(s) for enteralFormula (). creating it if it does not exist. Will not return null.

        Definition: Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource