Profile_R5_NutritionProduct_R4 - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

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

Resource Profile: Profile_R5_NutritionProduct_R4 - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the profile-NutritionProduct resource profile.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
Definition	Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
Short	Resource for non-supported content
Control	0..*
Is Modifier	false
Summary	false
Alternate Names	Z-resource, Extension-resource, Custom-resource
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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().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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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().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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.implicitRules
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.
Short	A set of rules under which this content was created
Comments	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.
Control	0..1
Type	uri
Is Modifier	true because 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
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Basic.extension
Definition	An Extension 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.
Short	ExtensionAdditional content defined by implementations
Comments	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.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Basic.extension:code
Slice Name	code
Definition	R5: `NutritionProduct.code` (new:CodeableConcept)
Short	R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)
Comments	Element `NutritionProduct.code` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.code` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Basic.extension:category
Slice Name	category
Definition	R5: `NutritionProduct.category` (new:CodeableConcept)
Short	R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)
Comments	Element `NutritionProduct.category` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.category` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Basic.extension:manufacturer
Slice Name	manufacturer
Definition	R5: `NutritionProduct.manufacturer` (new:Reference(Organization))
Short	R5: Manufacturer, representative or officially responsible for the product (new)
Comments	Element `NutritionProduct.manufacturer` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.manufacturer` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Manufacturer, representative or officially responsible for the product (new)) (Extension Type: Reference(Cross-version Profile for R5.Organization for use in FHIR R4, Organization))
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Basic.extension:nutrient
Slice Name	nutrient
Definition	R5: `NutritionProduct.nutrient` (new:BackboneElement)
Short	R5: The product's nutritional information expressed by the nutrients (new)
Comments	Element `NutritionProduct.nutrient` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.nutrient` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note: This is a business identifier, not a resource identifier (see discussion). 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.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The product's nutritional information expressed by the nutrients (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
14. Basic.extension:ingredient
Slice Name	ingredient
Definition	R5: `NutritionProduct.ingredient` (new:BackboneElement)
Short	R5: Ingredients contained in this product (new)
Comments	Element `NutritionProduct.ingredient` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.ingredient` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Ingredients contained in this product (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Basic.extension:knownAllergen
Slice Name	knownAllergen
Definition	R5: `NutritionProduct.knownAllergen` (new:CodeableReference(Substance))
Short	R5: Known or suspected allergens that are a part of this product (new)
Comments	Element `NutritionProduct.knownAllergen` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.knownAllergen` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Known or suspected allergens that are a part of this product (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Basic.extension:characteristic
Slice Name	characteristic
Definition	R5: `NutritionProduct.characteristic` (new:BackboneElement)
Short	R5: Specifies descriptive properties of the nutrition product (new)
Comments	Element `NutritionProduct.characteristic` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.characteristic` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Specifies descriptive properties of the nutrition product (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. Basic.extension:instance
Slice Name	instance
Definition	R5: `NutritionProduct.instance` (new:BackboneElement)
Short	R5: One or several physical instances or occurrences of the nutrition product (new)
Comments	Element `NutritionProduct.instance` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.instance` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: One or several physical instances or occurrences of the nutrition product (new)) (Complex Extension)
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. Basic.extension:note
Slice Name	note
Definition	R5: `NutritionProduct.note` (new:Annotation)
Short	R5: Comments made about the product (new)
Comments	Element `NutritionProduct.note` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Comments made about the product (new)) (Extension Type: Annotation)
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Basic.modifierExtension
Definition	An Extension 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short	ExtensionExtensions that cannot be ignored
Comments	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.
Control	0..*
Type	Extension
Is Modifier	true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary	false
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.
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
26. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `NutritionProduct.status` (new:code)
Short	R5: active \| inactive \| entered-in-error (new)
Comments	Element `NutritionProduct.status` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: active \| inactive \| entered-in-error (new)) (Extension Type: code)
Is Modifier	true because 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
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Basic.code
Definition	Identifies the 'type' of resource - equivalent to the resource name for other resources.
Short	Kind of Resource
Comments	Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.
Control	1..1
Binding	For example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type\|4.0.1 (example to `http://hl7.org/fhir/ValueSet/basic-resource-type\|4.0.1`) Codes for identifying types of resources not yet defined by FHIR.
Type	CodeableConcept
Is Modifier	true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summary	true
Requirements	Must be able to distinguish different types of Basic resources.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
2. Basic.extension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Basic.extension:code
Slice Name	code
Definition	R5: `NutritionProduct.code` (new:CodeableConcept)
Short	R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)
Comments	Element `NutritionProduct.code` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.code` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)) (Extension Type: CodeableConcept)
6. Basic.extension:category
Slice Name	category
Definition	R5: `NutritionProduct.category` (new:CodeableConcept)
Short	R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)
Comments	Element `NutritionProduct.category` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.category` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)) (Extension Type: CodeableConcept)
8. Basic.extension:manufacturer
Slice Name	manufacturer
Definition	R5: `NutritionProduct.manufacturer` (new:Reference(Organization))
Short	R5: Manufacturer, representative or officially responsible for the product (new)
Comments	Element `NutritionProduct.manufacturer` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.manufacturer` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Manufacturer, representative or officially responsible for the product (new)) (Extension Type: Reference(Cross-version Profile for R5.Organization for use in FHIR R4, Organization))
10. Basic.extension:nutrient
Slice Name	nutrient
Definition	R5: `NutritionProduct.nutrient` (new:BackboneElement)
Short	R5: The product's nutritional information expressed by the nutrients (new)
Comments	Element `NutritionProduct.nutrient` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.nutrient` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note: This is a business identifier, not a resource identifier (see discussion). 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.
Control	0..*
Type	Extension(R5: The product's nutritional information expressed by the nutrients (new)) (Complex Extension)
12. Basic.extension:ingredient
Slice Name	ingredient
Definition	R5: `NutritionProduct.ingredient` (new:BackboneElement)
Short	R5: Ingredients contained in this product (new)
Comments	Element `NutritionProduct.ingredient` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.ingredient` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Ingredients contained in this product (new)) (Complex Extension)
14. Basic.extension:knownAllergen
Slice Name	knownAllergen
Definition	R5: `NutritionProduct.knownAllergen` (new:CodeableReference(Substance))
Short	R5: Known or suspected allergens that are a part of this product (new)
Comments	Element `NutritionProduct.knownAllergen` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.knownAllergen` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Known or suspected allergens that are a part of this product (new)) (Complex Extension)
16. Basic.extension:characteristic
Slice Name	characteristic
Definition	R5: `NutritionProduct.characteristic` (new:BackboneElement)
Short	R5: Specifies descriptive properties of the nutrition product (new)
Comments	Element `NutritionProduct.characteristic` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.characteristic` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Specifies descriptive properties of the nutrition product (new)) (Complex Extension)
18. Basic.extension:instance
Slice Name	instance
Definition	R5: `NutritionProduct.instance` (new:BackboneElement)
Short	R5: One or several physical instances or occurrences of the nutrition product (new)
Comments	Element `NutritionProduct.instance` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.instance` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: One or several physical instances or occurrences of the nutrition product (new)) (Complex Extension)
20. Basic.extension:note
Slice Name	note
Definition	R5: `NutritionProduct.note` (new:Annotation)
Short	R5: Comments made about the product (new)
Comments	Element `NutritionProduct.note` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.note` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Comments made about the product (new)) (Extension Type: Annotation)
22. Basic.modifierExtension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `NutritionProduct.status` (new:code)
Short	R5: active \| inactive \| entered-in-error (new)
Comments	Element `NutritionProduct.status` is not mapped to FHIR R4, since FHIR R5 `NutritionProduct` is not mapped. Element `NutritionProduct.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.
Control	1..1
Type	Extension(R5: active \| inactive \| entered-in-error (new)) (Extension Type: code)

Guidance on how to interpret the contents of this table can be foundhere

0. Basic

Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Short Resource for non-supported content

Control 0..*

Is Modifier false

Summary false

Alternate Names Z-resource, Extension-resource, Custom-resource

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().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(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())

2. Basic.id

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Short Logical id of this artifact

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control 0..1

Type

Is Modifier false

Summary true

4. Basic.meta

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.

Short Metadata about the resource

Control 0..1

Type

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Basic.implicitRules

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.

Short A set of rules under which this content was created

Comments

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.

Control 0..1

Type

uri

Is Modifier true because 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

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Basic.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

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

Control 0..1

Binding

The codes SHOULD be taken from CommonLanguages

(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Basic.text

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.

Short Text summary of the resource, for human interpretation

Comments

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.

Control 0..1

Type

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Basic.contained

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.

Short Contained, inline Resources

Comments

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.

Control 0..*

Type

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. Basic.extension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Basic.extension:code

Slice Name code

Definition

R5: NutritionProduct.code (new:CodeableConcept)

Short R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)

Comments

Element NutritionProduct.code is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.code has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

18. Basic.extension:category

Slice Name category

Definition

R5: NutritionProduct.category (new:CodeableConcept)

Short R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)

Comments

Element NutritionProduct.category is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.category has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Broad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

20. Basic.extension:manufacturer

Slice Name manufacturer

Definition

R5: NutritionProduct.manufacturer (new:Reference(Organization))

Short R5: Manufacturer, representative or officially responsible for the product (new)

Comments

Element NutritionProduct.manufacturer is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.manufacturer has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Manufacturer, representative or officially responsible for the product (new)) (Extension Type: Reference(Cross-version Profile for R5.Organization for use in FHIR R4, Organization))

Is Modifier false

Summary false

22. Basic.extension:nutrient

Slice Name nutrient

Definition

R5: NutritionProduct.nutrient (new:BackboneElement)

Short R5: The product's nutritional information expressed by the nutrients (new)

Comments

Element NutritionProduct.nutrient is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Note: This is a business identifier, not a resource identifier (see discussion). 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.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The product's nutritional information expressed by the nutrients (new)) (Complex Extension)

Is Modifier false

24. Basic.extension:ingredient

Slice Name ingredient

Definition

R5: NutritionProduct.ingredient (new:BackboneElement)

Short R5: Ingredients contained in this product (new)

Comments

Element NutritionProduct.ingredient is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.ingredient has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Ingredients contained in this product (new)) (Complex Extension)

Is Modifier false

26. Basic.extension:knownAllergen

Slice Name knownAllergen

Definition

R5: NutritionProduct.knownAllergen (new:CodeableReference(Substance))

Short R5: Known or suspected allergens that are a part of this product (new)

Comments

Element NutritionProduct.knownAllergen is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.knownAllergen has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Known or suspected allergens that are a part of this product (new)) (Complex Extension)

Is Modifier false

28. Basic.extension:characteristic

Slice Name characteristic

Definition

R5: NutritionProduct.characteristic (new:BackboneElement)

Short R5: Specifies descriptive properties of the nutrition product (new)

Comments

Element NutritionProduct.characteristic is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Specifies descriptive properties of the nutrition product (new)) (Complex Extension)

Is Modifier false

30. Basic.extension:instance

Slice Name instance

Definition

R5: NutritionProduct.instance (new:BackboneElement)

Short R5: One or several physical instances or occurrences of the nutrition product (new)

Comments

Element NutritionProduct.instance is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.instance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: One or several physical instances or occurrences of the nutrition product (new)) (Complex Extension)

Is Modifier false

32. Basic.extension:note

Slice Name note

Definition

R5: NutritionProduct.note (new:Annotation)

Short R5: Comments made about the product (new)

Comments

Element NutritionProduct.note is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.note has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Comments made about the product (new)) (Extension Type: Annotation)

Is Modifier false

Summary false

34. Basic.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

Slicing

This element introduces a set of slices on Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

36. Basic.modifierExtension:status

Slice Name status

Definition

R5: NutritionProduct.status (new:code)

Short R5: active | inactive | entered-in-error (new)

Comments

Element NutritionProduct.status is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.status has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(R5: active | inactive | entered-in-error (new)) (Extension Type: code)

Is Modifier true because 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

Summary false

38. Basic.identifier

Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Short Business identifier

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Type

Identifier

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

40. Basic.code

Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Short Kind of Resource

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Control 1..1

Binding

For example codes, see BasicResourceTypes
(example to http://hl7.org/fhir/ValueSet/basic-resource-type|4.0.1)

Codes for identifying types of resources not yet defined by FHIR.

Type

CodeableConcept

Is Modifier true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.

Summary true

Requirements

Must be able to distinguish different types of Basic resources.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

42. Basic.subject

Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

Short Identifies the focus of this resource

Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control 0..1

Type Reference(Resource)

Is Modifier false

Summary true

Requirements

Needed for partitioning the resource by Patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

44. Basic.created

Definition

Identifies when the resource was first created.

Short When created

Control 0..1

Type

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Allows ordering resource instances by time.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. Basic.author

Definition

Indicates who was responsible for creating the resource instance.

Short Who created

Control 0..1

Type Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)

Is Modifier false

Summary true

Requirements

Needed for partitioning the resource.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))