Data Model Libraries
    Preparing search index...

    Class DataRequirementValueFilterComponent

    DataRequirementValueFilterComponent Class

    FHIR Specification

    • Short: What values are expected
    • Definition: Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed).

    Hierarchy (View Summary)

    • DataType
      • DataRequirementValueFilterComponent

    Implements

    Index

    Constructors

    Properties

    path?: StringType

    DataRequirement.valueFilter.path Element

    FHIR Specification

    • Short: An attribute to filter on
    • 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.
    • Comment: The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    searchParam?: StringType

    DataRequirement.valueFilter.searchParam Element

    FHIR Specification

    • Short: A parameter to search on
    • 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    searchComparatorEnum: SearchComparatorEnum

    FHIR CodeSystem: SearchComparator

    comparator?: EnumCodeType

    DataRequirement.valueFilter.comparator Element

    FHIR Specification

    • Short: eq | gt | lt | ge | le | sa | eb
    • Definition: The comparator to be used to determine whether the value is matching.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SearchComparatorEnum

    value?: IDataType

    DataRequirement.valueFilter.value[x] Element

    @ChoiceDataTypesMeta('DataRequirement.valueFilter.value[x]', ['dateTime','Period','Duration',]

    FHIR Specification

    • Short: The value of the filter, as a Period, DateTime, or Duration value
    • Definition: The value of the filter.
    • FHIR Types: 'dateTime', 'Period', 'Duration',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided DataRequirementValueFilterComponent JSON to instantiate the DataRequirementValueFilterComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR DataRequirementValueFilterComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to DataRequirementValueFilterComponent

      Returns undefined | DataRequirementValueFilterComponent

      DataRequirementValueFilterComponent data model or undefined for DataRequirementValueFilterComponent

      JsonError if the provided JSON is not a valid JSON object

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise