Release 4B
AdministrationThis page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B
| Orders and Observations Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for nutritionproduct
{
"resourceType" : "StructureDefinition",
"id" : "NutritionProduct",
"meta" : {
"lastUpdated" : "2022-05-28T12:47:40.239+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Base.Entities"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 0
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode" : "business"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "oo"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/NutritionProduct",
"version" : "4.3.0",
"name" : "NutritionProduct",
"status" : "draft",
"experimental" : false,
"date" : "2022-05-28T12:47:40+10:00",
"publisher" : "Health Level Seven International (Orders and Observations)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/orders/index.cfm"
}]
}],
"description" : "A food or fluid product that is consumed by patients.",
"fhirVersion" : "4.3.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
}],
"kind" : "resource",
"abstract" : false,
"type" : "NutritionProduct",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "NutritionProduct",
"path" : "NutritionProduct",
"short" : "A product used for nutritional purposes",
"definition" : "A food or fluid product that is consumed by patients.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Act[moodCode=EVN]"
},
{
"identity" : "w5",
"map" : "clinical.general"
}]
},
{
"id" : "NutritionProduct.id",
"path" : "NutritionProduct.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.meta",
"path" : "NutritionProduct.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Meta"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.implicitRules",
"path" : "NutritionProduct.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "NutritionProduct.language",
"path" : "NutritionProduct.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}],
"strength" : "preferred",
"description" : "IETF language tag",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "NutritionProduct.text",
"path" : "NutritionProduct.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act.text?"
}]
},
{
"id" : "NutritionProduct.contained",
"path" : "NutritionProduct.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"constraint" : [{
"key" : "dom-r4b",
"severity" : "warning",
"human" : "Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems",
"expression" : "($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)",
"xpath" : "not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)",
"source" : "http://hl7.org/fhir/StructureDefinition/NutritionProduct"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.extension",
"path" : "NutritionProduct.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.modifierExtension",
"path" : "NutritionProduct.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.status",
"path" : "NutritionProduct.status",
"short" : "active | inactive | entered-in-error",
"definition" : "The current state of the product.",
"comment" : "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionProduct.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a product.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutritionproduct-status|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "NutritionProduct.category",
"path" : "NutritionProduct.category",
"short" : "A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc)",
"definition" : "Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.",
"alias" : ["class"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.category",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductCategory"
}],
"strength" : "example",
"description" : "Codes identifying classes of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrition-product-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionProduct.code",
"path" : "NutritionProduct.code",
"short" : "A code designating a specific type of nutritional product",
"definition" : "The code assigned to the product, for example a manufacturer number or other terminology.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductCode"
}],
"strength" : "example",
"description" : "Codes identifying specific types of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/edible-substance-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionProduct.manufacturer",
"path" : "NutritionProduct.manufacturer",
"short" : "Manufacturer, representative or officially responsible for the product",
"definition" : "The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.manufacturer",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Varies by domain"
}]
},
{
"id" : "NutritionProduct.nutrient",
"path" : "NutritionProduct.nutrient",
"short" : "The product's nutritional information expressed by the nutrients",
"definition" : "The product's nutritional information expressed by the nutrients.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.nutrient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression" : "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath" : "@value|f:*|h:div|self::f:Parameters",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "NutritionProduct.nutrient.id",
"path" : "NutritionProduct.nutrient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.nutrient.extension",
"path" : "NutritionProduct.nutrient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.nutrient.modifierExtension",
"path" : "NutritionProduct.nutrient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.nutrient.item",
"path" : "NutritionProduct.nutrient.item",
"short" : "The (relevant) nutrients in the product",
"definition" : "The (relevant) nutrients in the product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.nutrient.item",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductNutrient"
}],
"strength" : "example",
"description" : "Codes that identify nutrients that could be parts of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrition-product-nutrient"
}
},
{
"id" : "NutritionProduct.nutrient.amount",
"path" : "NutritionProduct.nutrient.amount",
"short" : "The amount of nutrient expressed in one or more units: X per pack / per serving / per dose",
"definition" : "The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.nutrient.amount",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.ingredient",
"path" : "NutritionProduct.ingredient",
"short" : "Ingredients contained in this product",
"definition" : "Ingredients contained in this product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.ingredient",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression" : "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath" : "@value|f:*|h:div|self::f:Parameters",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.ingredient.id",
"path" : "NutritionProduct.ingredient.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.ingredient.extension",
"path" : "NutritionProduct.ingredient.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.ingredient.modifierExtension",
"path" : "NutritionProduct.ingredient.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.ingredient.item",
"path" : "NutritionProduct.ingredient.item",
"short" : "The ingredient contained in the product",
"definition" : "The ingredient contained in the product.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionProduct.ingredient.item",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/NutritionProduct"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.ingredient.amount",
"path" : "NutritionProduct.ingredient.amount",
"short" : "The amount of ingredient that is in the product",
"definition" : "The amount of ingredient that is in the product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.ingredient.amount",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Ratio"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.knownAllergen",
"path" : "NutritionProduct.knownAllergen",
"short" : "Known or suspected allergens that are a part of this product",
"definition" : "Allergens that are known or suspected to be a part of this nutrition product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.knownAllergen",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergenClass"
}],
"strength" : "example",
"description" : "Codes that identify substances that can be an allergen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergen-class"
}
},
{
"id" : "NutritionProduct.productCharacteristic",
"path" : "NutritionProduct.productCharacteristic",
"short" : "Specifies descriptive properties of the nutrition product",
"definition" : "Specifies descriptive properties of the nutrition product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.productCharacteristic",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression" : "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath" : "@value|f:*|h:div|self::f:Parameters",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.productCharacteristic.id",
"path" : "NutritionProduct.productCharacteristic.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.productCharacteristic.extension",
"path" : "NutritionProduct.productCharacteristic.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.productCharacteristic.modifierExtension",
"path" : "NutritionProduct.productCharacteristic.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.productCharacteristic.type",
"path" : "NutritionProduct.productCharacteristic.type",
"short" : "Code specifying the type of characteristic",
"definition" : "A code specifying which characteristic of the product is being described (for example, colour, shape).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionProduct.productCharacteristic.type",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PropertyCharacteristic"
}],
"strength" : "example",
"description" : "Codes that identify properties that can be measured.",
"valueSet" : "http://hl7.org/fhir/ValueSet/measurement-property"
}
},
{
"id" : "NutritionProduct.productCharacteristic.value[x]",
"path" : "NutritionProduct.productCharacteristic.value[x]",
"short" : "The value of the characteristic",
"definition" : "The actual characteristic value corresponding to the type.",
"comment" : "The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "NutritionProduct.productCharacteristic.value[x]",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "base64Binary"
},
{
"code" : "Attachment"
},
{
"code" : "boolean"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance",
"path" : "NutritionProduct.instance",
"short" : "One or several physical instances or occurrences of the nutrition product",
"definition" : "Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.instance",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children unless an empty Parameters resource",
"expression" : "hasValue() or (children().count() > id.count()) or $this is Parameters",
"xpath" : "@value|f:*|h:div|self::f:Parameters",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.id",
"path" : "NutritionProduct.instance.id",
"representation" : ["xmlAttr"],
"short" : "Unique id for inter-element referencing",
"definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.instance.extension",
"path" : "NutritionProduct.instance.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "NutritionProduct.instance.modifierExtension",
"path" : "NutritionProduct.instance.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias" : ["extensions",
"user content",
"modifiers"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "NutritionProduct.instance.quantity",
"path" : "NutritionProduct.instance.quantity",
"short" : "The amount of items or instances",
"definition" : "The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.instance.quantity",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.identifier",
"path" : "NutritionProduct.instance.identifier",
"short" : "The identifier for the physical instance, typically a serial number",
"definition" : "The identifier for the physical instance, typically a serial number.",
"alias" : ["serialNumber"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.instance.identifier",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Identifier"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.lotNumber",
"path" : "NutritionProduct.instance.lotNumber",
"short" : "The identification of the batch or lot of the product",
"definition" : "The identification of the batch or lot of the product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.instance.lotNumber",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.expiry",
"path" : "NutritionProduct.instance.expiry",
"short" : "The expiry date or date and time for the product",
"definition" : "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.instance.expiry",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.useBy",
"path" : "NutritionProduct.instance.useBy",
"short" : "The date until which the product is expected to be good for consumption",
"definition" : "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "NutritionProduct.instance.useBy",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.note",
"path" : "NutritionProduct.note",
"short" : "Comments made about the product",
"definition" : "Comments made about the product.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "NutritionProduct.note",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Annotation"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
}]
}]
},
"differential" : {
"element" : [{
"id" : "NutritionProduct",
"path" : "NutritionProduct",
"short" : "A product used for nutritional purposes",
"definition" : "A food or fluid product that is consumed by patients.",
"min" : 0,
"max" : "*",
"mustSupport" : false,
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Act[moodCode=EVN]"
},
{
"identity" : "w5",
"map" : "clinical.general"
}]
},
{
"id" : "NutritionProduct.status",
"path" : "NutritionProduct.status",
"short" : "active | inactive | entered-in-error",
"definition" : "The current state of the product.",
"comment" : "Unknown does not represent \"other\" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"mustSupport" : false,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductStatus"
}],
"strength" : "required",
"description" : "Codes identifying the lifecycle stage of a product.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutritionproduct-status|4.3.0"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".status"
}]
},
{
"id" : "NutritionProduct.category",
"path" : "NutritionProduct.category",
"short" : "A category or class of the nutrition product (halal, kosher, gluten free, vegan, etc)",
"definition" : "Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.",
"alias" : ["class"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableConcept"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductCategory"
}],
"strength" : "example",
"description" : "Codes identifying classes of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrition-product-category"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionProduct.code",
"path" : "NutritionProduct.code",
"short" : "A code designating a specific type of nutritional product",
"definition" : "The code assigned to the product, for example a manufacturer number or other terminology.",
"alias" : ["type"],
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductCode"
}],
"strength" : "example",
"description" : "Codes identifying specific types of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/edible-substance-type"
},
"mapping" : [{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".code"
}]
},
{
"id" : "NutritionProduct.manufacturer",
"path" : "NutritionProduct.manufacturer",
"short" : "Manufacturer, representative or officially responsible for the product",
"definition" : "The organisation (manufacturer, representative or legal authorisation holder) that is responsible for the device.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Varies by domain"
}]
},
{
"id" : "NutritionProduct.nutrient",
"path" : "NutritionProduct.nutrient",
"short" : "The product's nutritional information expressed by the nutrients",
"definition" : "The product's nutritional information expressed by the nutrients.",
"comment" : "Note: This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements" : "Allows identification of the {{title}} as it is known by various participating systems and in a way that remains consistent across servers.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "v2",
"map" : "Varies by domain"
},
{
"identity" : "rim",
"map" : ".identifier"
}]
},
{
"id" : "NutritionProduct.nutrient.item",
"path" : "NutritionProduct.nutrient.item",
"short" : "The (relevant) nutrients in the product",
"definition" : "The (relevant) nutrients in the product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NutritionProductNutrient"
}],
"strength" : "example",
"description" : "Codes that identify nutrients that could be parts of nutrition products.",
"valueSet" : "http://hl7.org/fhir/ValueSet/nutrition-product-nutrient"
}
},
{
"id" : "NutritionProduct.nutrient.amount",
"path" : "NutritionProduct.nutrient.amount",
"short" : "The amount of nutrient expressed in one or more units: X per pack / per serving / per dose",
"definition" : "The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Ratio"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.ingredient",
"path" : "NutritionProduct.ingredient",
"short" : "Ingredients contained in this product",
"definition" : "Ingredients contained in this product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.ingredient.item",
"path" : "NutritionProduct.ingredient.item",
"short" : "The ingredient contained in the product",
"definition" : "The ingredient contained in the product.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/NutritionProduct"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.ingredient.amount",
"path" : "NutritionProduct.ingredient.amount",
"short" : "The amount of ingredient that is in the product",
"definition" : "The amount of ingredient that is in the product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Ratio"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : true
},
{
"id" : "NutritionProduct.knownAllergen",
"path" : "NutritionProduct.knownAllergen",
"short" : "Known or suspected allergens that are a part of this product",
"definition" : "Allergens that are known or suspected to be a part of this nutrition product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "CodeableReference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Substance"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AllergenClass"
}],
"strength" : "example",
"description" : "Codes that identify substances that can be an allergen.",
"valueSet" : "http://hl7.org/fhir/ValueSet/allergen-class"
}
},
{
"id" : "NutritionProduct.productCharacteristic",
"path" : "NutritionProduct.productCharacteristic",
"short" : "Specifies descriptive properties of the nutrition product",
"definition" : "Specifies descriptive properties of the nutrition product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.productCharacteristic.type",
"path" : "NutritionProduct.productCharacteristic.type",
"short" : "Code specifying the type of characteristic",
"definition" : "A code specifying which characteristic of the product is being described (for example, colour, shape).",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "PropertyCharacteristic"
}],
"strength" : "example",
"description" : "Codes that identify properties that can be measured.",
"valueSet" : "http://hl7.org/fhir/ValueSet/measurement-property"
}
},
{
"id" : "NutritionProduct.productCharacteristic.value[x]",
"path" : "NutritionProduct.productCharacteristic.value[x]",
"short" : "The value of the characteristic",
"definition" : "The actual characteristic value corresponding to the type.",
"comment" : "The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
},
{
"code" : "string"
},
{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
},
{
"code" : "base64Binary"
},
{
"code" : "Attachment"
},
{
"code" : "boolean"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance",
"path" : "NutritionProduct.instance",
"short" : "One or several physical instances or occurrences of the nutrition product",
"definition" : "Conveys instance-level information about this product item. One or several physical, countable instances or occurrences of the product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.quantity",
"path" : "NutritionProduct.instance.quantity",
"short" : "The amount of items or instances",
"definition" : "The amount of items or instances that the resource considers, for instance when referring to 2 identical units together.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Quantity",
"profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.identifier",
"path" : "NutritionProduct.instance.identifier",
"short" : "The identifier for the physical instance, typically a serial number",
"definition" : "The identifier for the physical instance, typically a serial number.",
"alias" : ["serialNumber"],
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Identifier"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.lotNumber",
"path" : "NutritionProduct.instance.lotNumber",
"short" : "The identification of the batch or lot of the product",
"definition" : "The identification of the batch or lot of the product.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.expiry",
"path" : "NutritionProduct.instance.expiry",
"short" : "The expiry date or date and time for the product",
"definition" : "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.instance.useBy",
"path" : "NutritionProduct.instance.useBy",
"short" : "The date until which the product is expected to be good for consumption",
"definition" : "The time after which the product is no longer expected to be in proper condition, or its use is not advised or not allowed.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "dateTime"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "NutritionProduct.note",
"path" : "NutritionProduct.note",
"short" : "Comments made about the product",
"definition" : "Comments made about the product.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "Annotation"
}],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "v2",
"map" : "NTE"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR Release 4B (v4.3.0) hl7.fhir.r4b.core#4.3.0 generated on Sat, May 28, 2022 12:56+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change