
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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic enumstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for additiveA link to a record of allergies or intolerances which should be included in the nutrition order.protected List<AllergyIntolerance> 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.)protected DateTimeTypeThe date and time that this nutrition order was requested.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for datetimeprotected ReferenceAn encounter that provides additional information about the healthcare context in which this request is made.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for encounterprotected EncounterThe 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.)Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.protected List<CodeableConcept> This modifier is used to convey order-specific modifiers about the type of food that should NOT be given.protected List<CodeableConcept> This modifier is used to convey order-specific modifiers about the type of food that should be given.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for formulaprotected List<Identifier> Identifiers assigned to this order by the order sender or by the order receiver.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.Diet given orally in contrast to enteral (tube) feeding.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for oraldietprotected ReferenceThe practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.protected PractitionerThe 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 ReferenceThe person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PatientThe 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 final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for providerstatic final StringSearch parameter: additivestatic final StringSearch parameter: datetimestatic final StringSearch parameter: encounterstatic final StringSearch parameter: formulastatic final StringSearch parameter: identifierstatic final StringSearch parameter: oraldietstatic final StringSearch parameter: patientstatic final StringSearch parameter: providerstatic final StringSearch parameter: statusstatic final StringSearch parameter: supplementprotected Enumeration<NutritionOrder.NutritionOrderStatus> The workflow status of the nutrition order/request.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusOral nutritional products given in order to add further nutritional value to the patient's diet.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for supplementFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorNutritionOrder(Reference patient, DateTimeType dateTime) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) setAllergyIntolerance(List<Reference> theAllergyIntolerance) setDateTime(Date value) setDateTimeElement(DateTimeType value) setEncounter(Reference value) setEncounterTarget(Encounter value) setExcludeFoodModifier(List<CodeableConcept> theExcludeFoodModifier) setFoodPreferenceModifier(List<CodeableConcept> theFoodPreferenceModifier) setIdentifier(List<Identifier> theIdentifier) setOrderer(Reference value) setOrdererTarget(Practitioner value) setPatient(Reference value) setPatientTarget(Patient value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setSupplement(List<NutritionOrder.NutritionOrderSupplementComponent> theSupplement) protected NutritionOrderMethods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextMethods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
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
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
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
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
Search parameter: identifierDescription: Return nutrition orders with this external identifier
Type: token
Path: NutritionOrder.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Return nutrition orders with this external identifier
Type: token
Path: NutritionOrder.identifier
-
SP_DATETIME
Search parameter: datetimeDescription: Return nutrition orders requested on this date
Type: date
Path: NutritionOrder.dateTime
- See Also:
-
DATETIME
Fluent Client search parameter constant for datetimeDescription: Return nutrition orders requested on this date
Type: date
Path: NutritionOrder.dateTime
-
SP_PROVIDER
Search parameter: providerDescription: The identify of the provider who placed the nutrition order
Type: reference
Path: NutritionOrder.orderer
- See Also:
-
PROVIDER
Fluent Client search parameter constant for providerDescription: The identify of the provider who placed the nutrition order
Type: reference
Path: NutritionOrder.orderer
-
INCLUDE_PROVIDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:provider". -
SP_PATIENT
Search parameter: patientDescription: The identity of the person who requires the diet, formula or nutritional supplement
Type: reference
Path: NutritionOrder.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The identity of the person who requires the diet, formula or nutritional supplement
Type: reference
Path: NutritionOrder.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:patient". -
SP_SUPPLEMENT
Search parameter: supplementDescription: Type of supplement product requested
Type: token
Path: NutritionOrder.supplement.type
- See Also:
-
SUPPLEMENT
Fluent Client search parameter constant for supplementDescription: Type of supplement product requested
Type: token
Path: NutritionOrder.supplement.type
-
SP_FORMULA
Search parameter: formulaDescription: Type of enteral or infant formula
Type: token
Path: NutritionOrder.enteralFormula.baseFormulaType
- See Also:
-
FORMULA
Fluent Client search parameter constant for formulaDescription: Type of enteral or infant formula
Type: token
Path: NutritionOrder.enteralFormula.baseFormulaType
-
SP_ENCOUNTER
Search parameter: encounterDescription: Return nutrition orders with this encounter identifier
Type: reference
Path: NutritionOrder.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Return nutrition orders with this encounter identifier
Type: reference
Path: NutritionOrder.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:encounter". -
SP_ORALDIET
Search parameter: oraldietDescription: Type of diet that can be consumed orally (i.e., take via the mouth).
Type: token
Path: NutritionOrder.oralDiet.type
- See Also:
-
ORALDIET
Fluent Client search parameter constant for oraldietDescription: Type of diet that can be consumed orally (i.e., take via the mouth).
Type: token
Path: NutritionOrder.oralDiet.type
-
SP_STATUS
Search parameter: statusDescription: Status of the nutrition order.
Type: token
Path: NutritionOrder.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Status of the nutrition order.
Type: token
Path: NutritionOrder.status
-
SP_ADDITIVE
Search parameter: additiveDescription: Type of module component to add to the feeding
Type: token
Path: NutritionOrder.enteralFormula.additiveType
- See Also:
-
ADDITIVE
Fluent Client search parameter constant for additiveDescription: Type of module component to add to the feeding
Type: token
Path: NutritionOrder.enteralFormula.additiveType
-
-
Constructor Details
-
NutritionOrder
public NutritionOrder()Constructor -
NutritionOrder
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(Identifiers assigned to this order by the order sender or by the order receiver.)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The workflow status of the nutrition order/request.
-
setStatus
- Parameters:
value- The workflow status of the nutrition order/request.
-
getPatient
- Returns:
patient(The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
hasPatient
-
setPatient
- Parameters:
value-patient(The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.)
-
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
- 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.)
-
getEncounter
- Returns:
encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
hasEncounter
-
setEncounter
- Parameters:
value-encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
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
- 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
- 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
-
hasDateTime
-
setDateTimeElement
- 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
- Returns:
- The date and time that this nutrition order was requested.
-
setDateTime
- Parameters:
value- The date and time that this nutrition order was requested.
-
getOrderer
- Returns:
orderer(The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
hasOrderer
-
setOrderer
- Parameters:
value-orderer(The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.)
-
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
- 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.)
-
getAllergyIntolerance
- Returns:
allergyIntolerance(A link to a record of allergies or intolerances which should be included in the nutrition order.)
-
setAllergyIntolerance
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAllergyIntolerance
-
addAllergyIntolerance
-
addAllergyIntolerance
-
getAllergyIntoleranceFirstRep
- Returns:
- The first repetition of repeating field
allergyIntolerance, creating it if it does not already exist
-
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.)
-
setFoodPreferenceModifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasFoodPreferenceModifier
-
addFoodPreferenceModifier
-
addFoodPreferenceModifier
-
getFoodPreferenceModifierFirstRep
- Returns:
- The first repetition of repeating field
foodPreferenceModifier, creating it if it does not already exist
-
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.)
-
setExcludeFoodModifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasExcludeFoodModifier
-
addExcludeFoodModifier
-
addExcludeFoodModifier
-
getExcludeFoodModifierFirstRep
- Returns:
- The first repetition of repeating field
excludeFoodModifier, creating it if it does not already exist
-
getOralDiet
- Returns:
oralDiet(Diet given orally in contrast to enteral (tube) feeding.)
-
hasOralDiet
-
setOralDiet
- Parameters:
value-oralDiet(Diet given orally in contrast to enteral (tube) feeding.)
-
getSupplement
- Returns:
supplement(Oral nutritional products given in order to add further nutritional value to the patient's diet.)
-
setSupplement
public NutritionOrder setSupplement(List<NutritionOrder.NutritionOrderSupplementComponent> theSupplement) - Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupplement
-
addSupplement
-
addSupplement
-
getSupplementFirstRep
- Returns:
- The first repetition of repeating field
supplement, creating it if it does not already exist
-
getEnteralFormula
- Returns:
enteralFormula(Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.)
-
hasEnteralFormula
-
setEnteralFormula
- Parameters:
value-enteralFormula(Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.)
-
listChildren
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
- Specified by:
copyin classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-