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

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

Extension: ExtensionNutritionProduct_ProductCharacteristic - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R4B-NutritionProduct.productCharacteristic extension.

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

0. Extension
Definition

R4B: NutritionProduct.productCharacteristic (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR4B: Specifies descriptive properties of the nutrition product (new)Optional Extensions Element
Comments

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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. In order 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.

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
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:type
    Slice Nametype
    Definition

    R4B: NutritionProduct.productCharacteristic.type (new:CodeableConcept)

    ShortR4B: Code specifying the type of characteristic (new)Additional Content defined by implementations
    Comments

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

    Control10..1*
    TypeExtension
    Requirements

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

    6. Extension.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuetype
    8. Extension.extension:type.value[x]
    Definition

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


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortCode specifying the type of characteristicValue of extension
    Control10..1
    TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:value
    Slice Namevalue
    Definition

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

    ShortR4B: The value of the characteristic (new)Additional Content defined by implementations
    Comments

    Element NutritionProduct.productCharacteristic.value[x] is part of an existing definition because parent element NutritionProduct.productCharacteristic requires a cross-version extension. Element NutritionProduct.productCharacteristic.value[x] is not mapped to FHIR STU3, since FHIR R4B NutritionProduct is not mapped. Element NutritionProduct.productCharacteristic.value[x] has no mapping targets in FHIR STU3. 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
    Requirements

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

    12. Extension.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuevalue
    14. Extension.extension:value.value[x]
    Definition

    The actual characteristic value corresponding to the type.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for 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), base64Binary, Attachment, boolean, date, dateTime, Meta, code, Address, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Extension.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
    18. Extension.value[x]
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R4B: NutritionProduct.productCharacteristic (new:BackboneElement)

    ShortR4B: Specifies descriptive properties of the nutrition product (new)
    Comments

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

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control2..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:type
      Slice Nametype
      Definition

      R4B: NutritionProduct.productCharacteristic.type (new:CodeableConcept)

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

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

      Control1..1
      Requirements

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

      6. Extension.extension:type.url
      Control1..1
      Fixed Valuetype
      8. Extension.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
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:value
      Slice Namevalue
      Definition

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

      ShortR4B: The value of the characteristic (new)
      Comments

      Element NutritionProduct.productCharacteristic.value[x] is part of an existing definition because parent element NutritionProduct.productCharacteristic requires a cross-version extension. Element NutritionProduct.productCharacteristic.value[x] is not mapped to FHIR STU3, since FHIR R4B NutritionProduct is not mapped. Element NutritionProduct.productCharacteristic.value[x] has no mapping targets in FHIR STU3. 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
      Requirements

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

      12. Extension.extension:value.url
      Control1..1
      Fixed Valuevalue
      14. Extension.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), base64Binary, Attachment, boolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R4B: NutritionProduct.productCharacteristic (new:BackboneElement)

      ShortR4B: Specifies descriptive properties of the nutrition product (new)
      Comments

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

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.id
      Definition

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

      Shortxml:id (or equivalent in JSON)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control2..*
      TypeExtension
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:type
        Slice Nametype
        Definition

        R4B: NutritionProduct.productCharacteristic.type (new:CodeableConcept)

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

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

        Control1..1
        TypeExtension
        Requirements

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

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        10. Extension.extension:type.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. In order 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.

        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
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.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
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          Fixed Valuetype
          14. Extension.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
          TypeCodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          16. Extension.extension:value
          Slice Namevalue
          Definition

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

          ShortR4B: The value of the characteristic (new)
          Comments

          Element NutritionProduct.productCharacteristic.value[x] is part of an existing definition because parent element NutritionProduct.productCharacteristic requires a cross-version extension. Element NutritionProduct.productCharacteristic.value[x] is not mapped to FHIR STU3, since FHIR R4B NutritionProduct is not mapped. Element NutritionProduct.productCharacteristic.value[x] has no mapping targets in FHIR STU3. 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
          Requirements

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

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          20. Extension.extension:value.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. In order 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.

          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
          Alternate Namesextensions, user content
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuevalue
            24. Extension.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), base64Binary, Attachment, boolean
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            26. Extension.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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            Fixed Valuehttp://hl7.org/fhir/4.3/StructureDefinition/extension-NutritionProduct.productCharacteristic
            28. Extension.value[x]
            Definition

            Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

            ShortValue of extension
            Control0..0
            TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension