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

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

Extension: ExtensionInventoryItem_Description - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-InventoryItem.description extension.

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

0. Extension
Definition

R5: InventoryItem.description (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Descriptive characteristics of the item (new)Optional Extensions Element
Comments

Element InventoryItem.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description 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
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())
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())
2. Extension.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..*
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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:language
    Slice Namelanguage
    Definition

    R5: InventoryItem.description.language (new:code)

    ShortR5: The language that is used in the item description (new)Additional content defined by implementations
    Comments

    Element InventoryItem.description.language is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.language is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.language 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 InventoryItem.description.language is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.language is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.language 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())
    6. Extension.extension:language.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 Valuelanguage
    8. Extension.extension:language.value[x]
    Definition

    The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.


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

    ShortThe language that is used in the item descriptionValue of extension
    Control0..1
    BindingThe codes SHALL be taken from For codes, see R5LanguagesForR4 (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-languages-for-R4|0.1.0)

    Description languages.

    Typecode, 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, 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
    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()))
    10. Extension.extension:description
    Slice Namedescription
    Definition

    R5: InventoryItem.description.description (new:string)

    ShortR5: Textual description of the item (new)Additional content defined by implementations
    Comments

    Element InventoryItem.description.description is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.description 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 InventoryItem.description.description is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.description 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())
    12. Extension.extension:description.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 Valuedescription
    14. Extension.extension:description.value[x]
    Definition

    Textual description of the item.


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

    ShortTextual description of the itemValue of extension
    Control0..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
    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()))
    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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-InventoryItem.description
    18. Extension.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()))

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

    0. Extension
    Definition

    R5: InventoryItem.description (new:BackboneElement)

    ShortR5: Descriptive characteristics of the item (new)
    Comments

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

    Control0..1
    Is Modifierfalse
    2. Extension.extension
    Control0..*
    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:language
      Slice Namelanguage
      Definition

      R5: InventoryItem.description.language (new:code)

      ShortR5: The language that is used in the item description (new)
      Comments

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

      Control0..1
      Requirements

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

      6. Extension.extension:language.url
      Control1..1
      Fixed Valuelanguage
      8. Extension.extension:language.value[x]
      Definition

      The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.

      ShortThe language that is used in the item description
      Control0..1
      BindingThe codes SHALL be taken from R5LanguagesForR4 (0.1.0)
      (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-languages-for-R4|0.1.0)

      Description languages.

      Typecode
      [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
      10. Extension.extension:description
      Slice Namedescription
      Definition

      R5: InventoryItem.description.description (new:string)

      ShortR5: Textual description of the item (new)
      Comments

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

      Control0..1
      Requirements

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

      12. Extension.extension:description.url
      Control1..1
      Fixed Valuedescription
      14. Extension.extension:description.value[x]
      Definition

      Textual description of the item.

      ShortTextual description of the item
      Control0..1
      Typestring
      [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/5.0/StructureDefinition/extension-InventoryItem.description
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: InventoryItem.description (new:BackboneElement)

      ShortR5: Descriptive characteristics of the item (new)
      Comments

      Element InventoryItem.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description 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
      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())
      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.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:language
        Slice Namelanguage
        Definition

        R5: InventoryItem.description.language (new:code)

        ShortR5: The language that is used in the item description (new)
        Comments

        Element InventoryItem.description.language is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.language is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.language 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 InventoryItem.description.language is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.language is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.language 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())
        8. Extension.extension:language.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
        10. Extension.extension:language.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:language.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 Valuelanguage
          14. Extension.extension:language.value[x]
          Definition

          The language for the item description, when an item must be described in different languages and those languages may be authoritative and not translations of a 'main' language.

          ShortThe language that is used in the item description
          Control0..1
          BindingThe codes SHALL be taken from R5LanguagesForR4 (0.1.0)
          (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-languages-for-R4|0.1.0)

          Description languages.

          Typecode
          [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()))
          16. Extension.extension:description
          Slice Namedescription
          Definition

          R5: InventoryItem.description.description (new:string)

          ShortR5: Textual description of the item (new)
          Comments

          Element InventoryItem.description.description is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.description 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 InventoryItem.description.description is part of an existing definition because parent element InventoryItem.description requires a cross-version extension. Element InventoryItem.description.description is not mapped to FHIR R4, since FHIR R5 InventoryItem is not mapped. Element InventoryItem.description.description 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())
          18. Extension.extension:description.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. Extension.extension:description.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:description.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 Valuedescription
            24. Extension.extension:description.value[x]
            Definition

            Textual description of the item.

            ShortTextual description of the item
            Control0..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
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            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
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-InventoryItem.description
            28. Extension.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()))