PACIO Personal Functioning and Engagement Implementation Guide
3.0.0-ballot - STU 3 Ballot United States of America flag

PACIO Personal Functioning and Engagement Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-pfe/ and changes regularly. See the Directory of published versions

Resource Profile: Personal Functioning and Engagement Nutrition Product Profile - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the pfe-nutrition-product resource profile

See the documentation on how to interpret the contents of this table

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.

ShortResource for non-supported content
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesZ-resource, Extension-resource, Custom-resource
Invariantsdom-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.

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

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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.language
Definition

The base language in which the resource is written.

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

Control0..1
BindingThe codes SHALL be taken from The codes SHOULD be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(required to http://hl7.org/fhir/ValueSet/all-languages)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
6. Basic.extension:code
Slice Namecode
Definition

R5: NutritionProduct.code (new:CodeableConcept)

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

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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:code.extension
Definition

An Extension


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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Basic.extension:code.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.code"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.code"/>
12. Basic.extension:code.value[x]
Definition

The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortA code that can identify the detailed nutrients and ingredients in a specific food productValue of extension
Control0..1
BindingFor example codes, see For codes, see Types of Edible Substances
(example to http://terminology.hl7.org/ValueSet/edible-substance-type)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-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()))
14. Basic.extension:category
Slice Namecategory
Definition

R5: NutritionProduct.category (new:CodeableConcept)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(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 Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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())
16. Basic.extension:category.extension
Definition

An Extension


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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. Basic.extension:category.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.category"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.category"/>
20. Basic.extension:category.value[x]
Definition

Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortBroad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef ProductsValue of extension
Control0..1
BindingFor example codes, see For codes, see PFE Categories of Nutrition Products
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-category)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-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()))
22. Basic.extension:manufacturer
Slice Namemanufacturer
Definition

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

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(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 Modifierfalse
Summaryfalse
Invariantsele-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.extension:nutrient
Slice Namenutrient
Definition

R5: NutritionProduct.nutrient (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: The product's nutritional information expressed by the nutrients (new)) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
26. Basic.extension:nutrient.extension:item
Slice Nameitem
Definition

R5: NutritionProduct.nutrient.item (new:CodeableReference(Substance))

ShortR5: The (relevant) nutrients in the product (new)Additional content defined by implementations
Comments

Element NutritionProduct.nutrient.item is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.item is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.item has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.nutrient.item is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.item is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.item has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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.extension:nutrient.extension:item.extension
Definition

An Extension


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.

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

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. Basic.extension:nutrient.extension:item.extension:_datatype
Slice Name_datatype
Definition

Slice to indicate the presence of a R5 CodeableReference in FHIR R4

ShortDataType slice for a FHIR R5 `CodeableReference` valueAdditional content defined by implementations
Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
32. Basic.extension:nutrient.extension:item.extension:_datatype.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/_datatype"
}
<url value="http://hl7.org/fhir/StructureDefinition/_datatype"/>
34. Basic.extension:nutrient.extension:item.extension:_datatype.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Comments

Must be: CodeableReference

Control10..1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueString" : "CodeableReference"
}
<valueString value="CodeableReference"/>
Invariantsele-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()))
36. Basic.extension:nutrient.extension:item.extension:concept
Slice Nameconcept
Definition

R5: CodeableReference.concept

ShortR5: Reference to a concept (by class)Additional content defined by implementations
Comments

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Invariantsele-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())
38. Basic.extension:nutrient.extension:item.extension:concept.extension
Definition

An Extension


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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. Basic.extension:nutrient.extension:item.extension:concept.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "concept"
}
<url value="concept"/>
42. Basic.extension:nutrient.extension:item.extension:concept.value[x]
Definition

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortReference to a concept (by class)Value of extension
Control0..1
BindingFor example codes, see For codes, see PFE Codes for Nutrition Product Nutrients
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-nutrient)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-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()))
44. Basic.extension:nutrient.extension:item.extension:reference
Slice Namereference
Definition

R5: CodeableReference.reference

ShortR5: Reference to a resource (by instance)Additional content defined by implementations
Comments

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Invariantsele-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())
46. Basic.extension:nutrient.extension:item.extension:reference.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "reference"
}
<url value="reference"/>
48. Basic.extension:nutrient.extension:item.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "item"
}
<url value="item"/>
50. Basic.extension:nutrient.extension:item.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
52. Basic.extension:nutrient.extension:amount
Slice Nameamount
Definition

R5: NutritionProduct.nutrient.amount (new:Ratio)

ShortR5: The amount of nutrient expressed in one or more units: X per pack / per serving / per dose (new)Additional content defined by implementations
Comments

Element NutritionProduct.nutrient.amount is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.amount is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.amount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.nutrient.amount is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.amount is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.amount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
54. Basic.extension:nutrient.extension:amount.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "amount"
}
<url value="amount"/>
56. Basic.extension:nutrient.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.nutrient"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.nutrient"/>
58. Basic.extension:nutrient.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
60. Basic.extension:ingredient
Slice Nameingredient
Definition

R5: NutritionProduct.ingredient (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Ingredients contained in this product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
62. Basic.extension:knownAllergen
Slice NameknownAllergen
Definition

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

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Known or suspected allergens that are a part of this product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
64. Basic.extension:knownAllergen.extension
Definition

An Extension


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.

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

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. Basic.extension:knownAllergen.extension:_datatype
Slice Name_datatype
Definition

Slice to indicate the presence of a R5 CodeableReference in FHIR R4

ShortDataType slice for a FHIR R5 `CodeableReference` valueAdditional content defined by implementations
Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
68. Basic.extension:knownAllergen.extension:_datatype.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/_datatype"
}
<url value="http://hl7.org/fhir/StructureDefinition/_datatype"/>
70. Basic.extension:knownAllergen.extension:_datatype.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Comments

Must be: CodeableReference

Control10..1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueString" : "CodeableReference"
}
<valueString value="CodeableReference"/>
Invariantsele-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()))
72. Basic.extension:knownAllergen.extension:concept
Slice Nameconcept
Definition

R5: CodeableReference.concept

ShortR5: Reference to a concept (by class)Additional content defined by implementations
Comments

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Invariantsele-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())
74. Basic.extension:knownAllergen.extension:concept.extension
Definition

An Extension


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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. Basic.extension:knownAllergen.extension:concept.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "concept"
}
<url value="concept"/>
78. Basic.extension:knownAllergen.extension:concept.value[x]
Definition

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortReference to a concept (by class)Value of extension
Control0..1
BindingFor example codes, see For codes, see PFE Codes for Allergen Classes
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-allergen-class)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-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()))
80. Basic.extension:knownAllergen.extension:reference
Slice Namereference
Definition

R5: CodeableReference.reference

ShortR5: Reference to a resource (by instance)Additional content defined by implementations
Comments

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Control0..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Invariantsele-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())
82. Basic.extension:knownAllergen.extension:reference.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "reference"
}
<url value="reference"/>
84. Basic.extension:knownAllergen.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.knownAllergen"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.knownAllergen"/>
86. Basic.extension:knownAllergen.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
88. Basic.extension:characteristic
Slice Namecharacteristic
Definition

R5: NutritionProduct.characteristic (new:BackboneElement)

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

Properties of the nutrition product can include color or shape.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Specifies descriptive properties of the nutrition product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
90. Basic.extension:characteristic.extension
Definition

An Extension


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.

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

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
92. Basic.extension:characteristic.extension:type
Slice Nametype
Definition

R5: NutritionProduct.characteristic.type (new:CodeableConcept)

ShortR5: Code specifying the type of characteristic (new)Additional content defined by implementations
Comments

Element NutritionProduct.characteristic.type is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.type is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.type has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.characteristic.type is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.type is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.type has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
94. Basic.extension:characteristic.extension:type.extension
Definition

An Extension


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.

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

Control0..0*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
96. Basic.extension:characteristic.extension:type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "type"
}
<url value="type"/>
98. Basic.extension:characteristic.extension:type.value[x]
Definition

A code specifying which characteristic of the product is being described (for example, colour, shape).


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortCode specifying the type of characteristicValue of extension
Control10..1
BindingFor example codes, see For codes, see PFE Codes for Product Characteristics
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-measurement-property)
TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-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()))
100. Basic.extension:characteristic.extension:value
Slice Namevalue
Definition

R5: NutritionProduct.characteristic.value[x] (new:Attachment, base64Binary, boolean, CodeableConcept, Quantity[SimpleQuantity], string)

