HAhalaxy
SearchParameter

List Search Parameters

Changed on

Retrieves a collection of search parameters that the server can handle

get/main/SearchParameter

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/SearchParameter
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

Response

SearchParameter collection

urlstring nullable

Canonical identifier for this capability statement, represented as a URI (globally unique)

versionstring

Business version of the search parameter

namestring

Name for this search parameter (computer friendly)

status'draft' | 'active' | 'retired' | 'unknown'

draft | active | retired | unknown

experimentalboolean

For testing purposes, not real usage

datestring date-time

Date last changed

publisherstring

Name of the publisher (organization or individual)

descriptionstring nullable

Natural language description of the search parameter

purposestring

Why this search parameter is defined

codestring

Code used in URL

basestring[]

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

expressionstring

FHIRPath expression that extracts the values

xpathstring

XPath that extracts the values

xpathUsagestring

normal | phonetic | nearby | distance | other

targetstring[]

Types of resource (if a resource reference)

multipleOrboolean

Allow multiple values per parameter (or)

multipleAndboolean

Allow multiple parameters (and)

comparatorstring[]

eq | ne | gt | lt | ge | le | sa | eb | ap

modifierstring[]

missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType

chainstring[]

Chained names supported

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the // response property for the response status (media type: application/json)