Skip to main content

Interface: ValuesetItemSearchInput

Defined in: type/ValuesetItemSearchInput.ts:6

Input object for ValuesetItemSearchInput

Properties​

extras?​

optional extras?: string[]

Defined in: type/ValuesetItemSearchInput.ts:18

Search by extra values

ids?​

optional ids?: number[]

Defined in: type/ValuesetItemSearchInput.ts:12

Search by valueset item ids

offset?​

optional offset?: number

Defined in: type/ValuesetItemSearchInput.ts:10

Pagination offset number. [Default to 12]

page?​

optional page?: number

Defined in: type/ValuesetItemSearchInput.ts:8

Pagination page number. [Default to 1]

sortInputs?​

optional sortInputs?: ValuesetItemSortInput[]

Defined in: type/ValuesetItemSearchInput.ts:20

Inputs to sort by

term?​

optional term?: string

Defined in: type/ValuesetItemSearchInput.ts:25

Free-text search term to filter by.

Performs a case-insensitive partial-match search across value set item fields. Use this to find items that match a specific keyword or phrase (e.g. "Nether" to match the description "Netherlands").

termFields?​

optional termFields?: ValuesetItemTermField[]

Defined in: type/ValuesetItemSearchInput.ts:29

Fields to search in when using the term filter.

Specifies which fields should be included in the full-text search when a term is provided. Defaults to searching in all fields. Array must contain unique values and be non-empty when provided.

termLanguages?​

optional termLanguages?: string[]

Defined in: type/ValuesetItemSearchInput.ts:33

Languages to search in when using the term filter.

Specifies which languages should be included in the full-text search when a term is provided. All languages are included by default. Array must contain unique values and be non-empty when provided.

values?​

optional values?: string[]

Defined in: type/ValuesetItemSearchInput.ts:16

Search by values

valuesetIds?​

optional valuesetIds?: number[]

Defined in: type/ValuesetItemSearchInput.ts:14

Search by valueset ids