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: ExtensionDataRequirement_ValueFilter - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-DataRequirement.valueFilter extension.

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

0. Extension
Definition

R5: DataRequirement.valueFilter (new:Element)


Optional Extension Element - found in all resources.

ShortR5: What values are expected (new)Optional Extensions Element
Comments

Element DataRequirement.valueFilter has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter 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
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:path
    Slice Namepath
    Definition

    R5: DataRequirement.valueFilter.path (new:string)

    ShortR5: An attribute to filter on (new)Additional content defined by implementations
    Comments

    Element DataRequirement.valueFilter.path is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.path has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.path has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element DataRequirement.valueFilter.path is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.path has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.path 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:path.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 Valuepath
    8. Extension.extension:path.value[x]
    Definition

    The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.


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

    ShortAn attribute to filter onValue of extension
    Comments

    The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

    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()))
    10. Extension.extension:searchParam
    Slice NamesearchParam
    Definition

    R5: DataRequirement.valueFilter.searchParam (new:string)

    ShortR5: A parameter to search on (new)Additional content defined by implementations
    Comments

    Element DataRequirement.valueFilter.searchParam is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.searchParam has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.searchParam 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 DataRequirement.valueFilter.searchParam is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.searchParam has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.searchParam 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:searchParam.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 ValuesearchParam
    14. Extension.extension:searchParam.value[x]
    Definition

    A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.


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

    ShortA parameter to search onValue 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.extension:comparator
    Slice Namecomparator
    Definition

    R5: DataRequirement.valueFilter.comparator (new:code)

    ShortR5: eq | gt | lt | ge | le | sa | eb (new)Additional content defined by implementations
    Comments

    Element DataRequirement.valueFilter.comparator is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.comparator has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.comparator 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 DataRequirement.valueFilter.comparator is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.comparator has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.comparator 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())
    18. Extension.extension:comparator.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 Valuecomparator
    20. Extension.extension:comparator.value[x]
    Definition

    The comparator to be used to determine whether the value is matching.


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

    Shorteq | gt | lt | ge | le | sa | ebValue of extension
    Control0..1
    BindingThe codes SHALL be taken from For codes, see R5ValueFilterComparatorForR4 (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-value-filter-comparator-for-R4|0.1.0)

    Possible comparators for the valueFilter element.

    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()))
    22. Extension.extension:value
    Slice Namevalue
    Definition

    R5: DataRequirement.valueFilter.value[x] (new:dateTime, Duration, Period)

    ShortR5: The value of the filter, as a Period, DateTime, or Duration value (new)Additional content defined by implementations
    Comments

    Element DataRequirement.valueFilter.value[x] is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.value[x] has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.value[x] 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 DataRequirement.valueFilter.value[x] is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.value[x] has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.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())
    24. 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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuevalue
    26. Extension.extension:value.value[x]
    Definition

    The value of the filter.


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

    ShortThe value of the filter, as a Period, DateTime, or Duration valueValue of extension
    Control0..1
    TypeChoice of: dateTime, Period, Duration, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, 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
    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()))
    28. 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-DataRequirement.valueFilter
    30. 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: DataRequirement.valueFilter (new:Element)

    ShortR5: What values are expected (new)
    Comments

    Element DataRequirement.valueFilter has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter has no mapping targets in FHIR R4. 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:path
      Slice Namepath
      Definition

      R5: DataRequirement.valueFilter.path (new:string)

      ShortR5: An attribute to filter on (new)
      Comments

      Element DataRequirement.valueFilter.path is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.path has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.path has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

      Control0..1
      Requirements

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

      6. Extension.extension:path.url
      Control1..1
      Fixed Valuepath
      8. Extension.extension:path.value[x]
      Definition

      The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.

      ShortAn attribute to filter on
      Comments

      The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

      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
      10. Extension.extension:searchParam
      Slice NamesearchParam
      Definition

      R5: DataRequirement.valueFilter.searchParam (new:string)

      ShortR5: A parameter to search on (new)
      Comments

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

      Control0..1
      Requirements

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

      12. Extension.extension:searchParam.url
      Control1..1
      Fixed ValuesearchParam
      14. Extension.extension:searchParam.value[x]
      Definition

      A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.

      ShortA parameter to search on
      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.extension:comparator
      Slice Namecomparator
      Definition

      R5: DataRequirement.valueFilter.comparator (new:code)

      ShortR5: eq | gt | lt | ge | le | sa | eb (new)
      Comments

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

      Control0..1
      Requirements

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

      18. Extension.extension:comparator.url
      Control1..1
      Fixed Valuecomparator
      20. Extension.extension:comparator.value[x]
      Definition

      The comparator to be used to determine whether the value is matching.

      Shorteq | gt | lt | ge | le | sa | eb
      Control0..1
      BindingThe codes SHALL be taken from R5ValueFilterComparatorForR4 (0.1.0)
      (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-value-filter-comparator-for-R4|0.1.0)

      Possible comparators for the valueFilter element.

      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
      22. Extension.extension:value
      Slice Namevalue
      Definition

      R5: DataRequirement.valueFilter.value[x] (new:dateTime, Duration, Period)

      ShortR5: The value of the filter, as a Period, DateTime, or Duration value (new)
      Comments

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

      Control0..1
      Requirements

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

      24. Extension.extension:value.url
      Control1..1
      Fixed Valuevalue
      26. Extension.extension:value.value[x]
      Definition

      The value of the filter.

      ShortThe value of the filter, as a Period, DateTime, or Duration value
      Control0..1
      TypeChoice of: dateTime, Period, Duration
      [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
      28. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-DataRequirement.valueFilter
      30. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: DataRequirement.valueFilter (new:Element)

      ShortR5: What values are expected (new)
      Comments

      Element DataRequirement.valueFilter has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter 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
      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:path
        Slice Namepath
        Definition

        R5: DataRequirement.valueFilter.path (new:string)

        ShortR5: An attribute to filter on (new)
        Comments

        Element DataRequirement.valueFilter.path is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.path has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.path has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

        Control0..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element DataRequirement.valueFilter.path is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.path has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.path 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:path.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:path.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:path.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 Valuepath
          14. Extension.extension:path.value[x]
          Definition

          The attribute of the filter. The specified path SHALL be a FHIRPath resolvable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of a type that is comparable to the valueFilter.value[x] element for the filter.

          ShortAn attribute to filter on
          Comments

          The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

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

          R5: DataRequirement.valueFilter.searchParam (new:string)

          ShortR5: A parameter to search on (new)
          Comments

          Element DataRequirement.valueFilter.searchParam is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.searchParam has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.searchParam 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 DataRequirement.valueFilter.searchParam is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.searchParam has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.searchParam 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:searchParam.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:searchParam.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:searchParam.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 ValuesearchParam
            24. Extension.extension:searchParam.value[x]
            Definition

            A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter.

            ShortA parameter to search on
            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.extension:comparator
            Slice Namecomparator
            Definition

            R5: DataRequirement.valueFilter.comparator (new:code)

            ShortR5: eq | gt | lt | ge | le | sa | eb (new)
            Comments

            Element DataRequirement.valueFilter.comparator is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.comparator has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.comparator 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 DataRequirement.valueFilter.comparator is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.comparator has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.comparator 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())
            28. Extension.extension:comparator.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. Extension.extension:comparator.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
            • 32. Extension.extension:comparator.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 Valuecomparator
              34. Extension.extension:comparator.value[x]
              Definition

              The comparator to be used to determine whether the value is matching.

              Shorteq | gt | lt | ge | le | sa | eb
              Control0..1
              BindingThe codes SHALL be taken from R5ValueFilterComparatorForR4 (0.1.0)
              (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-value-filter-comparator-for-R4|0.1.0)

              Possible comparators for the valueFilter element.

              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()))
              36. Extension.extension:value
              Slice Namevalue
              Definition

              R5: DataRequirement.valueFilter.value[x] (new:dateTime, Duration, Period)

              ShortR5: The value of the filter, as a Period, DateTime, or Duration value (new)
              Comments

              Element DataRequirement.valueFilter.value[x] is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.value[x] has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.value[x] 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 DataRequirement.valueFilter.value[x] is part of an existing definition because parent element DataRequirement.valueFilter requires a cross-version extension. Element DataRequirement.valueFilter.value[x] has a context of DataRequirement based on following the parent source element upwards and mapping to DataRequirement. Element DataRequirement.valueFilter.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())
              38. 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.

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

                The value of the filter.

                ShortThe value of the filter, as a Period, DateTime, or Duration value
                Control0..1
                TypeChoice of: dateTime, Period, Duration
                [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()))
                46. 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-DataRequirement.valueFilter
                48. 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()))