Extensions for Using Data Elements from FHIR R4B in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_NutritionProduct_R5

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-NutritionProduct Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4B_NutritionProduct_R5

This cross-version profile allows R4B NutritionProduct content to be represented via FHIR R5 NutritionProduct resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
Constraints: ext-1
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: NutritionProductStatus (required): Codes identifying the lifecycle stage of a product.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionProduct.status Base required Nutrition Product Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionProduct If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionProduct 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionProduct A resource should have narrative for robust management text.`div`.exists()
ele-1 error NutritionProduct.implicitRules, NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from NutritionProduct

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... code Σ 0..1 CodeableConcept A code that can identify the detailed nutrients and ingredients in a specific food product
Binding: TypesOfEdibleSubstances (example): Codes identifying specific types of nutrition products.
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: NutritionProductStatus (required): Codes identifying the lifecycle stage of a product.
... category Σ 0..* CodeableConcept Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Binding: CategoriesOfNutritionProducts (example): Codes identifying classes of nutrition products.
... manufacturer Σ 0..* Reference(Organization) Manufacturer, representative or officially responsible for the product
... nutrient Σ 0..* BackboneElement The product's nutritional information expressed by the nutrients
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item 0..1 CodeableReference(Substance) The (relevant) nutrients in the product
Binding: CodesForNutritionProductNutrients (example): Codes that identify nutrients that could be parts of nutrition products.
.... amount 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
... ingredient 0..* BackboneElement Ingredients contained in this product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item Σ 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product
.... amount Σ 0..* Ratio The amount of ingredient that is in the product
... knownAllergen 0..* CodeableReference(Substance) Known or suspected allergens that are a part of this product
Binding: CodesForAllergenClasses (example): Codes that identify substances that can be an allergen.
... characteristic 0..* BackboneElement Specifies descriptive properties of the nutrition product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 CodeableConcept Code specifying the type of characteristic
Binding: CodesForProductCharacteristics (example): Codes that identify properties that can be measured.
.... value[x] 1..1 The value of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
..... valueBoolean boolean
... instance 0..* BackboneElement One or several physical instances or occurrences of the nutrition product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... quantity 0..1 SimpleQuantity(5.0.0) The amount of items or instances
.... identifier 0..* Identifier The identifier for the physical instance, typically a serial number or manufacturer number
.... name 0..1 string The name for the specific product
.... lotNumber 0..1 string The identification of the batch or lot of the product
.... expiry 0..1 dateTime The expiry date or date and time for the product
.... useBy 0..1 dateTime The date until which the product is expected to be good for consumption
.... biologicalSourceEvent 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
... note 0..* Annotation Comments made about the product

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionProduct.language Base required All Languages 📍5.0.0 FHIR Std.
NutritionProduct.code Base example Types of Edible Substances 📍5.0.0 FHIR Std.
NutritionProduct.status Base required Nutrition Product Status 📍5.0.0 FHIR Std.
NutritionProduct.category Base example Categories of Nutrition Products 📍5.0.0 FHIR Std.
NutritionProduct.nutrient.​item Base example Codes for Nutrition Product Nutrients 📍5.0.0 FHIR Std.
NutritionProduct.knownAllergen Base example Codes for Allergen Classes 📍5.0.0 FHIR Std.
NutritionProduct.characteristic.​type Base example Codes for Product Characteristics 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionProduct If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionProduct 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionProduct A resource should have narrative for robust management text.`div`.exists()
ele-1 error NutritionProduct.meta, NutritionProduct.implicitRules, NutritionProduct.language, NutritionProduct.text, NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.code, NutritionProduct.status, NutritionProduct.category, NutritionProduct.manufacturer, NutritionProduct.nutrient, NutritionProduct.nutrient.extension, NutritionProduct.nutrient.modifierExtension, NutritionProduct.nutrient.item, NutritionProduct.nutrient.amount, NutritionProduct.ingredient, NutritionProduct.ingredient.extension, NutritionProduct.ingredient.modifierExtension, NutritionProduct.ingredient.item, NutritionProduct.ingredient.amount, NutritionProduct.knownAllergen, NutritionProduct.characteristic, NutritionProduct.characteristic.extension, NutritionProduct.characteristic.modifierExtension, NutritionProduct.characteristic.type, NutritionProduct.characteristic.value[x], NutritionProduct.instance, NutritionProduct.instance.extension, NutritionProduct.instance.modifierExtension, NutritionProduct.instance.quantity, NutritionProduct.instance.identifier, NutritionProduct.instance.name, NutritionProduct.instance.lotNumber, NutritionProduct.instance.expiry, NutritionProduct.instance.useBy, NutritionProduct.instance.biologicalSourceEvent, NutritionProduct.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.nutrient.extension, NutritionProduct.nutrient.modifierExtension, NutritionProduct.ingredient.extension, NutritionProduct.ingredient.modifierExtension, NutritionProduct.characteristic.extension, NutritionProduct.characteristic.modifierExtension, NutritionProduct.instance.extension, NutritionProduct.instance.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from NutritionProduct

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
Constraints: ext-1
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: NutritionProductStatus (required): Codes identifying the lifecycle stage of a product.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionProduct.status Base required Nutrition Product Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionProduct If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionProduct 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionProduct A resource should have narrative for robust management text.`div`.exists()
ele-1 error NutritionProduct.implicitRules, NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from NutritionProduct

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. NutritionProduct 0..* NutritionProduct(5.0.0) A product used for nutritional purposes (i.e. food or supplement)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:productCharacteristic 0..* (Complex) R4B: Specifies descriptive properties of the nutrition product (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... code Σ 0..1 CodeableConcept A code that can identify the detailed nutrients and ingredients in a specific food product
Binding: TypesOfEdibleSubstances (example): Codes identifying specific types of nutrition products.
... status ?!Σ 1..1 code active | inactive | entered-in-error
Binding: NutritionProductStatus (required): Codes identifying the lifecycle stage of a product.
... category Σ 0..* CodeableConcept Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Binding: CategoriesOfNutritionProducts (example): Codes identifying classes of nutrition products.
... manufacturer Σ 0..* Reference(Organization) Manufacturer, representative or officially responsible for the product
... nutrient Σ 0..* BackboneElement The product's nutritional information expressed by the nutrients
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item 0..1 CodeableReference(Substance) The (relevant) nutrients in the product
Binding: CodesForNutritionProductNutrients (example): Codes that identify nutrients that could be parts of nutrition products.
.... amount 0..* Ratio The amount of nutrient expressed in one or more units: X per pack / per serving / per dose
... ingredient 0..* BackboneElement Ingredients contained in this product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... item Σ 1..1 CodeableReference(NutritionProduct) The ingredient contained in the product
.... amount Σ 0..* Ratio The amount of ingredient that is in the product
... knownAllergen 0..* CodeableReference(Substance) Known or suspected allergens that are a part of this product
Binding: CodesForAllergenClasses (example): Codes that identify substances that can be an allergen.
... characteristic 0..* BackboneElement Specifies descriptive properties of the nutrition product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 1..1 CodeableConcept Code specifying the type of characteristic
Binding: CodesForProductCharacteristics (example): Codes that identify properties that can be measured.
.... value[x] 1..1 The value of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
..... valueBoolean boolean
... instance 0..* BackboneElement One or several physical instances or occurrences of the nutrition product
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... quantity 0..1 SimpleQuantity(5.0.0) The amount of items or instances
.... identifier 0..* Identifier The identifier for the physical instance, typically a serial number or manufacturer number
.... name 0..1 string The name for the specific product
.... lotNumber 0..1 string The identification of the batch or lot of the product
.... expiry 0..1 dateTime The expiry date or date and time for the product
.... useBy 0..1 dateTime The date until which the product is expected to be good for consumption
.... biologicalSourceEvent 0..1 Identifier An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled
... note 0..* Annotation Comments made about the product

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
NutritionProduct.language Base required All Languages 📍5.0.0 FHIR Std.
NutritionProduct.code Base example Types of Edible Substances 📍5.0.0 FHIR Std.
NutritionProduct.status Base required Nutrition Product Status 📍5.0.0 FHIR Std.
NutritionProduct.category Base example Categories of Nutrition Products 📍5.0.0 FHIR Std.
NutritionProduct.nutrient.​item Base example Codes for Nutrition Product Nutrients 📍5.0.0 FHIR Std.
NutritionProduct.knownAllergen Base example Codes for Allergen Classes 📍5.0.0 FHIR Std.
NutritionProduct.characteristic.​type Base example Codes for Product Characteristics 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error NutritionProduct If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error NutritionProduct 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error NutritionProduct If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice NutritionProduct A resource should have narrative for robust management text.`div`.exists()
ele-1 error NutritionProduct.meta, NutritionProduct.implicitRules, NutritionProduct.language, NutritionProduct.text, NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.code, NutritionProduct.status, NutritionProduct.category, NutritionProduct.manufacturer, NutritionProduct.nutrient, NutritionProduct.nutrient.extension, NutritionProduct.nutrient.modifierExtension, NutritionProduct.nutrient.item, NutritionProduct.nutrient.amount, NutritionProduct.ingredient, NutritionProduct.ingredient.extension, NutritionProduct.ingredient.modifierExtension, NutritionProduct.ingredient.item, NutritionProduct.ingredient.amount, NutritionProduct.knownAllergen, NutritionProduct.characteristic, NutritionProduct.characteristic.extension, NutritionProduct.characteristic.modifierExtension, NutritionProduct.characteristic.type, NutritionProduct.characteristic.value[x], NutritionProduct.instance, NutritionProduct.instance.extension, NutritionProduct.instance.modifierExtension, NutritionProduct.instance.quantity, NutritionProduct.instance.identifier, NutritionProduct.instance.name, NutritionProduct.instance.lotNumber, NutritionProduct.instance.expiry, NutritionProduct.instance.useBy, NutritionProduct.instance.biologicalSourceEvent, NutritionProduct.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error NutritionProduct.extension, NutritionProduct.extension:productCharacteristic, NutritionProduct.modifierExtension, NutritionProduct.nutrient.extension, NutritionProduct.nutrient.modifierExtension, NutritionProduct.ingredient.extension, NutritionProduct.ingredient.modifierExtension, NutritionProduct.characteristic.extension, NutritionProduct.characteristic.modifierExtension, NutritionProduct.instance.extension, NutritionProduct.instance.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from NutritionProduct

 

Other representations of profile: CSV, Excel, Schematron