Package org.hl7.fhir.r4.model

Class NutritionOrder

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.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 enum	NutritionOrder.NutritiionOrderIntent
static class	NutritionOrder.NutritiionOrderIntentEnumFactory
static class	NutritionOrder.NutritionOrderEnteralFormulaAdministrationComponent
static class	NutritionOrder.NutritionOrderEnteralFormulaComponent
static class	NutritionOrder.NutritionOrderOralDietComponent
static class	NutritionOrder.NutritionOrderOralDietNutrientComponent
static class	NutritionOrder.NutritionOrderOralDietTextureComponent
static enum	NutritionOrder.NutritionOrderStatus
static class	NutritionOrder.NutritionOrderStatusEnumFactory
static class	NutritionOrder.NutritionOrderSupplementComponent

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ADDITIVE	Fluent Client search parameter constant for additive
protected List<Reference>	allergyIntolerance	A link to a record of allergies or intolerances which should be included in the nutrition order.
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.)
protected DateTimeType	dateTime	The date and time that this nutrition order was requested.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATETIME	Fluent Client search parameter constant for datetime
protected Reference	encounter	An encounter that provides additional information about the healthcare context in which this request is made.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
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.)
protected NutritionOrder.NutritionOrderEnteralFormulaComponent	enteralFormula	Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
protected List<CodeableConcept>	excludeFoodModifier	This modifier is used to convey Order-specific modifier about the type of oral food or oral fluids that should not be given.
protected List<CodeableConcept>	foodPreferenceModifier	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.TokenClientParam	FORMULA	Fluent Client search parameter constant for formula
protected List<Identifier>	identifier	Identifiers assigned to this order by the order sender or by the order receiver.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INSTANTIATES_CANONICAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PROVIDER	Constant for fluent queries to be used to add include statements.
protected List<UriType>	instantiates	The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INSTANTIATES_CANONICAL	Fluent Client search parameter constant for instantiates-canonical
static final ca.uhn.fhir.rest.gclient.UriClientParam	INSTANTIATES_URI	Fluent Client search parameter constant for instantiates-uri
protected List<CanonicalType>	instantiatesCanonical	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.
protected List<UriType>	instantiatesUri	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.
protected Enumeration<NutritionOrder.NutritiionOrderIntent>	intent	Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.
protected List<Annotation>	note	Comments made about the {{title}} by the requester, performer, subject or other participants.
protected NutritionOrder.NutritionOrderOralDietComponent	oralDiet	Diet given orally in contrast to enteral (tube) feeding.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ORALDIET	Fluent Client search parameter constant for oraldiet
protected Reference	orderer	The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
protected Resource	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.)
protected Reference	patient	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.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
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.)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PROVIDER	Fluent Client search parameter constant for provider
static final String	SP_ADDITIVE	Search parameter: additive
static final String	SP_DATETIME	Search parameter: datetime
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_FORMULA	Search parameter: formula
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INSTANTIATES_CANONICAL	Search parameter: instantiates-canonical
static final String	SP_INSTANTIATES_URI	Search parameter: instantiates-uri
static final String	SP_ORALDIET	Search parameter: oraldiet
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PROVIDER	Search parameter: provider
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUPPLEMENT	Search parameter: supplement
protected Enumeration<NutritionOrder.NutritionOrderStatus>	status	The workflow status of the nutrition order/request.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<NutritionOrder.NutritionOrderSupplementComponent>	supplement	Oral nutritional products given in order to add further nutritional value to the patient's diet.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SUPPLEMENT	Fluent Client search parameter constant for supplement

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields 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_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
NutritionOrder()	Constructor
NutritionOrder(Enumeration<NutritionOrder.NutritionOrderStatus> status, Enumeration<NutritionOrder.NutritiionOrderIntent> intent, Reference patient, DateTimeType dateTime)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAllergyIntolerance()
NutritionOrder	addAllergyIntolerance(Reference t)
AllergyIntolerance	addAllergyIntoleranceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Base	addChild(String name)
CodeableConcept	addExcludeFoodModifier()
NutritionOrder	addExcludeFoodModifier(CodeableConcept t)
CodeableConcept	addFoodPreferenceModifier()
NutritionOrder	addFoodPreferenceModifier(CodeableConcept t)
Identifier	addIdentifier()
NutritionOrder	addIdentifier(Identifier t)
NutritionOrder	addInstantiates(String value)
NutritionOrder	addInstantiatesCanonical(String value)
CanonicalType	addInstantiatesCanonicalElement()
UriType	addInstantiatesElement()
NutritionOrder	addInstantiatesUri(String value)
UriType	addInstantiatesUriElement()
Annotation	addNote()
NutritionOrder	addNote(Annotation t)
NutritionOrder.NutritionOrderSupplementComponent	addSupplement()
NutritionOrder	addSupplement(NutritionOrder.NutritionOrderSupplementComponent t)
NutritionOrder	copy()
void	copyValues(NutritionOrder dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAllergyIntolerance()
Reference	getAllergyIntoleranceFirstRep()
List<AllergyIntolerance>	getAllergyIntoleranceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Date	getDateTime()
DateTimeType	getDateTimeElement()
Reference	getEncounter()
Encounter	getEncounterTarget()
NutritionOrder.NutritionOrderEnteralFormulaComponent	getEnteralFormula()
List<CodeableConcept>	getExcludeFoodModifier()
CodeableConcept	getExcludeFoodModifierFirstRep()
List<CodeableConcept>	getFoodPreferenceModifier()
CodeableConcept	getFoodPreferenceModifierFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<UriType>	getInstantiates()
List<CanonicalType>	getInstantiatesCanonical()
List<UriType>	getInstantiatesUri()
NutritionOrder.NutritiionOrderIntent	getIntent()
Enumeration<NutritionOrder.NutritiionOrderIntent>	getIntentElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
NutritionOrder.NutritionOrderOralDietComponent	getOralDiet()
Reference	getOrderer()
Resource	getOrdererTarget()
Reference	getPatient()
Patient	getPatientTarget()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
NutritionOrder.NutritionOrderStatus	getStatus()
Enumeration<NutritionOrder.NutritionOrderStatus>	getStatusElement()
List<NutritionOrder.NutritionOrderSupplementComponent>	getSupplement()
NutritionOrder.NutritionOrderSupplementComponent	getSupplementFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAllergyIntolerance()
boolean	hasDateTime()
boolean	hasDateTimeElement()
boolean	hasEncounter()
boolean	hasEnteralFormula()
boolean	hasExcludeFoodModifier()
boolean	hasFoodPreferenceModifier()
boolean	hasIdentifier()
boolean	hasInstantiates()
boolean	hasInstantiates(String value)
boolean	hasInstantiatesCanonical()
boolean	hasInstantiatesCanonical(String value)
boolean	hasInstantiatesUri()
boolean	hasInstantiatesUri(String value)
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasNote()
boolean	hasOralDiet()
boolean	hasOrderer()
boolean	hasPatient()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSupplement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
NutritionOrder	setAllergyIntolerance(List<Reference> theAllergyIntolerance)
NutritionOrder	setDateTime(Date value)
NutritionOrder	setDateTimeElement(DateTimeType value)
NutritionOrder	setEncounter(Reference value)
NutritionOrder	setEncounterTarget(Encounter value)
NutritionOrder	setEnteralFormula(NutritionOrder.NutritionOrderEnteralFormulaComponent value)
NutritionOrder	setExcludeFoodModifier(List<CodeableConcept> theExcludeFoodModifier)
NutritionOrder	setFoodPreferenceModifier(List<CodeableConcept> theFoodPreferenceModifier)
NutritionOrder	setIdentifier(List<Identifier> theIdentifier)
NutritionOrder	setInstantiates(List<UriType> theInstantiates)
NutritionOrder	setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
NutritionOrder	setInstantiatesUri(List<UriType> theInstantiatesUri)
NutritionOrder	setIntent(NutritionOrder.NutritiionOrderIntent value)
NutritionOrder	setIntentElement(Enumeration<NutritionOrder.NutritiionOrderIntent> value)
NutritionOrder	setNote(List<Annotation> theNote)
NutritionOrder	setOralDiet(NutritionOrder.NutritionOrderOralDietComponent value)
NutritionOrder	setOrderer(Reference value)
NutritionOrder	setOrdererTarget(Resource value)
NutritionOrder	setPatient(Reference value)
NutritionOrder	setPatientTarget(Patient value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
NutritionOrder	setStatus(NutritionOrder.NutritionOrderStatus value)
NutritionOrder	setStatusElement(Enumeration<NutritionOrder.NutritionOrderStatus> value)
NutritionOrder	setSupplement(List<NutritionOrder.NutritionOrderSupplementComponent> theSupplement)
protected NutritionOrder	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, 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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

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

instantiatesCanonical

protected List<CanonicalType> instantiatesCanonical

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.

instantiatesUri

protected List<UriType> instantiatesUri

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.

instantiates

protected List<UriType> instantiates

The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.

status

protected Enumeration<NutritionOrder.NutritionOrderStatus> status

The workflow status of the nutrition order/request.

intent

protected Enumeration<NutritionOrder.NutritiionOrderIntent> intent

Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

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

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.

orderer

protected Reference orderer

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

ordererTarget

protected Resource 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

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

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.

note

protected List<Annotation> note

Comments made about the {{title}} by the requester, performer, subject or other participants.

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 identity 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 identity 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_INSTANTIATES_CANONICAL

public static final String SP_INSTANTIATES_CANONICAL

Search parameter: instantiates-canonical

Description: Instantiates FHIR protocol or definition
Type: reference
Path: NutritionOrder.instantiatesCanonical

See Also:

• Constant Field Values

INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL

Fluent Client search parameter constant for instantiates-canonical

Description: Instantiates FHIR protocol or definition
Type: reference
Path: NutritionOrder.instantiatesCanonical

INCLUDE_INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "NutritionOrder:instantiates-canonical".

SP_INSTANTIATES_URI

public static final String SP_INSTANTIATES_URI

Search parameter: instantiates-uri

Description: Instantiates external protocol or definition
Type: uri
Path: NutritionOrder.instantiatesUri

See Also:

• Constant Field Values

INSTANTIATES_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI

Fluent Client search parameter constant for instantiates-uri

Description: Instantiates external protocol or definition
Type: uri
Path: NutritionOrder.instantiatesUri

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

NutritionOrder

public NutritionOrder()

Constructor

NutritionOrder

public NutritionOrder(Enumeration<NutritionOrder.NutritionOrderStatus> status,
 Enumeration<NutritionOrder.NutritiionOrderIntent> intent,
 Reference patient,
 DateTimeType dateTime)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this order by the order sender or by the order receiver.)

setIdentifier

public NutritionOrder setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public NutritionOrder addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getInstantiatesCanonical

public List<CanonicalType> getInstantiatesCanonical()

Returns:

instantiatesCanonical (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.)

setInstantiatesCanonical

public NutritionOrder setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical()

addInstantiatesCanonicalElement

public CanonicalType addInstantiatesCanonicalElement()

Returns:

instantiatesCanonical (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.)

addInstantiatesCanonical

public NutritionOrder addInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (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.)

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (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.)

getInstantiatesUri

public List<UriType> getInstantiatesUri()

Returns:

instantiatesUri (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.)

setInstantiatesUri

public NutritionOrder setInstantiatesUri(List<UriType> theInstantiatesUri)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesUri

public boolean hasInstantiatesUri()

addInstantiatesUriElement

public UriType addInstantiatesUriElement()

Returns:

instantiatesUri (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.)

addInstantiatesUri

public NutritionOrder addInstantiatesUri(String value)

Parameters:

value - instantiatesUri (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.)

hasInstantiatesUri

public boolean hasInstantiatesUri(String value)

Parameters:

value - instantiatesUri (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.)

getInstantiates

public List<UriType> getInstantiates()

Returns:

instantiates (The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.)

setInstantiates

public NutritionOrder setInstantiates(List<UriType> theInstantiates)

Returns:

Returns a reference to this for easy method chaining

hasInstantiates

public boolean hasInstantiates()

addInstantiatesElement

public UriType addInstantiatesElement()

Returns:

instantiates (The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.)

addInstantiates

public NutritionOrder addInstantiates(String value)

Parameters:

value - instantiates (The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.)

hasInstantiates

public boolean hasInstantiates(String value)

Parameters:

value - instantiates (The URL pointing to a protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder.)

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.

getIntentElement

public Enumeration<NutritionOrder.NutritiionOrderIntent> getIntentElement()

Returns:

intent (Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

hasIntentElement

public boolean hasIntentElement()

hasIntent

public boolean hasIntent()

setIntentElement

public NutritionOrder setIntentElement(Enumeration<NutritionOrder.NutritiionOrderIntent> value)

Parameters:

value - intent (Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

getIntent

public NutritionOrder.NutritiionOrderIntent getIntent()

Returns:

Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

setIntent

public NutritionOrder setIntent(NutritionOrder.NutritiionOrderIntent value)

Parameters:

value - Indicates the level of authority/intentionality associated with the NutrionOrder and where the request fits into the workflow chain.

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:

patient The 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 - patient The 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

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:

encounter The 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 - encounter The 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.

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 Resource getOrdererTarget()

Returns:

orderer The 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(Resource value)

Parameters:

value - orderer The 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

public List<Reference> getAllergyIntolerance()

Returns:

allergyIntolerance (A link to a record of allergies or intolerances which should be included in the nutrition order.)

setAllergyIntolerance

public NutritionOrder setAllergyIntolerance(List<Reference> theAllergyIntolerance)

Returns:

Returns a reference to this for easy method chaining

hasAllergyIntolerance

public boolean hasAllergyIntolerance()

addAllergyIntolerance

public Reference addAllergyIntolerance()

addAllergyIntolerance

public NutritionOrder addAllergyIntolerance(Reference t)

getAllergyIntoleranceFirstRep

public Reference getAllergyIntoleranceFirstRep()

Returns:

The first repetition of repeating field allergyIntolerance, creating it if it does not already exist

getAllergyIntoleranceTarget

@Deprecated
public List<AllergyIntolerance> getAllergyIntoleranceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addAllergyIntoleranceTarget

@Deprecated
public AllergyIntolerance addAllergyIntoleranceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

setFoodPreferenceModifier

public NutritionOrder setFoodPreferenceModifier(List<CodeableConcept> theFoodPreferenceModifier)

Returns:

Returns a reference to this for easy method chaining

hasFoodPreferenceModifier

public boolean hasFoodPreferenceModifier()

addFoodPreferenceModifier

public CodeableConcept addFoodPreferenceModifier()

addFoodPreferenceModifier

public NutritionOrder addFoodPreferenceModifier(CodeableConcept t)

getFoodPreferenceModifierFirstRep

public CodeableConcept getFoodPreferenceModifierFirstRep()

Returns:

The first repetition of repeating field foodPreferenceModifier, creating it if it does not already exist

getExcludeFoodModifier

public List<CodeableConcept> getExcludeFoodModifier()

Returns:

excludeFoodModifier (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.)

setExcludeFoodModifier

public NutritionOrder setExcludeFoodModifier(List<CodeableConcept> theExcludeFoodModifier)

Returns:

Returns a reference to this for easy method chaining

hasExcludeFoodModifier

public boolean hasExcludeFoodModifier()

addExcludeFoodModifier

public CodeableConcept addExcludeFoodModifier()

addExcludeFoodModifier

public NutritionOrder addExcludeFoodModifier(CodeableConcept t)

getExcludeFoodModifierFirstRep

public CodeableConcept getExcludeFoodModifierFirstRep()

Returns:

The first repetition of repeating field excludeFoodModifier, creating it if it does not already exist

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

setSupplement

public NutritionOrder setSupplement(List<NutritionOrder.NutritionOrderSupplementComponent> theSupplement)

Returns:

Returns a reference to this for easy method chaining

hasSupplement

public boolean hasSupplement()

addSupplement

public NutritionOrder.NutritionOrderSupplementComponent addSupplement()

addSupplement

public NutritionOrder addSupplement(NutritionOrder.NutritionOrderSupplementComponent t)

getSupplementFirstRep

public NutritionOrder.NutritionOrderSupplementComponent getSupplementFirstRep()

Returns:

The first repetition of repeating field supplement, creating it if it does not already exist

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

getNote

public List<Annotation> getNote()

Returns:

note (Comments made about the {{title}} by the requester, performer, subject or other participants.)

setNote

public NutritionOrder setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public NutritionOrder addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public NutritionOrder copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(NutritionOrder dst)

typedCopy

protected NutritionOrder typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource