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

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

Extension: ExtensionMeasure_Term - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-Measure.term extension.

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

0. Extension
Definition

R5: Measure.term (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Defined terms used in the measure documentation (new)Optional Extensions Element
Comments

Element Measure.term has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term has no mapping targets in FHIR R4B. 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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
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:code
    Slice Namecode
    Definition

    R5: Measure.term.code (new:CodeableConcept)

    ShortR5: What term? (new)Additional content defined by implementations
    Comments

    Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. 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: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 Valuecode
    8. Extension.extension:code.value[x]
    Definition

    A codeable representation of the defined term.


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

    ShortWhat term?Value of extension
    Control0..1
    BindingFor example codes, see For codes, see R5MeasureDefinitionExampleForR4B (0.1.0)
    (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-measure-definition-example-for-R4B|0.1.0)

    Codeable representations of measure definition terms.

    TypeCodeableConcept, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, 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, CodeableReference, 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()))
    10. Extension.extension:definition
    Slice Namedefinition
    Definition

    R5: Measure.term.definition (new:markdown)

    ShortR5: Meaning of the term (new)Additional content defined by implementations
    Comments

    Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. 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:definition.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 Valuedefinition
    14. Extension.extension:definition.value[x]
    Definition

    Provides a definition for the term as used within the measure.


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

    ShortMeaning of the termValue of extension
    Control0..1
    Typemarkdown, date, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, 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-Measure.term
    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, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
    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: Measure.term (new:BackboneElement)

    ShortR5: Defined terms used in the measure documentation (new)
    Comments

    Element Measure.term has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

    Control0..*
    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:code
      Slice Namecode
      Definition

      R5: Measure.term.code (new:CodeableConcept)

      ShortR5: What term? (new)
      Comments

      Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:code.url
      Control1..1
      Fixed Valuecode
      8. Extension.extension:code.value[x]
      Definition

      A codeable representation of the defined term.

      ShortWhat term?
      Control0..1
      BindingFor example codes, see R5MeasureDefinitionExampleForR4B (0.1.0)
      (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-measure-definition-example-for-R4B|0.1.0)

      Codeable representations of measure definition terms.

      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:definition
      Slice Namedefinition
      Definition

      R5: Measure.term.definition (new:markdown)

      ShortR5: Meaning of the term (new)
      Comments

      Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:definition.url
      Control1..1
      Fixed Valuedefinition
      14. Extension.extension:definition.value[x]
      Definition

      Provides a definition for the term as used within the measure.

      ShortMeaning of the term
      Control0..1
      Typemarkdown
      [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-Measure.term
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: Measure.term (new:BackboneElement)

      ShortR5: Defined terms used in the measure documentation (new)
      Comments

      Element Measure.term has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term has no mapping targets in FHIR R4B. 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 unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
      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
      Typeid
      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:code
        Slice Namecode
        Definition

        R5: Measure.term.code (new:CodeableConcept)

        ShortR5: What term? (new)
        Comments

        Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element Measure.term.code is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.code has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.code has no mapping targets in FHIR R4B. 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: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
        Typeid
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:code.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: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 Valuecode
          14. Extension.extension:code.value[x]
          Definition

          A codeable representation of the defined term.

          ShortWhat term?
          Control0..1
          BindingFor example codes, see R5MeasureDefinitionExampleForR4B (0.1.0)
          (example to http://hl7.org/fhir/uv/xver/ValueSet/R5-measure-definition-example-for-R4B|0.1.0)

          Codeable representations of measure definition terms.

          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()))
          16. Extension.extension:definition
          Slice Namedefinition
          Definition

          R5: Measure.term.definition (new:markdown)

          ShortR5: Meaning of the term (new)
          Comments

          Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element Measure.term.definition is part of an existing definition because parent element Measure.term requires a cross-version extension. Element Measure.term.definition has a context of Measure based on following the parent source element upwards and mapping to Measure. Element Measure.term.definition has no mapping targets in FHIR R4B. 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:definition.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
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:definition.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:definition.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 Valuedefinition
            24. Extension.extension:definition.value[x]
            Definition

            Provides a definition for the term as used within the measure.

            ShortMeaning of the term
            Control0..1
            Typemarkdown
            [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-Measure.term
            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, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
            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()))