ShortR5: The value of the characteristic (new)Additional content defined by implementations
Comments

Element NutritionProduct.characteristic.value[x] is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.value[x] is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.value[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control10..1*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.characteristic.value[x] is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.value[x] is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.value[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
102. Basic.extension:characteristic.extension:value.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "value"
}
<url value="value"/>
104. Basic.extension:characteristic.extension:value.value[x]
Definition

The actual characteristic value corresponding to the type.


Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortThe value of the characteristicValue of extension
Comments

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.

Control10..1
TypeChoice of: CodeableConcept, string, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well), base64Binary, Attachment, boolean, date, Meta, Address, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
106. Basic.extension:characteristic.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.characteristic"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.characteristic"/>
108. Basic.extension:characteristic.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..01
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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()))
110. Basic.extension:instance
Slice Nameinstance
Definition

R5: NutritionProduct.instance (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: One or several physical instances or occurrences of the nutrition product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
112. Basic.extension:note
Slice Namenote
Definition

R5: NutritionProduct.note (new:Annotation)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Comments made about the product (new)) (Extension Type: Annotation)
Is Modifierfalse
Summaryfalse
Invariantsele-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())
114. 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).

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

Control10..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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 Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
116. Basic.modifierExtension:status
Slice Namestatus
Definition

R5: NutritionProduct.status (new:code)

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

Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: active | inactive | entered-in-error (new)) (Extension Type: code)
Is Modifiertrue 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
Must Supporttrue
Summaryfalse
Invariantsele-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())
118. Basic.code
Definition

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

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

Control1..1
BindingFor 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.

TypeCodeableConcept
Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summarytrue
Requirements

Must be able to distinguish different types of Basic resources.

Invariantsele-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()))

See the documentation on how to interpret the contents of this table

0. Basic
2. Basic.language
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
4. Basic.extension:code
Slice Namecode
Must Supporttrue
6. Basic.extension:code.extension
Control0..0
8. Basic.extension:code.value[x]
BindingFor example codes, see Types of Edible Substances
(example to http://terminology.hl7.org/ValueSet/edible-substance-type)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. Basic.extension:category
Slice Namecategory
Must Supporttrue
12. Basic.extension:category.extension
Control0..0
14. Basic.extension:category.value[x]
BindingFor example codes, see PFE Categories of Nutrition Products
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-category)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
16. Basic.extension:nutrient
Slice Namenutrient
Must Supporttrue
18. Basic.extension:nutrient.extension:item
Slice Nameitem
20. Basic.extension:nutrient.extension:item.extension:concept
Slice Nameconcept
22. Basic.extension:nutrient.extension:item.extension:concept.extension
Control0..0
24. Basic.extension:nutrient.extension:item.extension:concept.value[x]
BindingFor example codes, see PFE Codes for Nutrition Product Nutrients
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-nutrient)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
26. Basic.extension:knownAllergen
Slice NameknownAllergen
28. Basic.extension:knownAllergen.extension:concept
Slice Nameconcept
30. Basic.extension:knownAllergen.extension:concept.extension
Control0..0
32. Basic.extension:knownAllergen.extension:concept.value[x]
BindingFor example codes, see PFE Codes for Allergen Classes
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-allergen-class)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
34. Basic.extension:characteristic
Slice Namecharacteristic
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).

Properties of the nutrition product can include color or shape.

36. Basic.extension:characteristic.extension:type
Slice Nametype
38. Basic.extension:characteristic.extension:type.extension
Control0..0
40. Basic.extension:characteristic.extension:type.value[x]
BindingFor example codes, see PFE Codes for Product Characteristics
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-measurement-property)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
42. Basic.modifierExtension
Control1..?
44. Basic.modifierExtension:status
Slice Namestatus
Must Supporttrue

See the documentation on how to interpret the contents of this table

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.

ShortResource for non-supported content
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesZ-resource, Extension-resource, Custom-resource
Invariantsdom-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.

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

Control0..1
Typeid
Is Modifierfalse
Summarytrue
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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-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.

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

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-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.

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

Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages)
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-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.

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

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-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.

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

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Basic.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Basic.extension:code
Slice Namecode
Definition

