Data Model Libraries
    Preparing search index...

    CodeSystemFilterComponent Class

    FHIR Specification

    • Short: Filter that can be used in a value set
    • Definition: A filter that can be used in a value set compose statement when selecting concepts using a filter.
    • Comment: Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    code: null | CodeType

    CodeSystem.filter.code Element

    FHIR Specification

    • Short: Code that identifies the filter
    • Definition: The code that identifies this filter when it is used as a filter in ValueSet.compose.include.filter.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    description?: StringType

    CodeSystem.filter.description Element

    FHIR Specification

    • Short: How or why the filter is used
    • Definition: A description of how or why the filter is used.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    filterOperatorEnum: FilterOperatorEnum

    FHIR CodeSystem: FilterOperator

    operator: null | EnumCodeType[]

    CodeSystem.filter.operator Element

    FHIR Specification

    • Short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists
    • Definition: A list of operators that can be used with the filter.
    • FHIR Type: code
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: FilterOperatorEnum

    value: null | StringType

    CodeSystem.filter.value Element

    FHIR Specification

    • Short: What to use for the value
    • Definition: A description of what the value for the filter should be.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeSystemFilterComponent

      • OptionaloptSourceField: string

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

      Returns undefined | CodeSystemFilterComponent

      CodeSystemFilterComponent data model or undefined for CodeSystemFilterComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • 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

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise