Halaxy

Halaxy Search Parameter API

The Search Parameter API from Halaxy — 1 operation(s) for search parameter.

GitHub OpenAPI

Operations 1

GET /main/SearchParameter List Search Parameters #

Documentation

📖
Documentation
https://developers.halaxy.com/docs/about-this-guide
📖
APIReference
https://developers.halaxy.com/reference/patient
📖
Authentication
https://developers.halaxy.com/docs/authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/halaxy/openapi/halaxy-search-parameter-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-search-parameter-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-capability-statement-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-jsonfhir-schema.json
📊
JSONSchema
https://artifacts.apis.io/halaxy/json-schema/halaxy-referral-schema.json

Other Resources

🔗
Webhooks
https://developers.halaxy.com/docs/webhooks

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/halaxy:halaxy-search-parameter-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

halaxy-search-parameter-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Halaxy Search Parameter API
  description: A FHIR API for Halaxy based on R4 of the FHIR specification
  termsOfService: https://www.halaxy.com/article/terms/practitioner
  contact:
    name: Halaxy Developers
    url: https://www.halaxy.com
    email: community@halaxy.com
  version: '1.104'
servers:
- url: https://au-api.halaxy.com
  description: Production AU
- url: https://eu-api.halaxy.com
  description: Production EU
security:
- oauth: []
tags:
- name: Search Parameter
paths:
  /main/SearchParameter:
    get:
      operationId: findSearchParameters
      tags:
      - Search Parameter
      responses:
        '200':
          description: SearchParameter collection
          content:
            application/fhir+json:
              schema:
                type: object
                readOnly: true
                properties:
                  resourceType:
                    type: string
                    readOnly: true
                    enum:
                    - Bundle
                    default: Bundle
                  timestamp:
                    type: string
                    readOnly: true
                    format: date-time
                  type:
                    type: string
                    readOnly: true
                    enum:
                    - searchset
                    default: searchset
                  entry:
                    type: array
                    items:
                      type: object
                      properties:
                        fullUrl:
                          type: string
                          format: iri-reference
                        resource:
                          type: array
                          items:
                            $ref: '#/components/schemas/SearchParameter.jsonfhir'
                        search:
                          type: object
                          properties:
                            mode:
                              type: string
                              enum:
                              - match
                              - include
                              - outcome
                  total:
                    type: integer
                    readOnly: true
                    minimum: 0
                  link:
                    type: array
                    readOnly: true
                    items:
                      type: object
                      properties:
                        relation:
                          type: string
                          readOnly: true
                          enum:
                          - self
                          - first
                          - last
                          - prev
                          - next
                        url:
                          type: string
                          readOnly: true
                          format: iri-reference
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SearchParameter'
      summary: List Search Parameters
      description: Retrieves a collection of search parameters that the server can handle
      parameters:
      - name: page
        in: query
        description: The collection page number
        required: false
        deprecated: false
        schema:
          type: integer
          default: 1
        style: form
        explode: false
      - name: _count
        in: query
        description: The number of items per page
        required: false
        deprecated: false
        schema:
          type: integer
          default: 30
          minimum: 0
        style: form
        explode: false
      - name: pagination
        in: query
        description: Enable or disable pagination
        required: false
        deprecated: false
        schema:
          type: boolean
        style: form
        explode: false
      deprecated: false
components:
  schemas:
    FhirResourceMeta.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        lastUpdated:
          readOnly: true
          description: When the resource version last changed
          type:
          - string
          - 'null'
          format: date-time
        profile:
          description: Profiles this resource claims to conform to
          type: array
          items:
            type: string
    FhirResourceInterface.jsonfhir:
      type: object
      description: ''
      deprecated: false
    SearchParameter:
      type: object
      description: A search parameter that defines a named search item that can be used to search/filter on a resource.
      deprecated: false
      properties:
        url:
          description: Canonical identifier for this capability statement, represented as a URI (globally unique)
          type:
          - string
          - 'null'
        version:
          description: Business version of the search parameter
          type: string
        name:
          description: Name for this search parameter (computer friendly)
          type: string
        status:
          description: draft | active | retired | unknown
          type: string
          enum:
          - draft
          - active
          - retired
          - unknown
        experimental:
          description: For testing purposes, not real usage
          type: boolean
        date:
          description: Date last changed
          type: string
          format: date-time
        publisher:
          description: Name of the publisher (organization or individual)
          type: string
        contact:
          description: Contact details for the publisher
          type: array
          items:
            $ref: '#/components/schemas/FhirContactDetail'
        description:
          description: Natural language description of the search parameter
          type:
          - string
          - 'null'
        jurisdiction:
          description: Intended jurisdiction for search parameter (if applicable)
          type: array
          items:
            $ref: '#/components/schemas/FhirCodeableConcept'
        purpose:
          description: Why this search parameter is defined
          type: string
        code:
          description: Code used in URL
          type: string
        base:
          description: The resource type(s) this search parameter applies to
          type: array
          items:
            type: string
            enum:
            - Organization
            - Patient
            - Practitioner
            - PractitionerRole
            - Appointment
            - Coverage
            - Invoice
            - Communication
            - Group
            - DocumentReference
            - InvoiceLine
            - PaymentTransaction
            - Referral
            - ReferralDefinition
            - Schedule
            - Slot
            - HealthcareService
            - AllergyIntolerance
            - Condition
            - Immunization
            - Subscription
            - SubscriptionTopic
            - ChargeItemDefinition
            - ServiceRequest
            - Medication
            - MedicationRequest
            - Questionnaire
            - QuestionnaireResponse
            - ValueSet
            - ValueSetConcept
            - Observation
            - Binary
            - Bundle
            - OperationOutcome
            - Parameters
            - List
        type:
          description: number | date | string | token | reference | composite | quantity | uri | special
          type: string
          enum:
          - number
          - date
          - string
          - token
          - reference
          - composite
          - quantity
          - uri
          - special
        expression:
          description: FHIRPath expression that extracts the values
          type: string
        xpath:
          description: XPath that extracts the values
          type: string
        xpathUsage:
          description: normal | phonetic | nearby | distance | other
          type: string
        target:
          description: Types of resource (if a resource reference)
          type: array
          items:
            type: string
            enum:
            - Organization
            - Patient
            - Practitioner
            - PractitionerRole
            - Appointment
            - Coverage
            - Invoice
            - Communication
            - Group
            - DocumentReference
            - InvoiceLine
            - PaymentTransaction
            - Referral
            - ReferralDefinition
            - Schedule
            - Slot
            - HealthcareService
            - AllergyIntolerance
            - Condition
            - Immunization
            - Subscription
            - SubscriptionTopic
            - ChargeItemDefinition
            - ServiceRequest
            - Medication
            - MedicationRequest
            - Questionnaire
            - QuestionnaireResponse
            - ValueSet
            - ValueSetConcept
            - Observation
            - Binary
            - Bundle
            - OperationOutcome
            - Parameters
            - List
        multipleOr:
          description: Allow multiple values per parameter (or)
          type: boolean
        multipleAnd:
          description: Allow multiple parameters (and)
          type: boolean
        comparator:
          description: eq | ne | gt | lt | ge | le | sa | eb | ap
          type: array
          items:
            type: string
            enum:
            - eq
            - ne
            - gt
            - lt
            - ge
            - le
            - sa
            - eb
            - ap
        modifier:
          description: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
          type: array
          items:
            type: string
            enum:
            - missing
            - exact
            - contains
            - not
            - text
            - in
            - notIn
            - below
            - above
            - type
            - identifier
            - ofType
            - iterate
        chain:
          description: Chained names supported
          type: array
          items:
            type: string
        text:
          readOnly: true
          description: Text summary of the resource, for human interpretation
          anyOf:
          - $ref: '#/components/schemas/FhirNarrative'
          - type: 'null'
        contained:
          readOnly: true
          description: Contained, inline Resources
          type: array
          items:
            $ref: '#/components/schemas/FhirResourceInterface'
        id:
          readOnly: true
          description: Logical id of this artifact
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    FhirNarrative.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        status:
          readOnly: true
          description: Describes how the narrative was generated
          type: string
          enum:
          - generated
          - extensions
          - additional
          - empty
        div:
          readOnly: true
          description: Limited xhtml content
          type: string
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirContactDetail.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        name:
          description: Name of an individual to contact
          type: string
        telecom:
          description: Contact details for individual or organization
          type: array
          items:
            $ref: '#/components/schemas/FhirContactPoint.jsonfhir'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCodeableConcept:
      type: object
      description: ''
      deprecated: false
      properties:
        coding:
          description: defined by a terminology system
          type: array
          items:
            $ref: '#/components/schemas/FhirCoding'
        text:
          description: Plain text representation of the concept
          type:
          - string
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirNarrative:
      type: object
      description: ''
      deprecated: false
      properties:
        status:
          readOnly: true
          description: Describes how the narrative was generated
          type: string
          enum:
          - generated
          - extensions
          - additional
          - empty
        div:
          readOnly: true
          description: Limited xhtml content
          type: string
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirContactDetail:
      type: object
      description: ''
      deprecated: false
      properties:
        name:
          description: Name of an individual to contact
          type: string
        telecom:
          description: Contact details for individual or organization
          type: array
          items:
            $ref: '#/components/schemas/FhirContactPoint'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCoding:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          format: uri
          description: Identity of the terminology system
          externalDocs:
            url: https://schema.org/url
          type:
          - string
          - 'null'
        code:
          description: Symbol in syntax defined by the system
          type:
          - string
          - 'null'
        display:
          description: Representation defined by the system
          type:
          - string
          - 'null'
        userSelected:
          readOnly: true
          description: If this coding was chosen directly by the user
          type:
          - boolean
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    SearchParameter.jsonfhir:
      type: object
      description: A search parameter that defines a named search item that can be used to search/filter on a resource.
      deprecated: false
      properties:
        url:
          description: Canonical identifier for this capability statement, represented as a URI (globally unique)
          type:
          - string
          - 'null'
        version:
          description: Business version of the search parameter
          type: string
        name:
          description: Name for this search parameter (computer friendly)
          type: string
        status:
          description: draft | active | retired | unknown
          type: string
          enum:
          - draft
          - active
          - retired
          - unknown
        experimental:
          description: For testing purposes, not real usage
          type: boolean
        date:
          description: Date last changed
          type: string
          format: date-time
        publisher:
          description: Name of the publisher (organization or individual)
          type: string
        contact:
          description: Contact details for the publisher
          type: array
          items:
            $ref: '#/components/schemas/FhirContactDetail.jsonfhir'
        description:
          description: Natural language description of the search parameter
          type:
          - string
          - 'null'
        jurisdiction:
          description: Intended jurisdiction for search parameter (if applicable)
          type: array
          items:
            $ref: '#/components/schemas/FhirCodeableConcept.jsonfhir'
        purpose:
          description: Why this search parameter is defined
          type: string
        code:
          description: Code used in URL
          type: string
        base:
          description: The resource type(s) this search parameter applies to
          type: array
          items:
            type: string
            enum:
            - Organization
            - Patient
            - Practitioner
            - PractitionerRole
            - Appointment
            - Coverage
            - Invoice
            - Communication
            - Group
            - DocumentReference
            - InvoiceLine
            - PaymentTransaction
            - Referral
            - ReferralDefinition
            - Schedule
            - Slot
            - HealthcareService
            - AllergyIntolerance
            - Condition
            - Immunization
            - Subscription
            - SubscriptionTopic
            - ChargeItemDefinition
            - ServiceRequest
            - Medication
            - MedicationRequest
            - Questionnaire
            - QuestionnaireResponse
            - ValueSet
            - ValueSetConcept
            - Observation
            - Binary
            - Bundle
            - OperationOutcome
            - Parameters
            - List
        type:
          description: number | date | string | token | reference | composite | quantity | uri | special
          type: string
          enum:
          - number
          - date
          - string
          - token
          - reference
          - composite
          - quantity
          - uri
          - special
        expression:
          description: FHIRPath expression that extracts the values
          type: string
        xpath:
          description: XPath that extracts the values
          type: string
        xpathUsage:
          description: normal | phonetic | nearby | distance | other
          type: string
        target:
          description: Types of resource (if a resource reference)
          type: array
          items:
            type: string
            enum:
            - Organization
            - Patient
            - Practitioner
            - PractitionerRole
            - Appointment
            - Coverage
            - Invoice
            - Communication
            - Group
            - DocumentReference
            - InvoiceLine
            - PaymentTransaction
            - Referral
            - ReferralDefinition
            - Schedule
            - Slot
            - HealthcareService
            - AllergyIntolerance
            - Condition
            - Immunization
            - Subscription
            - SubscriptionTopic
            - ChargeItemDefinition
            - ServiceRequest
            - Medication
            - MedicationRequest
            - Questionnaire
            - QuestionnaireResponse
            - ValueSet
            - ValueSetConcept
            - Observation
            - Binary
            - Bundle
            - OperationOutcome
            - Parameters
            - List
        multipleOr:
          description: Allow multiple values per parameter (or)
          type: boolean
        multipleAnd:
          description: Allow multiple parameters (and)
          type: boolean
        comparator:
          description: eq | ne | gt | lt | ge | le | sa | eb | ap
          type: array
          items:
            type: string
            enum:
            - eq
            - ne
            - gt
            - lt
            - ge
            - le
            - sa
            - eb
            - ap
        modifier:
          description: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
          type: array
          items:
            type: string
            enum:
            - missing
            - exact
            - contains
            - not
            - text
            - in
            - notIn
            - below
            - above
            - type
            - identifier
            - ofType
            - iterate
        chain:
          description: Chained names supported
          type: array
          items:
            type: string
        text:
          readOnly: true
          description: Text summary of the resource, for human interpretation
          anyOf:
          - $ref: '#/components/schemas/FhirNarrative.jsonfhir'
          - type: 'null'
        contained:
          readOnly: true
          description: Contained, inline Resources
          type: array
          items:
            $ref: '#/components/schemas/FhirResourceInterface.jsonfhir'
        id:
          readOnly: true
          description: Logical id of this artifact
          type:
          - string
          - 'null'
        meta:
          description: Metadata about the resource
          anyOf:
          - $ref: '#/components/schemas/FhirResourceMeta.jsonfhir'
          - type: 'null'
        resourceType:
          description: Resource Type
          type:
          - string
          - 'null'
    FhirResourceMeta:
      type: object
      description: ''
      deprecated: false
      properties:
        lastUpdated:
          readOnly: true
          description: When the resource version last changed
          type:
          - string
          - 'null'
          format: date-time
        profile:
          description: Profiles this resource claims to conform to
          type: array
          items:
            type: string
    FhirResourceInterface:
      type: object
      description: ''
      deprecated: false
    FhirContactPoint.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          description: Type of contact detail
          type:
          - string
          - 'null'
          enum:
          - phone
          - fax
          - email
          - sms
          - null
        value:
          description: The actual phone number or email address
          type:
          - string
          - 'null'
        use:
          description: Purpose of the contact detail
          type:
          - string
          - 'null'
          enum:
          - home
          - work
          - mobile
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCodeableConcept.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        coding:
          description: defined by a terminology system
          type: array
          items:
            $ref: '#/components/schemas/FhirCoding.jsonfhir'
        text:
          description: Plain text representation of the concept
          type:
          - string
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirCoding.jsonfhir:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          format: uri
          description: Identity of the terminology system
          externalDocs:
            url: https://schema.org/url
          type:
          - string
          - 'null'
        code:
          description: Symbol in syntax defined by the system
          type:
          - string
          - 'null'
        display:
          description: Representation defined by the system
          type:
          - string
          - 'null'
        userSelected:
          readOnly: true
          description: If this coding was chosen directly by the user
          type:
          - boolean
          - 'null'
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
    FhirContactPoint:
      type: object
      description: ''
      deprecated: false
      properties:
        system:
          description: Type of contact detail
          type:
          - string
          - 'null'
          enum:
          - phone
          - fax
          - email
          - sms
          - null
        value:
          description: The actual phone number or email address
          type:
          - string
          - 'null'
        use:
          description: Purpose of the contact detail
          type:
          - string
          - 'null'
          enum:
          - home
          - work
          - mobile
          - null
        id:
          readOnly: true
          description: ID of the FHIR element (optional)
          type:
          - string
          - 'null'
  securitySchemes:
    oauth:
      type: oauth2
      description: OAuth 2.0 client credentials Grant
      flows:
        clientCredentials:
          tokenUrl: /main/oauth/token
          scopes: {}