R5: NutritionProduct.code (new:CodeableConcept)

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

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: A code that can identify the detailed nutrients and ingredients in a specific food product (new)) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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:code.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
20. Basic.extension:code.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. Basic.extension:code.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.code"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.code"/>
24. Basic.extension:code.value[x]
Definition

The code assigned to the product, for example a USDA NDB number, a USDA FDC ID number, or a Langual code.

ShortA code that can identify the detailed nutrients and ingredients in a specific food product
Control0..1
BindingFor example codes, see Types of Edible Substances
(example to http://terminology.hl7.org/ValueSet/edible-substance-type)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Basic.extension:category
Slice Namecategory
Definition

R5: NutritionProduct.category (new:CodeableConcept)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(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 Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-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.extension:category.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
30. Basic.extension:category.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Basic.extension:category.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.category"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.category"/>
34. Basic.extension:category.value[x]
Definition

Nutrition products can have different classifications - according to its nutritional properties, preparation methods, etc.

ShortBroad product groups or categories used to classify the product, such as Legume and Legume Products, Beverages, or Beef Products
Control0..1
BindingFor example codes, see PFE Categories of Nutrition Products
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-category)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Basic.extension:manufacturer
Slice Namemanufacturer
Definition

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

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(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 Modifierfalse
Summaryfalse
Invariantsele-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())
38. Basic.extension:nutrient
Slice Namenutrient
Definition

R5: NutritionProduct.nutrient (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: The product's nutritional information expressed by the nutrients (new)) (Complex Extension)
Is Modifierfalse
Must Supporttrue
Invariantsele-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())
40. Basic.extension:nutrient.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
42. Basic.extension:nutrient.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. Basic.extension:nutrient.extension:item
Slice Nameitem
Definition

R5: NutritionProduct.nutrient.item (new:CodeableReference(Substance))

ShortR5: The (relevant) nutrients in the product (new)
Comments

Element NutritionProduct.nutrient.item is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.item is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.item has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.nutrient.item is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.item is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.item has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
46. Basic.extension:nutrient.extension:item.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
48. Basic.extension:nutrient.extension:item.extension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. Basic.extension:nutrient.extension:item.extension:_datatype
Slice Name_datatype
Definition

Slice to indicate the presence of a R5 CodeableReference in FHIR R4

ShortDataType slice for a FHIR R5 `CodeableReference` value
Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
52. Basic.extension:nutrient.extension:item.extension:_datatype.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
54. Basic.extension:nutrient.extension:item.extension:_datatype.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Basic.extension:nutrient.extension:item.extension:_datatype.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/_datatype"
}
<url value="http://hl7.org/fhir/StructureDefinition/_datatype"/>
58. Basic.extension:nutrient.extension:item.extension:_datatype.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Comments

Must be: CodeableReference

Control1..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueString" : "CodeableReference"
}
<valueString value="CodeableReference"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Basic.extension:nutrient.extension:item.extension:concept
Slice Nameconcept
Definition

R5: CodeableReference.concept

ShortR5: Reference to a concept (by class)
Comments

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Invariantsele-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())
62. Basic.extension:nutrient.extension:item.extension:concept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
64. Basic.extension:nutrient.extension:item.extension:concept.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
66. Basic.extension:nutrient.extension:item.extension:concept.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "concept"
}
<url value="concept"/>
68. Basic.extension:nutrient.extension:item.extension:concept.value[x]
Definition

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

ShortReference to a concept (by class)
Control0..1
BindingFor example codes, see PFE Codes for Nutrition Product Nutrients
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-nutrition-product-nutrient)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Basic.extension:nutrient.extension:item.extension:reference
Slice Namereference
Definition

R5: CodeableReference.reference

ShortR5: Reference to a resource (by instance)
Comments

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Invariantsele-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())
72. Basic.extension:nutrient.extension:item.extension:reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
74. Basic.extension:nutrient.extension:item.extension:reference.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
76. Basic.extension:nutrient.extension:item.extension:reference.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "reference"
}
<url value="reference"/>
78. Basic.extension:nutrient.extension:item.extension:reference.value[x]
Definition

A reference to a resource the provides exact details about the information being referenced.

ShortReference to a resource (by instance)
Control0..1
TypeReference(Cross-version Profile for R5.Substance for use in FHIR R4, Substance)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Basic.extension:nutrient.extension:item.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "item"
}
<url value="item"/>
82. Basic.extension:nutrient.extension:item.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Basic.extension:nutrient.extension:amount
Slice Nameamount
Definition

R5: NutritionProduct.nutrient.amount (new:Ratio)

ShortR5: The amount of nutrient expressed in one or more units: X per pack / per serving / per dose (new)
Comments

Element NutritionProduct.nutrient.amount is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.amount is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.amount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.nutrient.amount is part of an existing definition because parent element NutritionProduct.nutrient requires a cross-version extension. Element NutritionProduct.nutrient.amount is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.nutrient.amount has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
86. Basic.extension:nutrient.extension:amount.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
88. Basic.extension:nutrient.extension:amount.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. Basic.extension:nutrient.extension:amount.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "amount"
}
<url value="amount"/>
92. Basic.extension:nutrient.extension:amount.value[x]
Definition

The amount of nutrient expressed in one or more units: X per pack / per serving / per dose.

ShortThe amount of nutrient expressed in one or more units: X per pack / per serving / per dose
Control0..1
TypeRatio
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Basic.extension:nutrient.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.nutrient"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.nutrient"/>
96. Basic.extension:nutrient.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Basic.extension:ingredient
Slice Nameingredient
Definition

R5: NutritionProduct.ingredient (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Ingredients contained in this product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
100. Basic.extension:knownAllergen
Slice NameknownAllergen
Definition

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

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Known or suspected allergens that are a part of this product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
102. Basic.extension:knownAllergen.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
104. Basic.extension:knownAllergen.extension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
106. Basic.extension:knownAllergen.extension:_datatype
Slice Name_datatype
Definition

Slice to indicate the presence of a R5 CodeableReference in FHIR R4

ShortDataType slice for a FHIR R5 `CodeableReference` value
Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
108. Basic.extension:knownAllergen.extension:_datatype.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
110. Basic.extension:knownAllergen.extension:_datatype.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
112. Basic.extension:knownAllergen.extension:_datatype.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/StructureDefinition/_datatype"
}
<url value="http://hl7.org/fhir/StructureDefinition/_datatype"/>
114. Basic.extension:knownAllergen.extension:_datatype.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Comments

Must be: CodeableReference

Control1..1
Typestring
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Fixed Value
{
  "valueString" : "CodeableReference"
}
<valueString value="CodeableReference"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. Basic.extension:knownAllergen.extension:concept
Slice Nameconcept
Definition

R5: CodeableReference.concept

ShortR5: Reference to a concept (by class)
Comments

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.concept is mapped to FHIR R4 element CodeableConcept as Equivalent.

Invariantsele-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())
118. Basic.extension:knownAllergen.extension:concept.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
120. Basic.extension:knownAllergen.extension:concept.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
122. Basic.extension:knownAllergen.extension:concept.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "concept"
}
<url value="concept"/>
124. Basic.extension:knownAllergen.extension:concept.value[x]
Definition

A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

ShortReference to a concept (by class)
Control0..1
BindingFor example codes, see PFE Codes for Allergen Classes
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-allergen-class)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Basic.extension:knownAllergen.extension:reference
Slice Namereference
Definition

R5: CodeableReference.reference

ShortR5: Reference to a resource (by instance)
Comments

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Control0..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element CodeableReference.reference is mapped to FHIR R4 element Reference as Equivalent.

Invariantsele-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())
128. Basic.extension:knownAllergen.extension:reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
130. Basic.extension:knownAllergen.extension:reference.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
132. Basic.extension:knownAllergen.extension:reference.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "reference"
}
<url value="reference"/>
134. Basic.extension:knownAllergen.extension:reference.value[x]
Definition

A reference to a resource the provides exact details about the information being referenced.

ShortReference to a resource (by instance)
Control0..1
TypeReference(Cross-version Profile for R5.Substance for use in FHIR R4, Substance)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Basic.extension:knownAllergen.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.knownAllergen"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.knownAllergen"/>
138. Basic.extension:knownAllergen.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Basic.extension:characteristic
Slice Namecharacteristic
Definition

R5: NutritionProduct.characteristic (new:BackboneElement)

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

Properties of the nutrition product can include color or shape.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Specifies descriptive properties of the nutrition product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
142. Basic.extension:characteristic.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
144. Basic.extension:characteristic.extension
Definition

An Extension

ShortExtension
Control2..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
146. Basic.extension:characteristic.extension:type
Slice Nametype
Definition

R5: NutritionProduct.characteristic.type (new:CodeableConcept)

ShortR5: Code specifying the type of characteristic (new)
Comments

Element NutritionProduct.characteristic.type is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.type is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.type has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.characteristic.type is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.type is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.type has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
148. Basic.extension:characteristic.extension:type.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
150. Basic.extension:characteristic.extension:type.extension
Definition

An Extension

ShortExtension
Control0..0
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
152. Basic.extension:characteristic.extension:type.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "type"
}
<url value="type"/>
154. Basic.extension:characteristic.extension:type.value[x]
Definition

A code specifying which characteristic of the product is being described (for example, colour, shape).

ShortCode specifying the type of characteristic
Control1..1
BindingFor example codes, see PFE Codes for Product Characteristics
(example to http://hl7.org/fhir/us/pacio-pfe/ValueSet/pfe-measurement-property)
TypeCodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Basic.extension:characteristic.extension:value
Slice Namevalue
Definition

R5: NutritionProduct.characteristic.value[x] (new:Attachment, base64Binary, boolean, CodeableConcept, Quantity[SimpleQuantity], string)

ShortR5: The value of the characteristic (new)
Comments

Element NutritionProduct.characteristic.value[x] is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.value[x] is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.value[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

Control1..1
TypeExtension
Is Modifierfalse
Summaryfalse
Requirements

Element NutritionProduct.characteristic.value[x] is part of an existing definition because parent element NutritionProduct.characteristic requires a cross-version extension. Element NutritionProduct.characteristic.value[x] is not mapped to FHIR R4, since FHIR R5 NutritionProduct is not mapped. Element NutritionProduct.characteristic.value[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Invariantsele-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())
158. Basic.extension:characteristic.extension:value.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
160. Basic.extension:characteristic.extension:value.extension
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.

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.extension.extension.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
162. Basic.extension:characteristic.extension:value.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "value"
}
<url value="value"/>
164. Basic.extension:characteristic.extension:value.value[x]
Definition

The actual characteristic value corresponding to the type.

ShortThe value of the characteristic
Comments

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.

Control1..1
TypeChoice of: CodeableConcept, string, Quantity(SimpleQuantity The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well), base64Binary, Attachment, boolean
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Basic.extension:characteristic.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Shortidentifies the meaning of the extension
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Control1..1
Typeuri
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
Fixed Value
{
  "url" : "http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.characteristic"
}
<url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-NutritionProduct.characteristic"/>
168. Basic.extension:characteristic.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

ShortValue of extension
Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Basic.extension:instance
Slice Nameinstance
Definition

R5: NutritionProduct.instance (new:BackboneElement)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: One or several physical instances or occurrences of the nutrition product (new)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
172. Basic.extension:note
Slice Namenote
Definition

R5: NutritionProduct.note (new:Annotation)

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

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(R5: Comments made about the product (new)) (Extension Type: Annotation)
Is Modifierfalse
Summaryfalse
Invariantsele-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())
174. Basic.modifierExtension
Definition

An Extension

ShortExtension
Control1..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on Basic.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
176. Basic.modifierExtension:status
Slice Namestatus
Definition

R5: NutritionProduct.status (new:code)

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

Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: active | inactive | entered-in-error (new)) (Extension Type: code)
Is Modifiertrue 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
Must Supporttrue
Summaryfalse
Invariantsele-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())
178. Basic.identifier
Definition

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

ShortBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Basic.code
Definition

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

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

Control1..1
BindingFor 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.

TypeCodeableConcept
Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summarytrue
Requirements

Must be able to distinguish different types of Basic resources.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. Basic.subject
Definition

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

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

Control0..1
TypeReference(Resource)
Is Modifierfalse
Summarytrue
Requirements

Needed for partitioning the resource by Patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. Basic.created
Definition

Identifies when the resource was first created.

ShortWhen created
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows ordering resource instances by time.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Basic.author
Definition

Indicates who was responsible for creating the resource instance.

ShortWho created
Control0..1
TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)
Is Modifierfalse
Summarytrue
Requirements

Needed for partitioning the resource.

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