Skip to main content

ValuesetItemSearchInput

Search criteria and pagination parameters for filtering value set items across multiple value sets

input ValuesetItemSearchInput {
  page: Int
  offset: Int
  ids: [Int!]
  valuesetIds: [Int!]
  values: [String!]
  extras: [String!]
  sortInputs: [ValuesetItemSortInput!]
  term: String
  termFields: [ValuesetItemTermField!]
  termLanguages: [String!]
}

Fields​

ValuesetItemSearchInput.page ● Int scalar​

Page number for pagination, starting from 1. Used to navigate through multiple pages of results when the total number of items exceeds the offset limit. Must be a positive integer (minimum: 1).

ValuesetItemSearchInput.offset ● Int scalar​

Number of value set items to return per page. Controls the size of each page in the paginated response to manage data volume and performance. Must be between 1 and 100 items per page.

ValuesetItemSearchInput.ids ● [Int!] list scalar​

Filter by specific value set item identifiers. Provide an array of numeric IDs to retrieve only those specific items, useful for bulk operations or targeted queries.

ValuesetItemSearchInput.valuesetIds ● [Int!] list scalar​

Filter items by their parent value set identifiers. Provide an array of value set IDs to retrieve items from specific value sets only, essential for dropdown population.

ValuesetItemSearchInput.values ● [String!] list scalar​

Filter items by their actual data values. Provide an array of value strings to find items with matching values, helpful for searching specific options in dropdown lists.

ValuesetItemSearchInput.extras ● [String!] list scalar​

Filter items by their extra metadata values. Provide an array of extra value strings to find items with matching additional data like codes or categories.

ValuesetItemSearchInput.sortInputs ● [ValuesetItemSortInput!] list input​

Sorting criteria for organizing search results. Supports multiple sort fields with different orders to achieve complex result organization for dropdown displays.

ValuesetItemSearchInput.term ● String scalar​

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").

ValuesetItemSearchInput.termFields ● [ValuesetItemTermField!] list enum​

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.

ValuesetItemSearchInput.termLanguages ● [String!] list scalar​

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.

Member Of​

valuesetItems query