Class 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
  • Field Details

    • identifier

      Identifiers assigned to this order by the order sender or by the order receiver.
    • status

      The workflow status of the nutrition order/request.
    • 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

      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.)
    • encounter

      protected Reference encounter
      An encounter that provides additional information about the healthcare context in which this request is made.
    • 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

      The date and time that this nutrition order was requested.
    • orderer

      protected Reference orderer
      The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
    • 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.)
    • allergyIntolerance

      A link to a record of allergies or intolerances which should be included in the nutrition order.
    • 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

      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

      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

      Diet given orally in contrast to enteral (tube) feeding.
    • supplement

      Oral nutritional products given in order to add further nutritional value to the patient's diet.
    • 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
      Search parameter: 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_DATETIME

      public static final String SP_DATETIME
      Search parameter: 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_PROVIDER

      public static final String SP_PROVIDER
      Search parameter: 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

    • 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".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: 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

    • 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".
    • SP_SUPPLEMENT

      public static final String SP_SUPPLEMENT
      Search parameter: 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: 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_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: 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

    • 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".
    • SP_ORALDIET

      public static final String SP_ORALDIET
      Search parameter: 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_STATUS

      public static final String SP_STATUS
      Search parameter: 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_ADDITIVE

      public static final String SP_ADDITIVE
      Search parameter: 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

  • Constructor Details

  • Method Details