x-provenance:
  method: searched
  source: https://developers.halaxy.com/reference
  harvested: '2026-10-22'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.halaxy.com/reference/api_metadata_get.md
  - https://developers.halaxy.com/reference/createappointment.md
  - https://developers.halaxy.com/reference/createcoverage.md
  - https://developers.halaxy.com/reference/createdocumentreference.md
  - https://developers.halaxy.com/reference/createorganisation.md
  - https://developers.halaxy.com/reference/createpatient.md
  - https://developers.halaxy.com/reference/createpractitioner.md
  - https://developers.halaxy.com/reference/createpractitionerrole.md
  - https://developers.halaxy.com/reference/createreferral.md
  - https://developers.halaxy.com/reference/createschedule.md
  - https://developers.halaxy.com/reference/findavailableappointments.md
  - https://developers.halaxy.com/reference/findchargeitemdefinitions.md
  - https://developers.halaxy.com/reference/findcoverage.md
  - https://developers.halaxy.com/reference/findinvoice.md
  - https://developers.halaxy.com/reference/findinvoiceline.md
  - https://developers.halaxy.com/reference/findorganization.md
  - https://developers.halaxy.com/reference/findpatient.md
  - https://developers.halaxy.com/reference/findpaymenttransaction.md
  - https://developers.halaxy.com/reference/findpractitioner.md
  - https://developers.halaxy.com/reference/findpractitionerrole.md
  - https://developers.halaxy.com/reference/findreferral.md
  - https://developers.halaxy.com/reference/findreferraldefinition.md
  - https://developers.halaxy.com/reference/findschedules.md
  - https://developers.halaxy.com/reference/findsearchparameters.md
  - https://developers.halaxy.com/reference/findslots.md
  - https://developers.halaxy.com/reference/generatescheduleslots.md
  - https://developers.halaxy.com/reference/getappointment.md
  - https://developers.halaxy.com/reference/getchargeitemdefinition.md
  - https://developers.halaxy.com/reference/getcoverage.md
  - https://developers.halaxy.com/reference/gethealthcareservice.md
  - https://developers.halaxy.com/reference/getinvoice.md
  - https://developers.halaxy.com/reference/getinvoiceline.md
  - https://developers.halaxy.com/reference/getorganization.md
  - https://developers.halaxy.com/reference/getpatient.md
  - https://developers.halaxy.com/reference/getpatientids.md
  - https://developers.halaxy.com/reference/getpaymenttransaction.md
  - https://developers.halaxy.com/reference/getpractitioner.md
  - https://developers.halaxy.com/reference/getpractitionerrole.md
  - https://developers.halaxy.com/reference/getreferral.md
  - https://developers.halaxy.com/reference/getreferraldefinition.md
  - https://developers.halaxy.com/reference/getschedule.md
  - https://developers.halaxy.com/reference/getslot.md
  - https://developers.halaxy.com/reference/listappointments.md
  - https://developers.halaxy.com/reference/listhealthcareservice.md
  - https://developers.halaxy.com/reference/patchappointment.md
  - https://developers.halaxy.com/reference/patchcoverage.md
  - https://developers.halaxy.com/reference/patchpatient.md
  - https://developers.halaxy.com/reference/patchreferral.md
  - https://developers.halaxy.com/reference/updatepatient.md
  merge:
    pages: 49
    deduped: 942
    conflicts_kept_first: 0