Class ValueSetComposeIncludeFilterComponent

ValueSetComposeIncludeFilterComponent Class

Remarks

FHIR Specification

Short: Select codes/concepts by their properties (including relationships)
Definition: Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.
Comment: Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.

See

FHIR ValueSet

Hierarchy (View Summary)

BackboneElement
- ValueSetComposeIncludeFilterComponent

Implements

IBackboneElement

Constructors

constructor

new ValueSetComposeIncludeFilterComponent(
    property?: null | string | CodeType,
    op?: null | string | CodeType | EnumCodeType,
    value?: null | string | StringType,
): ValueSetComposeIncludeFilterComponent
Parameters
- property: null | string | CodeType = null
- op: null | string | CodeType | EnumCodeType = null
- value: null | string | StringType = null
Returns ValueSetComposeIncludeFilterComponent
Overrides BackboneElement.constructor
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:3876

Properties

`Private`property

property: null | CodeType

ValueSet.compose.include.filter.property Element

Remarks

FHIR Specification

Short: A property/filter defined by the code system
Definition: A code that identifies a property or a filter defined in the code system.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Readonly`filterOperatorEnum

filterOperatorEnum: FilterOperatorEnum

FHIR CodeSystem: FilterOperator

See

FilterOperatorEnum

`Private`op

op: null | EnumCodeType

ValueSet.compose.include.filter.op Element

Remarks

FHIR Specification

Short: = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Definition: The kind of operation to perform as a part of the filter criteria.
Comment: In case filter.property represents a property of the system, the operation applies to the selected property. In case filter.property represents a filter of the system, the operation SHALL match one of the CodeSystem.filter.operator values.
FHIR Type: code
Cardinality: 1..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: FilterOperatorEnum

`Private`value

value: null | StringType

ValueSet.compose.include.filter.value Element

Remarks

FHIR Specification

Short: Code from the system, or regex criteria, or boolean value for exists
Definition: The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.
Comment: Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.
FHIR Type: string
Cardinality: 1..1
isModifier: false
isSummary: true

Methods

`Static`parse

parse(
sourceJson: Value,
optSourceField?: string,
): undefined | ValueSetComposeIncludeFilterComponent
Parse the provided ValueSetComposeIncludeFilterComponent JSON to instantiate the ValueSetComposeIncludeFilterComponent data model.
Parameters
- sourceJson: Value
  JSON representing FHIR ValueSetComposeIncludeFilterComponent
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ValueSetComposeIncludeFilterComponent
Returns undefined | ValueSetComposeIncludeFilterComponent
ValueSetComposeIncludeFilterComponent data model or undefined for ValueSetComposeIncludeFilterComponent

Throws
JsonError if the provided JSON is not a valid JSON object
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:3915

getPropertyElement

getPropertyElement(): CodeType
Returns CodeType
the property property value as a CodeType object if defined; else an empty CodeType object
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4037

setPropertyElement

setPropertyElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the property property.
Parameters
- element: undefined | null | CodeType
  the property value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4049

hasPropertyElement

hasPropertyElement(): boolean
Returns boolean
true if the property property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4063

getProperty

getProperty(): null | string
Returns null | string
the property property value as a fhirCode if defined; else null
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4070

setProperty

setProperty(value: undefined | null | string): this
Assigns the provided primitive value to the property property.
Parameters
- value: undefined | null | string
  the property value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4085

hasProperty

hasProperty(): boolean
Returns boolean
true if the property property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4098

getOpEnumType

getOpEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the op property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4107

setOpEnumType

setOpEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the op property.
Parameters
- enumType: undefined | null | EnumCodeType
  the op value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4121

hasOpEnumType

hasOpEnumType(): boolean
Returns boolean
true if the op property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4135

getOpElement

getOpElement(): null | CodeType
Returns null | CodeType
the op property value as a CodeType if defined; else null

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4144

setOpElement

setOpElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the op property.
Parameters
- element: undefined | null | CodeType
  the op value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4161

hasOpElement

hasOpElement(): boolean
Returns boolean
true if the op property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4175

getOp

getOp(): null | string
Returns null | string
the op property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4184

setOp

setOp(value: undefined | null | string): this
Assigns the provided primitive value to the op property.
Parameters
- value: undefined | null | string
  the op value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: FilterOperatorEnum
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4201

hasOp

hasOp(): boolean
Returns boolean
true if the op property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4214

getValueElement

getValueElement(): StringType
Returns StringType
the value property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4221

setValueElement

setValueElement(element: undefined | null | StringType): this
Assigns the provided PrimitiveType value to the value property.
Parameters
- element: undefined | null | StringType
  the value value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4233

hasValueElement

hasValueElement(): boolean
Returns boolean
true if the value property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4247

getValue

getValue(): null | string
Returns null | string
the value property value as a fhirString if defined; else null
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4254

setValue

setValue(value: undefined | null | string): this
Assigns the provided primitive value to the value property.
Parameters
- value: undefined | null | string
  the value value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4269

hasValue

hasValue(): boolean
Returns boolean
true if the value property exists and has a value; false otherwise
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4282

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IBackboneElement.fhirType
Overrides BackboneElement.fhirType
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4291

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IBackboneElement.isEmpty
Overrides BackboneElement.isEmpty
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4298

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
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
Implementation of IBackboneElement.isRequiredFieldsEmpty
Overrides BackboneElement.isRequiredFieldsEmpty
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4310

copy

copy(): ValueSetComposeIncludeFilterComponent
Creates a copy of the current instance.

Returns ValueSetComposeIncludeFilterComponent
the a new instance copied from the current instance
Implementation of IBackboneElement.copy
Overrides BackboneElement.copy
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4321

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IBackboneElement.toJSON
Overrides BackboneElement.toJSON
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4343

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IBackboneElement.getModifierExtension
Inherited from BackboneElement.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:195

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setModifierExtension
Inherited from BackboneElement.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:202

hasModifierExtension

hasModifierExtension(url?: string): boolean
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasModifierExtension
Inherited from BackboneElement.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:214

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getModifierExtensionByUrl
Inherited from BackboneElement.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:222

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IBackboneElement.addModifierExtension
Inherited from BackboneElement.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:229

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeModifierExtension
Inherited from BackboneElement.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:236

getId

getId(): undefined | string
Returns undefined | string
the id property value
Implementation of IBackboneElement.getId
Inherited from BackboneElement.getId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:59

setId

setId(value: undefined | string): this
Assigns the provided value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid value
Implementation of IBackboneElement.setId
Inherited from BackboneElement.setId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:67

hasId

hasId(): boolean
Returns boolean
true if id exists and has a value; false otherwise
Implementation of IBackboneElement.hasId
Inherited from BackboneElement.hasId
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:71

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IBackboneElement.getExtension
Inherited from BackboneElement.getExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:75

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IBackboneElement.setExtension
Inherited from BackboneElement.setExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:82

hasExtension

hasExtension(url?: string): boolean
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.hasExtension
Inherited from BackboneElement.hasExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:94

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
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

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IBackboneElement.getExtensionByUrl
Inherited from BackboneElement.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:106

addExtension

addExtension(extension: undefined | IExtension): this
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
Implementation of IBackboneElement.addExtension
Inherited from BackboneElement.addExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:113

removeExtension

removeExtension(url: string): void
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
Throws
AssertionError for invalid url
Implementation of IBackboneElement.removeExtension
Inherited from BackboneElement.removeExtension
- Defined in packages/fhir-core/lib/base-models/core-fhir-models.d.ts:120

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IBackboneElement.isResource
Inherited from BackboneElement.isResource
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:67

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IBackboneElement.isDataType
Inherited from BackboneElement.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IBackboneElement.isComplexDataType
Inherited from BackboneElement.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IBackboneElement.isPrimitive
Inherited from BackboneElement.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IBackboneElement.isBooleanPrimitive
Inherited from BackboneElement.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IBackboneElement.isStringPrimitive
Inherited from BackboneElement.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IBackboneElement.isNumberPrimitive
Inherited from BackboneElement.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IBackboneElement.isBigIntPrimitive
Inherited from BackboneElement.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IBackboneElement.isDateTimePrimitive
Inherited from BackboneElement.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: ValueSetComposeIncludeFilterComponent): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: ValueSetComposeIncludeFilterComponent
  the copied instance
Returns void
Overrides BackboneElement.copyValues
- Defined in packages/r4-datamodels/src/resources/ValueSet.ts:4333

Class ValueSetComposeIncludeFilterComponent

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValueSetComposeIncludeFilterComponent

Properties

Privateproperty

Remarks

Private ReadonlyfilterOperatorEnum

See

Privateop

Remarks

See

Privatevalue

Remarks

Methods

Staticparse

Parameters

Returns undefined | ValueSetComposeIncludeFilterComponent

Throws

getPropertyElement

Returns CodeType

setPropertyElement

Parameters

Returns this

Throws

Throws

hasPropertyElement

Returns boolean

getProperty

Returns null | string

setProperty

Parameters

Returns this

Throws

hasProperty

Returns boolean

getOpEnumType

Returns null | EnumCodeType

See

setOpEnumType

Parameters

Returns this

Throws

Throws

See

hasOpEnumType

Returns boolean

getOpElement

Returns null | CodeType

See

setOpElement

Parameters

Returns this

Throws

Throws

See

hasOpElement

Returns boolean

getOp

Returns null | string

See

setOp

Parameters

Returns this

Throws

Throws

See

hasOp

Returns boolean

getValueElement

Returns StringType

`Private`property

`Private` `Readonly`filterOperatorEnum

`Private`op

`Private`value

`Static`parse