---
title: "List Search Parameters"
method: GET
path: "/main/SearchParameter"
tags: ["SearchParameter"]
---

# List Search Parameters

`GET /main/SearchParameter`

Retrieves a collection of search parameters that the server can handle

## Query parameters

- `page` integer
- `_count` integer
- `pagination` boolean

## Response `200`

SearchParameter collection

- SearchParameter[]
  - `url` string, nullable — Canonical identifier for this capability statement, represented as a URI (globally unique)
  - `version` string — Business version of the search parameter
  - `name` string — Name for this search parameter (computer friendly)
  - `status` 'draft' | 'active' | 'retired' | 'unknown' — draft | active | retired | unknown
  - `experimental` boolean — For testing purposes, not real usage
  - `date` string, date-time — Date last changed
  - `publisher` string — Name of the publisher (organization or individual)
  - `contact` FhirContactDetail[] — Contact details for the publisher
    - `name` string — Name of an individual to contact
    - `telecom` FhirContactPoint[] — Contact details for individual or organization
      - `system` 'phone' | 'fax' | 'email' | 'sms' | 'null', nullable — Type of contact detail
      - `value` string, nullable — The actual phone number or email address
      - `use` 'home' | 'work' | 'mobile' | 'null', nullable — Purpose of the contact detail
      - `id` string, nullable — ID of the FHIR element (optional)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `description` string, nullable — Natural language description of the search parameter
  - `jurisdiction` FhirCodeableConcept[] — Intended jurisdiction for search parameter (if applicable)
    - `coding` FhirCoding[] — defined by a terminology system
      - `system` string, uri, nullable — Identity of the terminology system
      - `code` string, nullable — Symbol in syntax defined by the system
      - `display` string, nullable — Representation defined by the system
      - `userSelected` boolean, nullable — If this coding was chosen directly by the user
      - `id` string, nullable — ID of the FHIR element (optional)
    - `text` string, nullable — Plain text representation of the concept
    - `id` string, nullable — ID of the FHIR element (optional)
  - `purpose` string — Why this search parameter is defined
  - `code` string — Code used in URL
  - `base` string[] — The resource type(s) this search parameter applies to
  - `type` 'number' | 'date' | 'string' | 'token' | 'reference' | 'composite' | 'quantity' | 'uri' | 'special' — number | date | string | token | reference | composite | quantity | uri | special
  - `expression` string — FHIRPath expression that extracts the values
  - `xpath` string — XPath that extracts the values
  - `xpathUsage` string — normal | phonetic | nearby | distance | other
  - `target` string[] — Types of resource (if a resource reference)
  - `multipleOr` boolean — Allow multiple values per parameter (or)
  - `multipleAnd` boolean — Allow multiple parameters (and)
  - `comparator` string[] — eq | ne | gt | lt | ge | le | sa | eb | ap
  - `modifier` string[] — missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  - `chain` string[] — Chained names supported
  - `text` FhirNarrative
    - `status` 'generated' | 'extensions' | 'additional' | 'empty' — Describes how the narrative was generated
    - `div` string — Limited xhtml content
    - `id` string, nullable — ID of the FHIR element (optional)
  - `contained` AbstractFhirResource[] — Contained, inline Resources
    - `id` string, nullable — Logical id of this artifact
    - `meta` FhirResourceMeta
      - `lastUpdated` string, date-time, nullable — When the resource version last changed
      - `profile` string[] — Profiles this resource claims to conform to
    - `resourceType` string, nullable — Resource Type
  - `id` string, nullable — Logical id of this artifact
  - `meta` FhirResourceMeta
    - `lastUpdated` string, date-time, nullable — When the resource version last changed
    - `profile` string[] — Profiles this resource claims to conform to
  - `resourceType` string, nullable — Resource Type

---

[API](https://skmtc.dev/halaxy/apis/halaxy-api.md) · [All operations](https://skmtc.dev/halaxy/apis/halaxy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/halaxy/halaxy-api/revisions/d72139daaa89/schema)