FHIR Extensions Pack
5.1.0-ballot1 - Ballot for Release 5.1.0 International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-ballot: Releases Ballot 4) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: Value Filter

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-valueFilter Version: 5.1.0-ballot1
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Clinical Decision Support Computable Name: ValueFilter

Allows additional value-based filters to be specified as part of a data requirement.

Context of Use

This extension may be used on the following element(s):

  • Element ID DataRequirement

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: Allows additional value-based filters to be specified as part of a data requirement.

    • path: string: An Extension
    • searchParam: string: An Extension
    • comparator: code: An Extension
    • value: boolean, string, integer, Quantity, Ratio, Range: An Extension

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionExtension
    ... extension:path 0..1ExtensionExtension
    .... url 1..1uri"path"
    .... value[x] 0..1stringValue of extension
    ... extension:searchParam 0..1ExtensionExtension
    .... url 1..1uri"searchParam"
    .... value[x] 0..1stringValue of extension
    ... extension:comparator 1..1ExtensionExtension
    .... url 1..1uri"comparator"
    .... value[x] 0..1codeValue of extension
    Binding: ValueFilterComparator (required): The comparator operator to use

    .... url 1..1uri"value"
    .... value[x] 0..1Value of extension
    ..... valueBooleanboolean
    ..... valueStringstring
    ..... valueIntegerinteger
    ..... valueQuantityQuantity
    ..... valueRatioRatio
    ..... valueRangeRange
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-valueFilter"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionExtension
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 1..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:path 0..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"path"
    .... value[x] 0..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"searchParam"
    .... value[x] 0..1stringValue of extension
    ... extension:comparator 1..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"comparator"
    .... value[x] 0..1codeValue of extension
    Binding: ValueFilterComparator (required): The comparator operator to use

    ... extension:value 0..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"value"
    .... value[x] 0..1Value of extension
    ..... valueBooleanboolean
    ..... valueStringstring
    ..... valueIntegerinteger
    ..... valueQuantityQuantity
    ..... valueRatioRatio
    ..... valueRangeRange
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-valueFilter"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Allows additional value-based filters to be specified as part of a data requirement.

    • path: string: An Extension
    • searchParam: string: An Extension
    • comparator: code: An Extension
    • value: boolean, string, integer, Quantity, Ratio, Range: An Extension

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionExtension
    ... extension:path 0..1ExtensionExtension
    .... url 1..1uri"path"
    .... value[x] 0..1stringValue of extension
    ... extension:searchParam 0..1ExtensionExtension
    .... url 1..1uri"searchParam"
    .... value[x] 0..1stringValue of extension
    ... extension:comparator 1..1ExtensionExtension
    .... url 1..1uri"comparator"
    .... value[x] 0..1codeValue of extension
    Binding: ValueFilterComparator (required): The comparator operator to use

    .... url 1..1uri"value"
    .... value[x] 0..1Value of extension
    ..... valueBooleanboolean
    ..... valueStringstring
    ..... valueIntegerinteger
    ..... valueQuantityQuantity
    ..... valueRatioRatio
    ..... valueRangeRange
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-valueFilter"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionExtension
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 1..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:path 0..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"path"
    .... value[x] 0..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"searchParam"
    .... value[x] 0..1stringValue of extension
    ... extension:comparator 1..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"comparator"
    .... value[x] 0..1codeValue of extension
    Binding: ValueFilterComparator (required): The comparator operator to use

    ... extension:value 0..1ExtensionExtension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... url 1..1uri"value"
    .... value[x] 0..1Value of extension
    ..... valueBooleanboolean
    ..... valueStringstring
    ..... valueIntegerinteger
    ..... valueQuantityQuantity
    ..... valueRatioRatio
    ..... valueRangeRange
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-valueFilter"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSet
    Extension.extension:comparator.value[x]requiredValueFilterComparator

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)